Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.vectors

Class TextEmbeddingQueryVectorBuilder

java.lang.Object

org.elasticsearch.xpack.core.ml.vectors.TextEmbeddingQueryVectorBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryVectorBuilder, ToXContent, ToXContentObject

public class TextEmbeddingQueryVectorBuilder
extends Object
implements QueryVectorBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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	MODEL_TEXT
static final String	NAME
static final ConstructingObjectParser<TextEmbeddingQueryVectorBuilder,Void>	PARSER
static final NodeFeature	RETRIEVER_RESULT_DIVERSIFICATION_USES_QUERY_VECTOR_BUILDER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TextEmbeddingQueryVectorBuilder(String modelId, String modelText)
TextEmbeddingQueryVectorBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	buildVector(Client client, ActionListener<float[]> listener)
boolean	equals(Object o)
static TextEmbeddingQueryVectorBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()
String	getModelId()
String	getModelText()
String	getWriteableName()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

RETRIEVER_RESULT_DIVERSIFICATION_USES_QUERY_VECTOR_BUILDER

public static final NodeFeature RETRIEVER_RESULT_DIVERSIFICATION_USES_QUERY_VECTOR_BUILDER

NAME

public static final String NAME

See Also:

• Constant Field Values

MODEL_TEXT

public static final ParseField MODEL_TEXT

PARSER

public static final ConstructingObjectParser<TextEmbeddingQueryVectorBuilder,Void> PARSER

Constructor Details

TextEmbeddingQueryVectorBuilder

public TextEmbeddingQueryVectorBuilder(String modelId,
 String modelText)

TextEmbeddingQueryVectorBuilder

public TextEmbeddingQueryVectorBuilder(StreamInput in)
                                throws IOException

Throws:

IOException

Method Details

fromXContent

public static TextEmbeddingQueryVectorBuilder fromXContent(XContentParser parser)
                                                    throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

buildVector

public void buildVector(Client client,
 ActionListener<float[]> listener)

Specified by:

buildVector in interface QueryVectorBuilder

getModelText

public String getModelText()

getModelId

public String getModelId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object