Package com.datarobot.impl

Class PredictionClient

java.lang.Object

com.datarobot.impl.PredictionClient

All Implemented Interfaces:

IPredictionClient

public class PredictionClient
extends java.lang.Object
implements IPredictionClient

The PredictionClient object provides access to the prediction endpoints of the DataRobot AI API. This object is not meant to be used directly but through the DataRobotAIClient.predict() method.

Constructor Summary

Constructors

Constructor	Description
PredictionClient(IDataRobotAIClient client)	IPredictionClient based API operations.

Method Summary

Modifier and Type	Method	Description
PredictionList	aiPredict(java.lang.String aiId, java.lang.String target, java.lang.String data)	Retrieve AI predictions against data.
PredictionList	deploymentPredict(Deployment deployment, java.lang.String sourceFile)	Send a prediction request to the specified deployment
Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse>	getHttpMessageTransformer()	internal
void	setHttpMessageTransformer(Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> httpMessageTransformer)	internal
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PredictionClient

public PredictionClient(IDataRobotAIClient client)

IPredictionClient based API operations. Users will not need to instantiate this object directly. It can be accessed through DataRobotAIClient#predict.

Parameters:

client - DataRobotAIClient

Method Detail

getHttpMessageTransformer

public Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> getHttpMessageTransformer()

internal

Specified by:

getHttpMessageTransformer in interface IPredictionClient

setHttpMessageTransformer

public void setHttpMessageTransformer(Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> httpMessageTransformer)

internal

Specified by:

setHttpMessageTransformer in interface IPredictionClient

deploymentPredict

public PredictionList deploymentPredict(Deployment deployment,
                                        java.lang.String sourceFile)
                                 throws ClientException,
                                        java.io.FileNotFoundException

Send a prediction request to the specified deployment

Specified by:

deploymentPredict in interface IPredictionClient

Parameters:

deployment - Who will service the request

sourceFile - The data on which to predict via a filepath on the local system

Returns:

PredictionList

Throws:

ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

java.io.FileNotFoundException - when a file with the specified pathname does not exist, or if the file does exist but is inaccessible for some reason.

aiPredict

public PredictionList aiPredict(java.lang.String aiId,
                                java.lang.String target,
                                java.lang.String data)
                         throws ClientException,
                                java.io.FileNotFoundException

Retrieve AI predictions against data. Note an AI must be trained with AI.learn(java.lang.String, java.lang.String) or an existing learning session must be added to the AI with AI.addLearningSession(com.datarobot.model.LearningSession) or IAIClient.addLearningSession(java.lang.String, java.lang.String, java.lang.String) before predictions can occur.

Specified by:

aiPredict in interface IPredictionClient

Parameters:

aiId - The ID of the AI which to predict on

target - The name of the selected target feature to predict

data - The data on which to predict via a filepath on the local system

Returns:

PredictionList

Throws:

ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

java.io.FileNotFoundException - when a file with the specified pathname does not exist, or if the file does exist but is inaccessible for some reason.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object