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

Class AIPredictionAPI

java.lang.Object

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

overit.geocallapp.wfm.ai.rs.v1.prediction.AIPredictionAPI

public class AIPredictionAPI
extends AIApi

API for prediction 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
AIPredictionAPI()

Method Summary

Modifier and Type	Method	Description
void	deleteJob(AWSRequestHeaders headers, String predictionJobId)	Method that delete a prediction execution.
SagemakerResponse	getJob(AWSRequestHeaders headers, String predictionJobId)	Method that get the result of a prediction job id.
List<SagemakerJobStatus>	getJobs(AWSRequestHeaders headers)	Method that gets all the prediction jobs ran in SageMaker given a set of headers composed by: customerId, userId, environment, appName, appVersion
SagemakerJobStatus	startJob(AWSRequestHeaders headers, RequestJobParams params, Object body)	Method that starts a prediction job.
SagemakerResponse	startPredictionJobSync(AWSRequestHeaders headers, RequestJobParams params, String body)	Method that starts a prediction 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

AIPredictionAPI

public AIPredictionAPI()

Method Details

getJobs

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

Method that gets all the prediction jobs ran in SageMaker given a set of headers composed by: customerId, userId, environment, appName, appVersion

Specified by:

getJobs in class AIApi

Parameters:

headers -

Returns:

Throws:

DAValidateException

DAException

getJob

public SagemakerResponse getJob(AWSRequestHeaders headers,
 String predictionJobId)
                         throws DAValidateException,
DAException,
IOException

Method that get the result of a prediction job id.

Specified by:

getJob in class AIApi

Parameters:

headers -

predictionJobId - the id returned by startPredictionJob()

Returns:

SagemakerResponse, it's composed by the status and the content if it's COMPLETED.

Throws:

DAValidateException

DAException

IOException

startJob

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

Method that starts a prediction job.

Specified by:

startJob in class AIApi

Parameters:

headers -

params -

body -

Returns:

Throws:

DAValidateException

DAException

startPredictionJobSync

public SagemakerResponse startPredictionJobSync(AWSRequestHeaders headers,
 RequestJobParams params,
 String body)
                                         throws DAValidateException,
DAException

Method that starts a prediction job.

Parameters:

headers -

params -

body -

Returns:

Throws:

DAValidateException

DAException

deleteJob

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

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

Specified by:

deleteJob in class AIApi

Parameters:

headers -

predictionJobId -

Throws:

DAValidateException

DAException