Package co.elastic.clients.elasticsearch.inference

Class FireworksAIServiceSettings

java.lang.Object
co.elastic.clients.elasticsearch.inference.FireworksAIServiceSettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class FireworksAIServiceSettings extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • apiKey

      public final String apiKey()
      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 String modelId()
      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

      @Nullable public final String url()
      The URL endpoint to use for the requests. If not provided, the default Fireworks AI API endpoint is used.

      API name: url

    • dimensions

      @Nullable public final Integer dimensions()
      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

      @Nullable public final FireworksAISimilarityType similarity()
      For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm.

      API name: similarity

    • rateLimit

      @Nullable public final RateLimitSetting rateLimit()
      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

    • 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

    • rebuild

      public FireworksAIServiceSettings.Builder rebuild()
      Returns:
      New FireworksAIServiceSettings.Builder initialized with field values of this instance

    • setupFireworksAIServiceSettingsDeserializer

      protected static void setupFireworksAIServiceSettingsDeserializer(ObjectDeserializer<FireworksAIServiceSettings.Builder> op)