Package co.elastic.clients.elasticsearch.inference

Class PutJinaaiRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.inference.PutJinaaiRequest.Builder

All Implemented Interfaces:

WithJson<PutJinaaiRequest.Builder>, ObjectBuilder<PutJinaaiRequest>

Enclosing class:

PutJinaaiRequest

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

Builder for PutJinaaiRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

The chunking configuration object. Applies only to the text_embedding task type. Not applicable to the rerank task type.

API name: chunking_settings

chunkingSettings

public final PutJinaaiRequest.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 task type.

API name: chunking_settings

jinaaiInferenceId

public final PutJinaaiRequest.Builder jinaaiInferenceId(String value)

Required - The unique identifier of the inference endpoint.

API name: jinaai_inference_id

service

public final PutJinaaiRequest.Builder service(JinaAIServiceType value)

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

API name: service

serviceSettings

public final PutJinaaiRequest.Builder serviceSettings(JinaAIServiceSettings value)

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

API name: service_settings

serviceSettings

public final PutJinaaiRequest.Builder serviceSettings(Function<JinaAIServiceSettings.Builder,ObjectBuilder<JinaAIServiceSettings>> fn)

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

API name: service_settings

taskSettings

public final PutJinaaiRequest.Builder taskSettings(@Nullable
 JinaAITaskSettings value)

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

API name: task_settings

taskSettings

public final PutJinaaiRequest.Builder taskSettings(Function<JinaAITaskSettings.Builder,ObjectBuilder<JinaAITaskSettings>> fn)

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

API name: task_settings

taskType

public final PutJinaaiRequest.Builder taskType(JinaAITaskType value)

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

API name: task_type

timeout

public final PutJinaaiRequest.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 PutJinaaiRequest.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 PutJinaaiRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutJinaaiRequest.Builder>

build

public PutJinaaiRequest build()

Builds a PutJinaaiRequest.

Specified by:

build in interface ObjectBuilder<PutJinaaiRequest>

Throws:

NullPointerException - if some of the required fields are null.