Package co.elastic.clients.elasticsearch.inference

Class PutOpenshiftAiRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.PutOpenshiftAiRequest.Builder

All Implemented Interfaces:

WithJson<PutOpenshiftAiRequest.Builder>, ObjectBuilder<PutOpenshiftAiRequest>

Enclosing class:

PutOpenshiftAiRequest

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

Builder for PutOpenshiftAiRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutOpenshiftAiRequest	build()	Builds a PutOpenshiftAiRequest.
final PutOpenshiftAiRequest.Builder	chunkingSettings(InferenceChunkingSettings value)	The chunking configuration object.
final PutOpenshiftAiRequest.Builder	chunkingSettings(Function<InferenceChunkingSettings.Builder,ObjectBuilder<InferenceChunkingSettings>> fn)	The chunking configuration object.
final PutOpenshiftAiRequest.Builder	openshiftaiInferenceId(String value)	Required - The unique identifier of the inference endpoint.
protected PutOpenshiftAiRequest.Builder	self()
final PutOpenshiftAiRequest.Builder	service(OpenShiftAiServiceType value)	Required - The type of service supported for the specified task type.
final PutOpenshiftAiRequest.Builder	serviceSettings(OpenShiftAiServiceSettings value)	Required - Settings used to install the inference model.
final PutOpenshiftAiRequest.Builder	serviceSettings(Function<OpenShiftAiServiceSettings.Builder,ObjectBuilder<OpenShiftAiServiceSettings>> fn)	Required - Settings used to install the inference model.
final PutOpenshiftAiRequest.Builder	taskSettings(OpenShiftAiTaskSettings value)	Settings to configure the inference task.
final PutOpenshiftAiRequest.Builder	taskSettings(Function<OpenShiftAiTaskSettings.Builder,ObjectBuilder<OpenShiftAiTaskSettings>> fn)	Settings to configure the inference task.
final PutOpenshiftAiRequest.Builder	taskType(OpenShiftAiTaskType value)	Required - The type of the inference task that the model will perform.
final PutOpenshiftAiRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference endpoint to be created.
final PutOpenshiftAiRequest.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 PutOpenshiftAiRequest.Builder chunkingSettings(@Nullable
 InferenceChunkingSettings value)

The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the rerank, completion, or chat_completion task types.

API name: chunking_settings

chunkingSettings

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

The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the rerank, completion, or chat_completion task types.

API name: chunking_settings

openshiftaiInferenceId

public final PutOpenshiftAiRequest.Builder openshiftaiInferenceId(String value)

Required - The unique identifier of the inference endpoint.

API name: openshiftai_inference_id

service

public final PutOpenshiftAiRequest.Builder service(OpenShiftAiServiceType value)

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

API name: service

serviceSettings

public final PutOpenshiftAiRequest.Builder serviceSettings(OpenShiftAiServiceSettings value)

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

API name: service_settings

serviceSettings

public final PutOpenshiftAiRequest.Builder serviceSettings(Function<OpenShiftAiServiceSettings.Builder,ObjectBuilder<OpenShiftAiServiceSettings>> fn)

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

API name: service_settings

taskSettings

public final PutOpenshiftAiRequest.Builder taskSettings(@Nullable
 OpenShiftAiTaskSettings value)

Settings to configure the inference task. Applies only to the rerank task type. Not applicable to the text_embedding, completion, or chat_completion task types. These settings are specific to the task type you specified.

API name: task_settings

taskSettings

public final PutOpenshiftAiRequest.Builder taskSettings(Function<OpenShiftAiTaskSettings.Builder,ObjectBuilder<OpenShiftAiTaskSettings>> fn)

Settings to configure the inference task. Applies only to the rerank task type. Not applicable to the text_embedding, completion, or chat_completion task types. These settings are specific to the task type you specified.

API name: task_settings

taskType

public final PutOpenshiftAiRequest.Builder taskType(OpenShiftAiTaskType 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 PutOpenshiftAiRequest.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 PutOpenshiftAiRequest.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 PutOpenshiftAiRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutOpenshiftAiRequest.Builder>

build

public PutOpenshiftAiRequest build()

Builds a PutOpenshiftAiRequest.

Specified by:

build in interface ObjectBuilder<PutOpenshiftAiRequest>

Throws:

NullPointerException - if some of the required fields are null.