Package co.elastic.clients.elasticsearch.inference

Class EmbeddingContentObjectItem

java.lang.Object

co.elastic.clients.elasticsearch.inference.EmbeddingContentObjectItem

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class EmbeddingContentObjectItem
extends Object
implements JsonpSerializable

An object containing the input data for a single item for the model to embed.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final EmbeddingContentFormat	format()	The format of the input.
static EmbeddingContentObjectItem	of(Function<EmbeddingContentObjectItem.Builder,ObjectBuilder<EmbeddingContentObjectItem>> fn)
EmbeddingContentObjectItem.Builder	rebuild()
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	setupEmbeddingContentObjectItemDeserializer(ObjectDeserializer<EmbeddingContentObjectItem.Builder> op)
String	toString()
final EmbeddingContentType	type()	Required - The type of input to embed.
final String	value()	Required - The value of the input to embed.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<EmbeddingContentObjectItem> _DESERIALIZER

Json deserializer for EmbeddingContentObjectItem

Method Details

of

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

type

public final EmbeddingContentType type()

Required - The type of input to embed. Not all models support all input types. The audio, video, and pdf types are available in Elasticsearch 9.5.0 and later.

API name: type

format

@Nullable
public final EmbeddingContentFormat format()

The format of the input. For the text type this must be text. For all other types, this must be base64. If not specified, this will default to text for the text type and base64 for all other types.

API name: format

value

public final String value()

Required - The value of the input to embed. For images, this must be a base64-encoded data URI, i.e. "data:content/type;base64,..."

API name: value

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

rebuild

public EmbeddingContentObjectItem.Builder rebuild()

Returns:

New EmbeddingContentObjectItem.Builder initialized with field values of this instance

setupEmbeddingContentObjectItemDeserializer

protected static void setupEmbeddingContentObjectItemDeserializer(ObjectDeserializer<EmbeddingContentObjectItem.Builder> op)