Package co.elastic.clients.elasticsearch.inference

Class ContextualAIServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.ContextualAIServiceSettings.Builder

All Implemented Interfaces:

WithJson<ContextualAIServiceSettings.Builder>, ObjectBuilder<ContextualAIServiceSettings>

Enclosing class:

ContextualAIServiceSettings

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

Builder for ContextualAIServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ContextualAIServiceSettings.Builder	apiKey(String value)	Required - A valid API key for your Contexutual AI account.
ContextualAIServiceSettings	build()	Builds a ContextualAIServiceSettings.
final ContextualAIServiceSettings.Builder	modelId(String value)	Required - The name of the model to use for the inference task.
final ContextualAIServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from Contextual AI.
final ContextualAIServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from Contextual AI.
protected ContextualAIServiceSettings.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

apiKey

public final ContextualAIServiceSettings.Builder apiKey(String value)

Required - A valid API key for your Contexutual AI account.

IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.

API name: api_key

modelId

public final ContextualAIServiceSettings.Builder modelId(String value)

Required - The name of the model to use for the inference task. Refer to the Contextual AI documentation for the list of available rerank models.

API name: model_id

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from Contextual AI. The contextualai service sets a default number of requests allowed per minute depending on the task type. For rerank, it is set to 1000.

API name: rate_limit

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from Contextual AI. The contextualai service sets a default number of requests allowed per minute depending on the task type. For rerank, it is set to 1000.

API name: rate_limit

self

protected ContextualAIServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ContextualAIServiceSettings.Builder>

build

public ContextualAIServiceSettings build()

Builds a ContextualAIServiceSettings.

Specified by:

build in interface ObjectBuilder<ContextualAIServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.