Package org.opensearch.ml.common.input.nlp

Class TextSimilarityMLInput

java.lang.Object

org.opensearch.ml.common.input.MLInput

org.opensearch.ml.common.input.nlp.TextSimilarityMLInput

All Implemented Interfaces:

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

public class TextSimilarityMLInput
extends MLInput

MLInput which supports a text similarity algorithm Inputs are a query and a list of texts. Outputs are real numbers Use this for Cross Encoder models

Nested Class Summary

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 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, PARAMETERS_FIELD, 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
TextSimilarityMLInput(org.opensearch.core.common.io.stream.StreamInput in)
TextSimilarityMLInput(org.opensearch.core.xcontent.XContentParser parser, FunctionName functionName)
TextSimilarityMLInput(FunctionName algorithm, MLInputDataset dataset)

Method Summary

Modifier and Type	Method	Description
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 org.opensearch.ml.common.input.MLInput

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

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

Constructor Details

TextSimilarityMLInput

public TextSimilarityMLInput(FunctionName algorithm,
 MLInputDataset dataset)

TextSimilarityMLInput

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

Throws:

IOException

TextSimilarityMLInput

public TextSimilarityMLInput(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

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

Overrides:

toXContent in class MLInput

Throws:

IOException