Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Class EmbeddingByteResults

java.lang.Object

org.elasticsearch.xpack.core.inference.results.EmbeddingByteResults

All Implemented Interfaces:

NamedWriteable, Writeable, ChunkedToXContent, InferenceServiceResults, DenseEmbeddingResults<EmbeddingByteResults.Embedding>, EmbeddingResults<EmbeddingByteResults.Embedding>

Direct Known Subclasses:

DenseEmbeddingByteResults, GenericDenseEmbeddingByteResults

public abstract class EmbeddingByteResults
extends Object
implements DenseEmbeddingResults<EmbeddingByteResults.Embedding>

Abstract class from which other dense embedding byte result classes inherit their behaviour

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EmbeddingByteResults.Embedding

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.inference.results.EmbeddingResults

EmbeddingResults.Chunk

Nested classes/interfaces inherited from interface org.elasticsearch.inference.InferenceServiceResults

InferenceServiceResults.Result

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

EMPTY

Fields inherited from interface org.elasticsearch.xpack.core.inference.results.EmbeddingResults

EMBEDDING

Constructor Summary

Constructors

Constructor	Description
EmbeddingByteResults(List<EmbeddingByteResults.Embedding> embeddings, String arrayName)
EmbeddingByteResults(StreamInput in, String arrayName)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
List<EmbeddingByteResults.Embedding>	embeddings()	The resulting list of embeddings for the input texts to the inference service.
boolean	equals(Object o)
int	getFirstEmbeddingSize()	Returns the first embedding entry in the result list's array size.
int	hashCode()
Iterator<? extends org.elasticsearch.xcontent.ToXContent>	toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params params)
List<? extends InferenceResults>	transformToCoordinationFormat()
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.common.xcontent.ChunkedToXContent

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.inference.InferenceServiceResults

getWriteableName, isStreaming, publisher

Constructor Details

EmbeddingByteResults

public EmbeddingByteResults(List<EmbeddingByteResults.Embedding> embeddings,
 String arrayName)

EmbeddingByteResults

public EmbeddingByteResults(StreamInput in,
 String arrayName)
                     throws IOException

Throws:

IOException

Method Details

getFirstEmbeddingSize

public int getFirstEmbeddingSize()

Description copied from interface: DenseEmbeddingResults

Returns the first embedding entry in the result list's array size.

Specified by:

getFirstEmbeddingSize in interface DenseEmbeddingResults<EmbeddingByteResults.Embedding>

Returns:

the size of the embedding

toXContentChunked

public Iterator<? extends org.elasticsearch.xcontent.ToXContent> toXContentChunked(org.elasticsearch.xcontent.ToXContent.Params params)

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface InferenceServiceResults

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface InferenceServiceResults

Specified by:

writeTo in interface Writeable

Throws:

IOException

transformToCoordinationFormat

public List<? extends InferenceResults> transformToCoordinationFormat()

Specified by:

transformToCoordinationFormat in interface InferenceServiceResults

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface InferenceServiceResults

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

embeddings

public List<EmbeddingByteResults.Embedding> embeddings()

Description copied from interface: EmbeddingResults

The resulting list of embeddings for the input texts to the inference service.

Specified by:

embeddings in interface EmbeddingResults<EmbeddingByteResults.Embedding>