Package co.elastic.clients.elasticsearch.inference

Class PutVoyageaiRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutVoyageaiRequest.Builder>

co.elastic.clients.elasticsearch.inference.PutVoyageaiRequest.Builder

All Implemented Interfaces:

WithJson<PutVoyageaiRequest.Builder>, ObjectBuilder<PutVoyageaiRequest>

Enclosing class:

PutVoyageaiRequest

public static class PutVoyageaiRequest.Builder
extends RequestBase.AbstractBuilder<PutVoyageaiRequest.Builder>
implements ObjectBuilder<PutVoyageaiRequest>

Builder for PutVoyageaiRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutVoyageaiRequest	build()	Builds a PutVoyageaiRequest.
final PutVoyageaiRequest.Builder	chunkingSettings(InferenceChunkingSettings value)	The chunking configuration object.
final PutVoyageaiRequest.Builder	chunkingSettings(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)	The chunking configuration object.
protected PutVoyageaiRequest.Builder	self()
final PutVoyageaiRequest.Builder	service(VoyageAIServiceType value)	Required - The type of service supported for the specified task type.
final PutVoyageaiRequest.Builder	serviceSettings(VoyageAIServiceSettings value)	Required - Settings used to install the inference model.
final PutVoyageaiRequest.Builder	serviceSettings(Function<VoyageAIServiceSettings.Builder,ObjectBuilder<VoyageAIServiceSettings>> fn)	Required - Settings used to install the inference model.
final PutVoyageaiRequest.Builder	taskSettings(VoyageAITaskSettings value)	Settings to configure the inference task.
final PutVoyageaiRequest.Builder	taskSettings(Function<VoyageAITaskSettings.Builder,ObjectBuilder<VoyageAITaskSettings>> fn)	Settings to configure the inference task.
final PutVoyageaiRequest.Builder	taskType(VoyageAITaskType value)	Required - The type of the inference task that the model will perform.
final PutVoyageaiRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference endpoint to be created.
final PutVoyageaiRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies the amount of time to wait for the inference endpoint to be created.
final PutVoyageaiRequest.Builder	voyageaiInferenceId(String value)	Required - The unique identifier of the inference endpoint.

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

chunkingSettings

public final PutVoyageaiRequest.Builder chunkingSettings(@Nullable
 InferenceChunkingSettings value)

The chunking configuration object.

API name: chunking_settings

chunkingSettings

public final PutVoyageaiRequest.Builder chunkingSettings(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)

The chunking configuration object.

API name: chunking_settings

service

public final PutVoyageaiRequest.Builder service(VoyageAIServiceType value)

Required - The type of service supported for the specified task type. In this case, voyageai.

API name: service

serviceSettings

public final PutVoyageaiRequest.Builder serviceSettings(VoyageAIServiceSettings value)

Required - Settings used to install the inference model. These settings are specific to the voyageai service.

API name: service_settings

serviceSettings

public final PutVoyageaiRequest.Builder serviceSettings(Function<VoyageAIServiceSettings.Builder,ObjectBuilder<VoyageAIServiceSettings>> fn)

Required - Settings used to install the inference model. These settings are specific to the voyageai service.

API name: service_settings

taskSettings

public final PutVoyageaiRequest.Builder taskSettings(@Nullable
 VoyageAITaskSettings value)

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskSettings

public final PutVoyageaiRequest.Builder taskSettings(Function<VoyageAITaskSettings.Builder,ObjectBuilder<VoyageAITaskSettings>> fn)

Settings to configure the inference task. These settings are specific to the task type you specified.

API name: task_settings

taskType

public final PutVoyageaiRequest.Builder taskType(VoyageAITaskType value)

Required - The type of the inference task that the model will perform.

API name: task_type

timeout

public final PutVoyageaiRequest.Builder timeout(@Nullable
 Time value)

Specifies the amount of time to wait for the inference endpoint to be created.

API name: timeout

timeout

public final PutVoyageaiRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specifies the amount of time to wait for the inference endpoint to be created.

API name: timeout

voyageaiInferenceId

public final PutVoyageaiRequest.Builder voyageaiInferenceId(String value)

Required - The unique identifier of the inference endpoint.

API name: voyageai_inference_id

self

protected PutVoyageaiRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutVoyageaiRequest.Builder>

build

public PutVoyageaiRequest build()

Builds a PutVoyageaiRequest.

Specified by:

build in interface ObjectBuilder<PutVoyageaiRequest>

Throws:

NullPointerException - if some of the required fields are null.