Package co.elastic.clients.elasticsearch.inference

Class VoyageAIServiceSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.VoyageAIServiceSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class VoyageAIServiceSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Integer	dimensions()	The number of dimensions for resulting output embeddings.
final Float	embeddingType()	The data type for the embeddings to be returned.
final String	modelId()	Required - The name of the model to use for the inference task.
static VoyageAIServiceSettings	of(Function<VoyageAIServiceSettings.Builder,ObjectBuilder<VoyageAIServiceSettings>> fn)
final RateLimitSetting	rateLimit()	This setting helps to minimize the number of rate limit errors returned from VoyageAI.
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	setupVoyageAIServiceSettingsDeserializer(ObjectDeserializer<VoyageAIServiceSettings.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<VoyageAIServiceSettings> _DESERIALIZER

Json deserializer for VoyageAIServiceSettings

Method Details

of

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

dimensions

@Nullable
public final Integer dimensions()

The number of dimensions for resulting output embeddings. This setting maps to output_dimension in the VoyageAI documentation. Only for the text_embedding task type.

API name: dimensions

modelId

public final String modelId()

Required - The name of the model to use for the inference task. Refer to the VoyageAI documentation for the list of available text embedding and rerank models.

API name: model_id

rateLimit

@Nullable
public final RateLimitSetting rateLimit()

This setting helps to minimize the number of rate limit errors returned from VoyageAI. The voyageai service sets a default number of requests allowed per minute depending on the task type. For both text_embedding and rerank, it is set to 2000.

API name: rate_limit

embeddingType

@Nullable
public final Float embeddingType()

The data type for the embeddings to be returned. This setting maps to output_dtype in the VoyageAI documentation. Permitted values: float, int8, bit. int8 is a synonym of byte in the VoyageAI documentation. bit is a synonym of binary in the VoyageAI documentation. Only for the text_embedding task type.

API name: embedding_type

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

setupVoyageAIServiceSettingsDeserializer

protected static void setupVoyageAIServiceSettingsDeserializer(ObjectDeserializer<VoyageAIServiceSettings.Builder> op)