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

Class RequestJobParams

java.lang.Object

overit.geocallapp.wfm.ai.rs.v1.RequestJobParams

public class RequestJobParams
extends Object

Class containing all the possibile params for AI Api.

Since:

13.0

Field Summary

Fields

Modifier and Type	Field	Description
protected String	algorithm
protected String	file
protected String	indexId
protected String	instanceType
protected boolean	isRelevant
protected String	language
protected String	model
protected String	queryId
protected Boolean	resetModel
protected String	resultId
protected boolean	sync
protected long	timeout
protected String	tuneHyperparameters

Constructor Summary

Constructors

Constructor	Description
RequestJobParams(String algorithm, String model, String file, String instanceType, Boolean resetModel, long timeout, String tuneHyperparameters, boolean sync, String queryId, String indexId, String resultId, boolean isRelevant, String language)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	buildValues()
String	getAlgorithm()	Algorithm to use Example : duration_1.0
String	getFile()	S3 uri to the file used for training
String	getIndexId()
String	getInstanceType()	Instance-type to run on.
String	getLanguage()
String	getModel()	Resulting model name Example : model_duration_1_0
String	getQueryId()
Boolean	getResetModel()	if true the model will be trained from scratch, otherwise an incremental training will be performed default: false
String	getResultId()
long	getTimeout()	Timeout to apply to the task.It can't be greater than the global one,this is only to limit it.
String	getTuneHyperparameters()	if true the hyperparameters will be tuned
boolean	isRelevant()
boolean	isSync()	If True the prediction is synchronous, if False the prediction is asynchronous

Methods inherited from class java.lang.Object

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

Field Details

algorithm

protected String algorithm

model

protected String model

file

protected String file

instanceType

protected String instanceType

resetModel

protected Boolean resetModel

timeout

protected long timeout

tuneHyperparameters

protected String tuneHyperparameters

sync

protected boolean sync

queryId

protected String queryId

indexId

protected String indexId

resultId

protected String resultId

isRelevant

protected boolean isRelevant

language

protected String language

Constructor Details

RequestJobParams

public RequestJobParams(String algorithm,
 String model,
 String file,
 String instanceType,
 Boolean resetModel,
 long timeout,
 String tuneHyperparameters,
 boolean sync,
 String queryId,
 String indexId,
 String resultId,
 boolean isRelevant,
 String language)

Method Details

isSync

public boolean isSync()

If True the prediction is synchronous, if False the prediction is asynchronous

getAlgorithm

public String getAlgorithm()

Algorithm to use Example : duration_1.0

Returns:

getModel

public String getModel()

Resulting model name Example : model_duration_1_0

Returns:

getFile

public String getFile()

S3 uri to the file used for training

Returns:

getInstanceType

public String getInstanceType()

Instance-type to run on.

Returns:

getResetModel

public Boolean getResetModel()

if true the model will be trained from scratch, otherwise an incremental training will be performed default: false

Returns:

getTimeout

public long getTimeout()

Timeout to apply to the task.It can't be greater than the global one,this is only to limit it.

Returns:

getTuneHyperparameters

public String getTuneHyperparameters()

if true the hyperparameters will be tuned

Returns:

getQueryId

public String getQueryId()

getIndexId

public String getIndexId()

getResultId

public String getResultId()

isRelevant

public boolean isRelevant()

getLanguage

public String getLanguage()

buildValues

public Map<String,String> buildValues()