Package co.elastic.clients.elasticsearch.inference

Class FireworksAIServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.FireworksAIServiceSettings.Builder

All Implemented Interfaces:

WithJson<FireworksAIServiceSettings.Builder>, ObjectBuilder<FireworksAIServiceSettings>

Enclosing class:

FireworksAIServiceSettings

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

Builder for FireworksAIServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final FireworksAIServiceSettings.Builder	apiKey(String value)	Required - A valid API key for your Fireworks AI account.
FireworksAIServiceSettings	build()	Builds a FireworksAIServiceSettings.
final FireworksAIServiceSettings.Builder	dimensions(Integer value)	For a text_embedding task, the number of dimensions the resulting output embeddings should have.
final FireworksAIServiceSettings.Builder	modelId(String value)	Required - The name of the model to use for the inference task.
final FireworksAIServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from the Fireworks AI API.
final FireworksAIServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from the Fireworks AI API.
protected FireworksAIServiceSettings.Builder	self()
final FireworksAIServiceSettings.Builder	similarity(FireworksAISimilarityType value)	For a text_embedding task, the similarity measure.
final FireworksAIServiceSettings.Builder	url(String value)	The URL endpoint to use for the requests.

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 FireworksAIServiceSettings.Builder apiKey(String value)

Required - A valid API key for your Fireworks AI account. You can find or create your API keys in the Fireworks AI dashboard.

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

modelId

public final FireworksAIServiceSettings.Builder modelId(String value)

Required - The name of the model to use for the inference task. Refer to the Fireworks AI documentation for the list of available models for chat completion, completion, and text embedding. For text embedding, supported models include the Qwen3 embedding family (e.g. fireworks/qwen3-embedding-8b) and other models in the Fireworks model library.

API name: model_id

url

public final FireworksAIServiceSettings.Builder url(@Nullable
 String value)

The URL endpoint to use for the requests. If not provided, the default Fireworks AI API endpoint is used.

API name: url

dimensions

public final FireworksAIServiceSettings.Builder dimensions(@Nullable
 Integer value)

For a text_embedding task, the number of dimensions the resulting output embeddings should have. Variable-length embeddings are supported via this parameter.

API name: dimensions

similarity

public final FireworksAIServiceSettings.Builder similarity(@Nullable
 FireworksAISimilarityType value)

For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm.

API name: similarity

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the Fireworks AI API. Rate limit grouping is per API key only. By default, the fireworksai service sets the number of requests allowed per minute to 6000.

API name: rate_limit

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from the Fireworks AI API. Rate limit grouping is per API key only. By default, the fireworksai service sets the number of requests allowed per minute to 6000.

API name: rate_limit

self

protected FireworksAIServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<FireworksAIServiceSettings.Builder>

build

public FireworksAIServiceSettings build()

Builds a FireworksAIServiceSettings.

Specified by:

build in interface ObjectBuilder<FireworksAIServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.