Module org.elasticsearch.xcore

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

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

All Superinterfaces:

ChunkedToXContent, EmbeddingResults<E>, InferenceServiceResults, NamedWriteable, Writeable

All Known Implementing Classes:

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

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

Nested Class Summary

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

EmbeddingResults.Chunk, EmbeddingResults.Embedding<E extends EmbeddingResults.Embedding<E>>

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

Method Summary

Modifier and Type	Method	Description
int	getFirstEmbeddingSize()	Returns the first embedding entry in the result list's array size.

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

isFragment, toXContentChunked, toXContentChunkedV8

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

embeddings

Methods inherited from interface org.elasticsearch.inference.InferenceServiceResults

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

Method Details

getFirstEmbeddingSize

int getFirstEmbeddingSize()
                   throws IllegalStateException

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

Returns:

the size of the embedding

Throws:

IllegalStateException - if the list of embeddings is empty