Package co.elastic.clients.elasticsearch.inference

Class InferenceResult

java.lang.Object

co.elastic.clients.elasticsearch.inference.InferenceResult

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<InferenceResult.Kind,Object>

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

InferenceResult is an aggregation of mutually exclusive variants

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
InferenceResult(InferenceResultVariant value)

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final InferenceResult.Kind	_kind()	Get the of the kind of variant held by this object.
List<CompletionResult>	completion()	Get the completion variant value.
boolean	isCompletion()	Is this variant instance of kind completion?
boolean	isRerank()	Is this variant instance of kind rerank?
boolean	isSparseEmbedding()	Is this variant instance of kind sparse_embedding?
boolean	isTextEmbedding()	Is this variant instance of kind text_embedding?
boolean	isTextEmbeddingBits()	Is this variant instance of kind text_embedding_bits?
boolean	isTextEmbeddingBytes()	Is this variant instance of kind text_embedding_bytes?
static InferenceResult	of(Function<InferenceResult.Builder,ObjectBuilder<InferenceResult>> fn)
List<RankedDocument>	rerank()	Get the rerank variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferenceResultDeserializer(ObjectDeserializer<InferenceResult.Builder> op)
List<SparseEmbeddingResult>	sparseEmbedding()	Get the sparse_embedding variant value.
List<TextEmbeddingResult>	textEmbedding()	Get the text_embedding variant value.
List<TextEmbeddingByteResult>	textEmbeddingBits()	Get the text_embedding_bits variant value.
List<TextEmbeddingByteResult>	textEmbeddingBytes()	Get the text_embedding_bytes variant value.
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<InferenceResult> _DESERIALIZER

Constructor Details

InferenceResult

public InferenceResult(InferenceResultVariant value)

Method Details

_kind

public final InferenceResult.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<InferenceResult.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<InferenceResult.Kind,Object>

of

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

isTextEmbeddingBytes

public boolean isTextEmbeddingBytes()

Is this variant instance of kind text_embedding_bytes?

textEmbeddingBytes

public List<TextEmbeddingByteResult> textEmbeddingBytes()

Get the text_embedding_bytes variant value.

Throws:

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

isTextEmbeddingBits

public boolean isTextEmbeddingBits()

Is this variant instance of kind text_embedding_bits?

textEmbeddingBits

public List<TextEmbeddingByteResult> textEmbeddingBits()

Get the text_embedding_bits variant value.

Throws:

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

isTextEmbedding

public boolean isTextEmbedding()

Is this variant instance of kind text_embedding?

textEmbedding

public List<TextEmbeddingResult> textEmbedding()

Get the text_embedding variant value.

Throws:

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

isSparseEmbedding

public boolean isSparseEmbedding()

Is this variant instance of kind sparse_embedding?

sparseEmbedding

public List<SparseEmbeddingResult> sparseEmbedding()

Get the sparse_embedding variant value.

Throws:

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

isCompletion

public boolean isCompletion()

Is this variant instance of kind completion?

completion

public List<CompletionResult> completion()

Get the completion variant value.

Throws:

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

isRerank

public boolean isRerank()

Is this variant instance of kind rerank?

rerank

public List<RankedDocument> rerank()

Get the rerank variant value.

Throws:

IllegalStateException - if the current variant is not of the rerank 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

setupInferenceResultDeserializer

protected static void setupInferenceResultDeserializer(ObjectDeserializer<InferenceResult.Builder> op)