Package co.elastic.clients.elasticsearch.inference

Class VoyageAIServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<VoyageAIServiceSettings.Builder>

co.elastic.clients.elasticsearch.inference.VoyageAIServiceSettings.Builder

All Implemented Interfaces:

WithJson<VoyageAIServiceSettings.Builder>, ObjectBuilder<VoyageAIServiceSettings>

Enclosing class:

VoyageAIServiceSettings

public static class VoyageAIServiceSettings.Builder
extends WithJsonObjectBuilderBase<VoyageAIServiceSettings.Builder>
implements ObjectBuilder<VoyageAIServiceSettings>

Builder for VoyageAIServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VoyageAIServiceSettings	build()	Builds a VoyageAIServiceSettings.
final VoyageAIServiceSettings.Builder	dimensions(Integer value)	The number of dimensions for resulting output embeddings.
final VoyageAIServiceSettings.Builder	embeddingType(Float value)	The data type for the embeddings to be returned.
final VoyageAIServiceSettings.Builder	modelId(String value)	Required - The name of the model to use for the inference task.
final VoyageAIServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from VoyageAI.
final VoyageAIServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from VoyageAI.
protected VoyageAIServiceSettings.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dimensions

public final VoyageAIServiceSettings.Builder dimensions(@Nullable
 Integer value)

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 VoyageAIServiceSettings.Builder modelId(String value)

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

public final VoyageAIServiceSettings.Builder rateLimit(@Nullable
 RateLimitSetting value)

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

rateLimit

public final VoyageAIServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)

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

public final VoyageAIServiceSettings.Builder embeddingType(@Nullable
 Float value)

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

self

protected VoyageAIServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<VoyageAIServiceSettings.Builder>

build

public VoyageAIServiceSettings build()

Builds a VoyageAIServiceSettings.

Specified by:

build in interface ObjectBuilder<VoyageAIServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.