Package com.datarobot

Interface ILearningSessionClient

All Known Implementing Classes:

LearningSessionClient

public interface ILearningSessionClient

The ILearningSessionClient interface provides access to LearningSession related endpoints in the AI API

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()
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)
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.

Method Detail

getHttpMessageTransformer

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

setHttpMessageTransformer

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

get

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

Retrieve a LearningSession by id

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

LearningSessionList list()
                  throws ClientException

Retrieve a list of learning sessions associated with this account

Returns:

LearningSessionList

Throws:

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

list

LearningSessionList list(PagingParams params)
                  throws ClientException

Retrieve a list of learning sessions associated with this account

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

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

Delete a learning session

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

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

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

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 learn(java.lang.String, java.lang.String) instead or call .get() on the return Future<LearningSession>.

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.

getDeployment

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.

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.

getFeatures

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.

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.

getEvaluation

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.

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.