Package co.elastic.clients.elasticsearch.ml

Class TextEmbeddingInferenceOptions

java.lang.Object

co.elastic.clients.elasticsearch.ml.TextEmbeddingInferenceOptions

All Implemented Interfaces:

InferenceConfigCreateVariant, JsonpSerializable

@JsonpDeserializable
public class TextEmbeddingInferenceOptions
extends Object
implements InferenceConfigCreateVariant, JsonpSerializable

Text embedding inference options

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextEmbeddingInferenceOptions.Builder	Builder for TextEmbeddingInferenceOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TextEmbeddingInferenceOptions>	_DESERIALIZER	Json deserializer for TextEmbeddingInferenceOptions

Method Summary

Modifier and Type	Method	Description
InferenceConfigCreate.Kind	_inferenceConfigCreateKind()	InferenceConfigCreate variant kind.
static TextEmbeddingInferenceOptions	of(Function<TextEmbeddingInferenceOptions.Builder,ObjectBuilder<TextEmbeddingInferenceOptions>> fn)
final String	resultsField()	The field that is added to incoming documents to contain the inference prediction.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTextEmbeddingInferenceOptionsDeserializer(ObjectDeserializer<TextEmbeddingInferenceOptions.Builder> op)
final TokenizationConfig	tokenization()	The tokenization options
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.ml.InferenceConfigCreateVariant

_toInferenceConfigCreate

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TextEmbeddingInferenceOptions> _DESERIALIZER

Json deserializer for TextEmbeddingInferenceOptions

Method Details

of

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

_inferenceConfigCreateKind

public InferenceConfigCreate.Kind _inferenceConfigCreateKind()

InferenceConfigCreate variant kind.

Specified by:

_inferenceConfigCreateKind in interface InferenceConfigCreateVariant

tokenization

@Nullable
public final TokenizationConfig tokenization()

The tokenization options

API name: tokenization

resultsField

@Nullable
public final String resultsField()

The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.

API name: results_field

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupTextEmbeddingInferenceOptionsDeserializer

protected static void setupTextEmbeddingInferenceOptionsDeserializer(ObjectDeserializer<TextEmbeddingInferenceOptions.Builder> op)