Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.action

Class InferenceAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.xpack.core.inference.action.BaseInferenceActionRequest

org.elasticsearch.xpack.core.inference.action.InferenceAction.Request

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

InferenceAction

public static class InferenceAction.Request
extends BaseInferenceActionRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceAction.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 ParseField	INPUT
static final ParseField	INPUT_TYPE
static final EnumSet<TaskType>	SUPPORTED_INFERENCE_ACTION_TASK_TYPES	A set of the TaskType values which can use InferenceAction.
static final ParseField	TASK_SETTINGS
static final ParseField	TIMEOUT

Fields inherited from class org.elasticsearch.xpack.core.inference.action.BaseInferenceActionRequest

INFERENCE_REQUEST_PER_TASK_TIMEOUT_ADDED, OLD_DEFAULT_TIMEOUT, TIMEOUT_NOT_DETERMINED

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)
Request(TaskType taskType, String inferenceEntityId, List<String> input, Map<String,Object> taskSettings, InputType inputType, TimeValue inferenceTimeout, boolean stream)	Constructor that uses an empty InferenceContext
Request(TaskType taskType, String inferenceEntityId, List<String> input, Map<String,Object> taskSettings, InputType inputType, TimeValue inferenceTimeout, boolean stream, InferenceContext context)	Constructor that allows an InferenceContext to be specified

Method Summary

Modifier and Type	Method	Description
static InferenceAction.Request.Builder	builder(String inferenceEntityId, TaskType taskType)
boolean	equals(Object o)
String	getInferenceEntityId()
TimeValue	getInferenceTimeout()
List<String>	getInput()
InputType	getInputType()
Map<String,Object>	getTaskSettings()
TaskType	getTaskType()
int	hashCode()
boolean	isStreaming()
static InferenceAction.Request.Builder	parseRequest(String inferenceEntityId, TaskType taskType, InferenceContext context, XContentParser parser)
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.core.inference.action.BaseInferenceActionRequest

getContext, getDefaultTimeoutForTaskType, resolveTimeoutForTaskType

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

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

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, createTask, getDescription, setParentTask

Field Details

INPUT

public static final ParseField INPUT

INPUT_TYPE

public static final ParseField INPUT_TYPE

TASK_SETTINGS

public static final ParseField TASK_SETTINGS

TIMEOUT

public static final ParseField TIMEOUT

SUPPORTED_INFERENCE_ACTION_TASK_TYPES

public static final EnumSet<TaskType> SUPPORTED_INFERENCE_ACTION_TASK_TYPES

A set of the TaskType values which can use InferenceAction. For TaskType not included here, please use UnifiedCompletionAction, EmbeddingAction or RerankAction as appropriate

Constructor Details

Request

public Request(TaskType taskType,
 String inferenceEntityId,
 List<String> input,
 Map<String,Object> taskSettings,
 InputType inputType,
 @Nullable
 TimeValue inferenceTimeout,
 boolean stream)

Constructor that uses an empty InferenceContext

Parameters:

taskType - the TaskType of the inference request. May be TaskType.ANY, which will result in the task type being determined after parsing the stored model

inferenceEntityId - the endpoint ID

input - the inputs to use for the inference request

taskSettings - the task settings to use for the inference request

inputType - the InputType of the request

inferenceTimeout - the timeout to use. If null, a placeholder timeout will be used until the appropriate timeout for the task type and input type can be determined by the inference service implementation

stream - whether the request should use streaming

Request

public Request(TaskType taskType,
 String inferenceEntityId,
 List<String> input,
 Map<String,Object> taskSettings,
 InputType inputType,
 @Nullable
 TimeValue inferenceTimeout,
 boolean stream,
 InferenceContext context)

Constructor that allows an InferenceContext to be specified

Parameters:

taskType - the TaskType of the inference request. May be TaskType.ANY, which will result in the task type being determined after parsing the stored model

inferenceEntityId - the endpoint ID

input - the inputs to use for the inference request

taskSettings - the task settings to use for the inference request

inputType - the InputType of the request

inferenceTimeout - the timeout to use. If null, a placeholder timeout will be used until the appropriate timeout for the task type and input type can be determined by the inference service implementation

stream - whether the request should use streaming

context - the InferenceContext to use, if null then an empty context will be used

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

builder

public static InferenceAction.Request.Builder builder(String inferenceEntityId,
 TaskType taskType)

parseRequest

public static InferenceAction.Request.Builder parseRequest(String inferenceEntityId,
 TaskType taskType,
 InferenceContext context,
 XContentParser parser)
                                                    throws IOException

Throws:

IOException

getTaskType

public TaskType getTaskType()

Specified by:

getTaskType in class BaseInferenceActionRequest

getInferenceEntityId

public String getInferenceEntityId()

Specified by:

getInferenceEntityId in class BaseInferenceActionRequest

getInput

public List<String> getInput()

getTaskSettings

public Map<String,Object> getTaskSettings()

getInputType

public InputType getInputType()

getInferenceTimeout

public TimeValue getInferenceTimeout()

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in class BaseInferenceActionRequest

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 BaseInferenceActionRequest

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class BaseInferenceActionRequest

hashCode

public int hashCode()

Overrides:

hashCode in class BaseInferenceActionRequest

toString

public String toString()

Overrides:

toString in class AbstractTransportRequest