Package co.elastic.clients.elasticsearch.inference

Class MistralServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.MistralServiceSettings.Builder

All Implemented Interfaces:

WithJson<MistralServiceSettings.Builder>, ObjectBuilder<MistralServiceSettings>

Enclosing class:

MistralServiceSettings

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

Builder for MistralServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final MistralServiceSettings.Builder	apiKey(String value)	Required - A valid API key of your Mistral account.
MistralServiceSettings	build()	Builds a MistralServiceSettings.
final MistralServiceSettings.Builder	maxInputTokens(Integer value)	The maximum number of tokens per input before chunking occurs.
final MistralServiceSettings.Builder	model(String value)	Required - The name of the model to use for the inference task.
final MistralServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from the Mistral API.
final MistralServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from the Mistral API.
protected MistralServiceSettings.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 MistralServiceSettings.Builder apiKey(String value)

Required - A valid API key of your Mistral account. You can find your Mistral API keys or you can create a new one on the API Keys page.

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

maxInputTokens

public final MistralServiceSettings.Builder maxInputTokens(@Nullable
 Integer value)

The maximum number of tokens per input before chunking occurs.

API name: max_input_tokens

model

public final MistralServiceSettings.Builder model(String value)

Required - The name of the model to use for the inference task. Refer to the Mistral models documentation for the list of available text embedding models.

API name: model

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the Mistral API. By default, the mistral service sets the number of requests allowed per minute to 240.

API name: rate_limit

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the Mistral API. By default, the mistral service sets the number of requests allowed per minute to 240.

API name: rate_limit

self

protected MistralServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MistralServiceSettings.Builder>

build

public MistralServiceSettings build()

Builds a MistralServiceSettings.

Specified by:

build in interface ObjectBuilder<MistralServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.