Package org.opensearch.ml.common.input

Class MLInput

java.lang.Object

org.opensearch.ml.common.input.MLInput

All Implemented Interfaces:

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

Direct Known Subclasses:

AgentMLInput, QuestionAnsweringMLInput, RemoteInferenceMLInput, TextDocsMLInput, TextSimilarityMLInput

public class MLInput
extends Object
implements Input

ML input data: algorithm name, parameters and input data set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	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
protected FunctionName	algorithm
static final String	ALGORITHM_FIELD
static final String	CONTEXT_FIELD
static final String	INPUT_DATA_FIELD
static final String	INPUT_INDEX_FIELD
static final String	INPUT_QUERY_FIELD
protected MLInputDataset	inputDataset
static final String	ML_PARAMETERS_FIELD
protected MLAlgoParams	parameters
static final String	PARAMETERS_FIELD
static final String	QUERY_TEXT_FIELD
static final String	QUESTION_FIELD
static final String	RETURN_BYTES_FIELD
static final String	RETURN_NUMBER_FIELD
static final String	TARGET_RESPONSE_FIELD
static final String	TARGET_RESPONSE_POSITIONS_FIELD
static final String	TEXT_DOCS_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MLInput()
MLInput(org.opensearch.core.common.io.stream.StreamInput in)
MLInput(FunctionName algorithm, MLAlgoParams parameters, MLInputDataset inputDataset)
MLInput(FunctionName algorithm, MLAlgoParams parameters, org.opensearch.search.builder.SearchSourceBuilder searchSourceBuilder, List<String> sourceIndices, DataFrame dataFrame, MLInputDataset inputDataset)

Method Summary

Modifier and Type	Method	Description
static MLInput.MLInputBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
FunctionName	getAlgorithm()
FunctionName	getFunctionName()
MLInputDataset	getInputDataset()
MLAlgoParams	getParameters()
int	getVersion()
int	hashCode()
static MLInput	parse(org.opensearch.core.xcontent.XContentParser parser, String inputAlgoName)
void	setAlgorithm(FunctionName algorithm)
void	setInputDataset(MLInputDataset inputDataset)
void	setParameters(MLAlgoParams parameters)
void	setVersion(int version)
MLInput.MLInputBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

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

ALGORITHM_FIELD

public static final String ALGORITHM_FIELD

See Also:

• Constant Field Values

ML_PARAMETERS_FIELD

public static final String ML_PARAMETERS_FIELD

See Also:

• Constant Field Values

INPUT_INDEX_FIELD

public static final String INPUT_INDEX_FIELD

See Also:

• Constant Field Values

INPUT_QUERY_FIELD

public static final String INPUT_QUERY_FIELD

See Also:

• Constant Field Values

INPUT_DATA_FIELD

public static final String INPUT_DATA_FIELD

See Also:

• Constant Field Values

RETURN_BYTES_FIELD

public static final String RETURN_BYTES_FIELD

See Also:

• Constant Field Values

RETURN_NUMBER_FIELD

public static final String RETURN_NUMBER_FIELD

See Also:

• Constant Field Values

TARGET_RESPONSE_FIELD

public static final String TARGET_RESPONSE_FIELD

See Also:

• Constant Field Values

TARGET_RESPONSE_POSITIONS_FIELD

public static final String TARGET_RESPONSE_POSITIONS_FIELD

See Also:

• Constant Field Values

TEXT_DOCS_FIELD

public static final String TEXT_DOCS_FIELD

See Also:

• Constant Field Values

QUERY_TEXT_FIELD

public static final String QUERY_TEXT_FIELD

See Also:

• Constant Field Values

PARAMETERS_FIELD

public static final String PARAMETERS_FIELD

See Also:

• Constant Field Values

QUESTION_FIELD

public static final String QUESTION_FIELD

See Also:

• Constant Field Values

CONTEXT_FIELD

public static final String CONTEXT_FIELD

See Also:

• Constant Field Values

algorithm

protected FunctionName algorithm

parameters

protected MLAlgoParams parameters

inputDataset

protected MLInputDataset inputDataset

Constructor Details

MLInput

public MLInput(FunctionName algorithm,
 MLAlgoParams parameters,
 MLInputDataset inputDataset)

MLInput

public MLInput(FunctionName algorithm,
 MLAlgoParams parameters,
 org.opensearch.search.builder.SearchSourceBuilder searchSourceBuilder,
 List<String> sourceIndices,
 DataFrame dataFrame,
 MLInputDataset inputDataset)

MLInput

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

Throws:

IOException

MLInput

public MLInput()

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

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static MLInput parse(org.opensearch.core.xcontent.XContentParser parser,
 String inputAlgoName)
                     throws IOException

Throws:

IOException

getFunctionName

public FunctionName getFunctionName()

Specified by:

getFunctionName in interface Input

builder

public static MLInput.MLInputBuilder builder()

toBuilder

public MLInput.MLInputBuilder toBuilder()

getAlgorithm

public FunctionName getAlgorithm()

getParameters

public MLAlgoParams getParameters()

getInputDataset

public MLInputDataset getInputDataset()

getVersion

public int getVersion()

setAlgorithm

public void setAlgorithm(FunctionName algorithm)

setParameters

public void setParameters(MLAlgoParams parameters)

setInputDataset

public void setInputDataset(MLInputDataset inputDataset)

setVersion

public void setVersion(int version)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object