Package co.elastic.clients.elasticsearch.inference

Class Ai21ServiceSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.Ai21ServiceSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Ai21ServiceSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Ai21ServiceSettings.Builder	Builder for Ai21ServiceSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Ai21ServiceSettings>	_DESERIALIZER	Json deserializer for Ai21ServiceSettings

Method Summary

Modifier and Type	Method	Description
final String	apiKey()	A valid API key for accessing AI21 API.
final String	modelId()	Required - The name of the model to use for the inference task.
static Ai21ServiceSettings	of(Function<Ai21ServiceSettings.Builder,ObjectBuilder<Ai21ServiceSettings>> fn)
final RateLimitSetting	rateLimit()	This setting helps to minimize the number of rate limit errors returned from the AI21 API.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAi21ServiceSettingsDeserializer(ObjectDeserializer<Ai21ServiceSettings.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Ai21ServiceSettings> _DESERIALIZER

Json deserializer for Ai21ServiceSettings

Method Details

of

public static Ai21ServiceSettings of(Function<Ai21ServiceSettings.Builder,ObjectBuilder<Ai21ServiceSettings>> fn)

modelId

public final String modelId()

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

@Nullable
public final String apiKey()

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. 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

rateLimit

@Nullable
public final RateLimitSetting rateLimit()

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

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupAi21ServiceSettingsDeserializer

protected static void setupAi21ServiceSettingsDeserializer(ObjectDeserializer<Ai21ServiceSettings.Builder> op)