Package org.opensearch.ml.common.input.execute.agent

Class AgentMLInput

java.lang.Object

org.opensearch.ml.common.input.MLInput

org.opensearch.ml.common.input.execute.agent.AgentMLInput

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, Input

public class AgentMLInput
extends MLInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AgentMLInput.AgentMLInputBuilder

Nested classes/interfaces inherited from class org.opensearch.ml.common.input.MLInput

MLInput.MLInputBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGENT_ID_FIELD
static final String	PARAMETERS_FIELD

Fields inherited from class org.opensearch.ml.common.input.MLInput

algorithm, ALGORITHM_FIELD, CONTEXT_FIELD, INPUT_DATA_FIELD, INPUT_INDEX_FIELD, INPUT_QUERY_FIELD, inputDataset, ML_PARAMETERS_FIELD, parameters, QUERY_TEXT_FIELD, QUESTION_FIELD, RETURN_BYTES_FIELD, RETURN_NUMBER_FIELD, TARGET_RESPONSE_FIELD, TARGET_RESPONSE_POSITIONS_FIELD, TEXT_DOCS_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AgentMLInput(String agentId, FunctionName functionName, MLInputDataset inputDataset)
AgentMLInput(org.opensearch.core.common.io.stream.StreamInput in)
AgentMLInput(org.opensearch.core.xcontent.XContentParser parser, FunctionName functionName)

Method Summary

Modifier and Type	Method	Description
static AgentMLInput.AgentMLInputBuilder	AgentMLInputBuilder()
String	getAgentId()
void	setAgentId(String agentId)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.ml.common.input.MLInput

builder, canEqual, equals, getAlgorithm, getFunctionName, getInputDataset, getParameters, getVersion, hashCode, parse, setAlgorithm, setInputDataset, setParameters, setVersion, toBuilder, toString, toXContent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

AGENT_ID_FIELD

public static final String AGENT_ID_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

Constructor Details

AgentMLInput

public AgentMLInput(String agentId,
 FunctionName functionName,
 MLInputDataset inputDataset)

AgentMLInput

public AgentMLInput(org.opensearch.core.common.io.stream.StreamInput in)
             throws IOException

Throws:

IOException

AgentMLInput

public AgentMLInput(org.opensearch.core.xcontent.XContentParser parser,
 FunctionName functionName)
             throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class MLInput

Throws:

IOException

AgentMLInputBuilder

public static AgentMLInput.AgentMLInputBuilder AgentMLInputBuilder()

getAgentId

public String getAgentId()

setAgentId

public void setAgentId(String agentId)