Package co.elastic.clients.elasticsearch.inference

Class EmbeddingInferenceResult

java.lang.Object

co.elastic.clients.elasticsearch.inference.EmbeddingInferenceResult

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<EmbeddingInferenceResult.Kind,Object>

@JsonpDeserializable
public class EmbeddingInferenceResult
extends Object
implements TaggedUnion<EmbeddingInferenceResult.Kind,Object>, JsonpSerializable

EmbeddingInferenceResult is an aggregation of mutually exclusive embeddings variants

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbeddingInferenceResult.Builder
static enum	EmbeddingInferenceResult.Kind	EmbeddingInferenceResult variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<EmbeddingInferenceResult>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
EmbeddingInferenceResult(EmbeddingInferenceResultVariant value)

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final EmbeddingInferenceResult.Kind	_kind()	Get the of the kind of variant held by this object.
List<DenseEmbeddingResult>	embeddings()	Get the embeddings variant value.
List<DenseEmbeddingByteResult>	embeddingsBits()	Get the embeddings_bits variant value.
List<DenseEmbeddingByteResult>	embeddingsBytes()	Get the embeddings_bytes variant value.
boolean	isEmbeddings()	Is this variant instance of kind embeddings?
boolean	isEmbeddingsBits()	Is this variant instance of kind embeddings_bits?
boolean	isEmbeddingsBytes()	Is this variant instance of kind embeddings_bytes?
static EmbeddingInferenceResult	of(Function<EmbeddingInferenceResult.Builder,ObjectBuilder<EmbeddingInferenceResult>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupEmbeddingInferenceResultDeserializer(ObjectDeserializer<EmbeddingInferenceResult.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<EmbeddingInferenceResult> _DESERIALIZER

Constructor Details

EmbeddingInferenceResult

public EmbeddingInferenceResult(EmbeddingInferenceResultVariant value)

Method Details

_kind

public final EmbeddingInferenceResult.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<EmbeddingInferenceResult.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<EmbeddingInferenceResult.Kind,Object>

of

public static EmbeddingInferenceResult of(Function<EmbeddingInferenceResult.Builder,ObjectBuilder<EmbeddingInferenceResult>> fn)

isEmbeddingsBytes

public boolean isEmbeddingsBytes()

Is this variant instance of kind embeddings_bytes?

embeddingsBytes

public List<DenseEmbeddingByteResult> embeddingsBytes()

Get the embeddings_bytes variant value.

Throws:

IllegalStateException - if the current variant is not of the embeddings_bytes kind.

isEmbeddingsBits

public boolean isEmbeddingsBits()

Is this variant instance of kind embeddings_bits?

embeddingsBits

public List<DenseEmbeddingByteResult> embeddingsBits()

Get the embeddings_bits variant value.

Throws:

IllegalStateException - if the current variant is not of the embeddings_bits kind.

isEmbeddings

public boolean isEmbeddings()

Is this variant instance of kind embeddings?

embeddings

public List<DenseEmbeddingResult> embeddings()

Get the embeddings variant value.

Throws:

IllegalStateException - if the current variant is not of the embeddings kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupEmbeddingInferenceResultDeserializer

protected static void setupEmbeddingInferenceResultDeserializer(ObjectDeserializer<EmbeddingInferenceResult.Builder> op)