Package com.datarobot.impl

Class LearningSessionClient

java.lang.Object

com.datarobot.impl.LearningSessionClient

All Implemented Interfaces:

ILearningSessionClient, IDoGetCallback<LearningSession>

public class LearningSessionClient
extends java.lang.Object
implements ILearningSessionClient, IDoGetCallback<LearningSession>

The LearningSessionClient object provides access to the learning endpoints of the DataRobot AI API. This object is not meant to be used directly but through the IDataRobotAIClient#learning() method.

Constructor Summary

Constructors

Constructor	Description
LearningSessionClient(IDataRobotAIClient client)	ILearningSessionClient based API operations.

Method Summary

Modifier and Type	Method	Description
void	delete(java.lang.String id)	Delete a learning session
LearningSession	get(java.lang.String id)	Retrieve a LearningSession by id
Deployment	getDeployment(java.lang.String learningSessionId)	Get the deployment associated with this learning session.
Evaluation	getEvaluation(java.lang.String learningSessionId)	Get performance information for the given learning session.
LearningSessionFeatures	getFeatures(java.lang.String learningSessionId)	Retrieve features association with a LearningSession.
Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse>	getHttpMessageTransformer()	internal
StatusTask<LearningSession>	learn(java.lang.String datasetId, java.lang.String target)	Create a learning session and wait for it to be able to predict
LearningSessionList	list()	Retrieve a list of learning sessions associated with this account
LearningSessionList	list(PagingParams params)	Retrieve a list of learning sessions associated with this account
void	setHttpMessageTransformer(Action<com.google.api.client.http.HttpRequest,com.google.api.client.http.HttpResponse> httpMessageTransformer)	internal
java.util.concurrent.Future<LearningSession>	startLearn(java.lang.String datasetId, java.lang.String target)	Set up a learning session without waiting for it to be ready.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LearningSessionClient

public LearningSessionClient(IDataRobotAIClient client)

ILearningSessionClient based API operations. Users will not need to instantiate this object directly. It can be accessed through DataRobotAIClient.learning().

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 ILearningSessionClient

setHttpMessageTransformer

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

internal

Specified by:

setHttpMessageTransformer in interface ILearningSessionClient

get

public LearningSession get(java.lang.String id)
                    throws ClientException

Retrieve a LearningSession by id

Specified by:

get in interface IDoGetCallback<LearningSession>

Specified by:

get in interface ILearningSessionClient

Parameters:

id - The ID of the learning session to retrieve

Returns:

The queried LearningSession

Throws:

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

list

public LearningSessionList list()
                         throws ClientException

Retrieve a list of learning sessions associated with this account

Specified by:

list in interface ILearningSessionClient

Returns:

LearningSessionList

Throws:

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

list

public LearningSessionList list(PagingParams params)
                         throws ClientException

Retrieve a list of learning sessions associated with this account

Specified by:

list in interface ILearningSessionClient

Parameters:

params - The PagingParams object for this list

Returns:

LearningSessionList

Throws:

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

delete

public void delete(java.lang.String id)
            throws ClientException

Delete a learning session

Specified by:

delete in interface ILearningSessionClient

Parameters:

id - The ID of the learning session to delete

Throws:

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

learn

public StatusTask<LearningSession> learn(java.lang.String datasetId,
                                         java.lang.String target)
                                  throws ClientException

Create a learning session and wait for it to be able to predict

Specified by:

learn in interface ILearningSessionClient

Parameters:

datasetId - The ID of the dataset to learn on

target - The name of the feature from the dataset to learn how to predict

Returns:

The new LearningSession

Throws:

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

startLearn

public java.util.concurrent.Future<LearningSession> startLearn(java.lang.String datasetId,
                                                               java.lang.String target)
                                                        throws ClientException

Set up a learning session without waiting for it to be ready. To block until this process finishes, use ILearningSessionClient.learn(java.lang.String, java.lang.String) instead or call .get() on the return Future<LearningSession>.

Specified by:

startLearn in interface ILearningSessionClient

Parameters:

datasetId - The ID of the dataset to learn on

target - The name of the feature from the dataset to learn how to predict

Returns:

The new FutureLearningSession

Throws:

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

getFeatures

public LearningSessionFeatures getFeatures(java.lang.String learningSessionId)
                                    throws ClientException

Retrieve features association with a LearningSession. Values for these features must be provided when making a prediction.

Specified by:

getFeatures in interface ILearningSessionClient

Parameters:

learningSessionId - The ID of the learning session

Returns:

LearningSessionFeatures

Throws:

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

getDeployment

public Deployment getDeployment(java.lang.String learningSessionId)
                         throws ClientException

Get the deployment associated with this learning session. The resulting deployment can be used to predict via IPredictionClient.deploymentPredict(com.datarobot.model.Deployment, java.lang.String) although LearningSession.predict(java.lang.String) can also be called directly on the LearningSession object.

Specified by:

getDeployment in interface ILearningSessionClient

Parameters:

learningSessionId - The ID of the learning session

Returns:

Deployment

Throws:

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

getEvaluation

public Evaluation getEvaluation(java.lang.String learningSessionId)
                         throws ClientException

Get performance information for the given learning session. For details on how to interpret this information see the learning session documentation.

Specified by:

getEvaluation in interface ILearningSessionClient

Parameters:

learningSessionId - The ID of the learning session

Returns:

Evaluation

Throws:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object