Package overit.geocallapp.wfm.ai.rs.v1.training

Class AITrainingApi

java.lang.Object

overit.geocallapp.wfm.ai.rs.v1.AIApi

overit.geocallapp.wfm.ai.rs.v1.training.AITrainingApi

public class AITrainingApi
extends AIApi

API for training processes.

Since:

13.0

Field Summary

Fields inherited from class overit.geocallapp.wfm.ai.rs.v1.AIApi

AWS_SERVICE_NAME, mapper, sdf

Constructor Summary

Constructors

Constructor	Description
AITrainingApi()

Method Summary

Modifier and Type	Method	Description
void	deleteJob(AWSRequestHeaders headers, String trainingJobId)	Method that delete a training execution.
TrainingJobInfo	getJob(AWSRequestHeaders headers, String trainingJobId)	Method that get the result of a training job id.
List<SagemakerJobStatus>	getJobs(AWSRequestHeaders headers)	Method that gets all the training jobs for a client.
SagemakerJobStatus	startJob(AWSRequestHeaders headers, RequestJobParams params, Object body)	Method that starts a training job.

Methods inherited from class overit.geocallapp.wfm.ai.rs.v1.AIApi

buildUriForSpringClient, getAIRestClientBuilder, getDomain, getEncodedUrl, getMultiHeaders, getMultiParams, getPath, getScheme, manageFileResult

Methods inherited from class java.lang.Object

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

Constructor Details

AITrainingApi

public AITrainingApi()

Method Details

getJobs

public List<SagemakerJobStatus> getJobs(AWSRequestHeaders headers)
                                 throws DAValidateException,
DAException

Method that gets all the training jobs for a client.

Specified by:

getJobs in class AIApi

Parameters:

headers -

Returns:

Throws:

DAValidateException

DAException

getJob

public TrainingJobInfo getJob(AWSRequestHeaders headers,
 String trainingJobId)
                       throws DAValidateException,
DAException

Method that get the result of a training job id. The response has some info about the training job id and its status.

Specified by:

getJob in class AIApi

Parameters:

headers -

trainingJobId -

Returns:

Throws:

DAValidateException

DAException

startJob

public SagemakerJobStatus startJob(AWSRequestHeaders headers,
 RequestJobParams params,
 Object body)
                            throws DAValidateException,
DAException

Method that starts a training job.

Specified by:

startJob in class AIApi

Parameters:

headers -

params -

body -

Returns:

Throws:

DAValidateException

DAException

deleteJob

public void deleteJob(AWSRequestHeaders headers,
 String trainingJobId)
               throws DAValidateException,
DAException

Method that delete a training execution. It doesn't return anything, it obly gives error if occurred.

Specified by:

deleteJob in class AIApi

Parameters:

headers -

trainingJobId -

Throws:

DAValidateException

DAException