Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.action

Class InferModelAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.ml.action.InferModelAction.Request

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

InferModelAction

public static class InferModelAction.Request
extends UntypedActionRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferModelAction.Request.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final TimeValue	DEFAULT_TIMEOUT_FOR_API
static final TimeValue	DEFAULT_TIMEOUT_FOR_INGEST	Ingest processors wait for an available inference slot.
static final ParseField	DEPLOYMENT_ID
static final ParseField	DOCS
static final ParseField	ID
static final ParseField	INFERENCE_CONFIG
static final ParseField	TIMEOUT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)
boolean	equals(Object o)
static InferModelAction.Request	forIngestDocs(String id, List<Map<String,Object>> docs, InferenceConfigUpdate update, boolean previouslyLicensed, TimeValue inferenceTimeout)	Build a request from a list of documents as maps.
static InferModelAction.Request	forTextInput(String id, InferenceConfigUpdate update, List<String> textInput, boolean previouslyLicensed, TimeValue inferenceTimeout)	Build a request from a list of strings, each string is one evaluation of the model.
String	getId()
TimeValue	getInferenceTimeout()
List<Map<String,Object>>	getObjectsToInfer()
TrainedModelPrefixStrings.PrefixType	getPrefixType()
List<String>	getTextInput()
InferenceConfigUpdate	getUpdate()
int	hashCode()
boolean	isChunked()
boolean	isHighPriority()
boolean	isPreviouslyLicensed()
int	numberOfDocuments()
static InferModelAction.Request.Builder	parseRequest(String id, XContentParser parser)
void	setChunked(boolean chunked)
void	setHighPriority(boolean highPriority)
void	setPrefixType(TrainedModelPrefixStrings.PrefixType prefixType)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

ID

public static final ParseField ID

DEPLOYMENT_ID

public static final ParseField DEPLOYMENT_ID

DOCS

public static final ParseField DOCS

TIMEOUT

public static final ParseField TIMEOUT

INFERENCE_CONFIG

public static final ParseField INFERENCE_CONFIG

DEFAULT_TIMEOUT_FOR_API

public static final TimeValue DEFAULT_TIMEOUT_FOR_API

DEFAULT_TIMEOUT_FOR_INGEST

public static final TimeValue DEFAULT_TIMEOUT_FOR_INGEST

Ingest processors wait for an available inference slot. Two hours is intentionally generous to avoid spurious timeouts under load, while preventing indefinite hangs caused by inference errors that require node restart to recover.

Constructor Details

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

parseRequest

public static InferModelAction.Request.Builder parseRequest(String id,
 XContentParser parser)

forIngestDocs

public static InferModelAction.Request forIngestDocs(String id,
 List<Map<String,Object>> docs,
 InferenceConfigUpdate update,
 boolean previouslyLicensed,
 TimeValue inferenceTimeout)

Build a request from a list of documents as maps.

Parameters:

id - The model Id

docs - List of document maps

update - Inference config update

previouslyLicensed - License has been checked previously and can now be skipped

inferenceTimeout - The inference timeout (how long the request waits in the inference queue for)

Returns:

the new Request

forTextInput

public static InferModelAction.Request forTextInput(String id,
 InferenceConfigUpdate update,
 List<String> textInput,
 boolean previouslyLicensed,
 TimeValue inferenceTimeout)

Build a request from a list of strings, each string is one evaluation of the model.

Parameters:

id - The model Id

update - Inference config update

textInput - Inference input

previouslyLicensed - License has been checked previously and can now be skipped

inferenceTimeout - The inference timeout (how long the request waits in the inference queue for)

Returns:

the new Request

numberOfDocuments

public int numberOfDocuments()

getId

public String getId()

getObjectsToInfer

public List<Map<String,Object>> getObjectsToInfer()

getTextInput

public List<String> getTextInput()

getUpdate

public InferenceConfigUpdate getUpdate()

isPreviouslyLicensed

public boolean isPreviouslyLicensed()

getInferenceTimeout

public TimeValue getInferenceTimeout()

isHighPriority

public boolean isHighPriority()

setHighPriority

public void setHighPriority(boolean highPriority)

setPrefixType

public void setPrefixType(TrainedModelPrefixStrings.PrefixType prefixType)

getPrefixType

public TrainedModelPrefixStrings.PrefixType getPrefixType()

setChunked

public void setChunked(boolean chunked)

isChunked

public boolean isChunked()

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

hashCode

public int hashCode()

Overrides:

hashCode in class Object