Package org.opensearch.ml.common.dataset

Class AsymmetricTextEmbeddingParameters

java.lang.Object

org.opensearch.ml.common.dataset.AsymmetricTextEmbeddingParameters

All Implemented Interfaces:

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

public class AsymmetricTextEmbeddingParameters
extends Object
implements MLAlgoParams

This class defines the modes of operation of an asymmetric text embedding model. Asymmetric embedding models treat the input text differently, depending on whether it is a passage or a query. One example asymmetric model, that requires different prefixes is e5 (cf. https://arxiv.org/pdf/2212.03533.pdf).

Use this parameter only if the model is asymmetric and has been registered with the corresponding `query_prefix` and `passage_prefix` configuration parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AsymmetricTextEmbeddingParameters.AsymmetricTextEmbeddingParametersBuilder
static enum	AsymmetricTextEmbeddingParameters.EmbeddingContentType

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	EMBEDDING_CONTENT_TYPE_FIELD
static final String	PARSE_FIELD_NAME
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
AsymmetricTextEmbeddingParameters(org.opensearch.core.common.io.stream.StreamInput in)
AsymmetricTextEmbeddingParameters(AsymmetricTextEmbeddingParameters.EmbeddingContentType embeddingContentType)

Method Summary

Modifier and Type	Method	Description
static AsymmetricTextEmbeddingParameters.AsymmetricTextEmbeddingParametersBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AsymmetricTextEmbeddingParameters.EmbeddingContentType	getEmbeddingContentType()
int	getVersion()
String	getWriteableName()
int	hashCode()
static MLAlgoParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setEmbeddingContentType(AsymmetricTextEmbeddingParameters.EmbeddingContentType embeddingContentType)
AsymmetricTextEmbeddingParameters.AsymmetricTextEmbeddingParametersBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder xContentBuilder, 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

PARSE_FIELD_NAME

public static final String PARSE_FIELD_NAME

XCONTENT_REGISTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY

EMBEDDING_CONTENT_TYPE_FIELD

public static final String EMBEDDING_CONTENT_TYPE_FIELD

See Also:

• Constant Field Values

Constructor Details

AsymmetricTextEmbeddingParameters

public AsymmetricTextEmbeddingParameters(AsymmetricTextEmbeddingParameters.EmbeddingContentType embeddingContentType)

AsymmetricTextEmbeddingParameters

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

Throws:

IOException

Method Details

parse

public static MLAlgoParams parse(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

getVersion

public int getVersion()

Specified by:

getVersion in interface MLAlgoParams

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

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 xContentBuilder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

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

Throws:

IOException

getEmbeddingContentType

public AsymmetricTextEmbeddingParameters.EmbeddingContentType getEmbeddingContentType()

builder

public static AsymmetricTextEmbeddingParameters.AsymmetricTextEmbeddingParametersBuilder builder()

toBuilder

public AsymmetricTextEmbeddingParameters.AsymmetricTextEmbeddingParametersBuilder toBuilder()

setEmbeddingContentType

public void setEmbeddingContentType(AsymmetricTextEmbeddingParameters.EmbeddingContentType embeddingContentType)

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