Module org.elasticsearch.xcore

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

Interface EmbeddingResults<E extends EmbeddingResults.Embedding<E>>

All Superinterfaces:

ChunkedToXContent, InferenceServiceResults, NamedWriteable, Writeable

All Known Subinterfaces:

DenseEmbeddingResults<E>

All Known Implementing Classes:

DenseEmbeddingBitResults, DenseEmbeddingByteResults, DenseEmbeddingFloatResults, EmbeddingBitResults, EmbeddingByteResults, EmbeddingFloatResults, GenericDenseEmbeddingBitResults, GenericDenseEmbeddingByteResults, GenericDenseEmbeddingFloatResults, SparseEmbeddingResults

public interface EmbeddingResults<E extends EmbeddingResults.Embedding<E>>
extends InferenceServiceResults

The results of a call to the inference service that contains embeddings (sparse or dense). A call to the inference service may contain multiple input texts, so this results may contain multiple results.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	EmbeddingResults.Chunk	A resulting embedding together with the offset into the input text.
static interface	EmbeddingResults.Embedding<E extends EmbeddingResults.Embedding<E>>	A resulting embedding for one of the input texts to the inference service.

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

Modifier and Type	Field	Description
static final String	EMBEDDING

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

EMPTY

Method Summary

Modifier and Type	Method	Description
List<E>	embeddings()	The resulting list of embeddings for the input texts to the inference service.

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

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.inference.InferenceServiceResults

asMap, getWriteableName, isStreaming, publisher, toXContentChunked, transformToCoordinationFormat, writeTo

Field Details

EMBEDDING

static final String EMBEDDING

See Also:

• Constant Field Values

Method Details

embeddings

List<E> embeddings()

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