Package co.elastic.clients.elasticsearch.inference

Class Ai21ServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.Ai21ServiceSettings.Builder

All Implemented Interfaces:

WithJson<Ai21ServiceSettings.Builder>, ObjectBuilder<Ai21ServiceSettings>

Enclosing class:

Ai21ServiceSettings

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

Builder for Ai21ServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

modelId

public final Ai21ServiceSettings.Builder modelId(String value)

Required - The name of the model to use for the inference task. Refer to the AI21 models documentation for the list of supported models and versions. Service has been tested and confirmed to be working for completion and chat_completion tasks with the following models:

• jamba-mini
• jamba-large

API name: model_id

apiKey

public final Ai21ServiceSettings.Builder apiKey(@Nullable
 String value)

A valid API key for accessing AI21 API.

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.

API name: api_key

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the AI21 API. By default, the ai21 service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.

API name: rate_limit

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the AI21 API. By default, the ai21 service sets the number of requests allowed per minute to 200. Please refer to AI21 documentation for more details.

API name: rate_limit

self

protected Ai21ServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<Ai21ServiceSettings.Builder>

build

public Ai21ServiceSettings build()

Builds a Ai21ServiceSettings.

Specified by:

build in interface ObjectBuilder<Ai21ServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.