Package co.elastic.clients.elasticsearch.inference

Class PutOpenaiRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.PutOpenaiRequest.Builder

All Implemented Interfaces:

WithJson<PutOpenaiRequest.Builder>, ObjectBuilder<PutOpenaiRequest>

Enclosing class:

PutOpenaiRequest

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

Builder for PutOpenaiRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 PutOpenaiRequest.Builder chunkingSettings(@Nullable
 InferenceChunkingSettings value)

The chunking configuration object.

API name: chunking_settings

chunkingSettings

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

The chunking configuration object.

API name: chunking_settings

openaiInferenceId

public final PutOpenaiRequest.Builder openaiInferenceId(String value)

Required - The unique identifier of the inference endpoint.

API name: openai_inference_id

service

public final PutOpenaiRequest.Builder service(OpenAIServiceType value)

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

API name: service

serviceSettings

public final PutOpenaiRequest.Builder serviceSettings(OpenAIServiceSettings value)

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

API name: service_settings

serviceSettings

public final PutOpenaiRequest.Builder serviceSettings(Function<OpenAIServiceSettings.Builder,ObjectBuilder<OpenAIServiceSettings>> fn)

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

API name: service_settings

taskSettings

public final PutOpenaiRequest.Builder taskSettings(@Nullable
 OpenAITaskSettings value)

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

API name: task_settings

taskSettings

public final PutOpenaiRequest.Builder taskSettings(Function<OpenAITaskSettings.Builder,ObjectBuilder<OpenAITaskSettings>> fn)

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

API name: task_settings

taskType

public final PutOpenaiRequest.Builder taskType(OpenAITaskType value)

Required - The type of the inference task that the model will perform. NOTE: The chat_completion task type only supports streaming and only through the _stream API.

API name: task_type

timeout

public final PutOpenaiRequest.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 PutOpenaiRequest.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

self

protected PutOpenaiRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutOpenaiRequest.Builder>

build

public PutOpenaiRequest build()

Builds a PutOpenaiRequest.

Specified by:

build in interface ObjectBuilder<PutOpenaiRequest>

Throws:

NullPointerException - if some of the required fields are null.