Package co.elastic.clients.elasticsearch.inference

Class JinaAIServiceSettings

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

  • Field Details

  • Method Details

    • of

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

    • apiKey

      public final String apiKey()
      Required - A valid API key of your JinaAI account.

      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

    • modelId

      @Nullable public final String modelId()
      The name of the model to use for the inference task. For a rerank task, it is required. For a text_embedding task, it is optional.

      API name: model_id

    • rateLimit

      @Nullable public final RateLimitSetting rateLimit()
      This setting helps to minimize the number of rate limit errors returned from JinaAI. By default, the jinaai service sets the number of requests allowed per minute to 2000 for all task types.

      API name: rate_limit

    • similarity

      @Nullable public final JinaAISimilarityType similarity()
      For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm. The default values varies with the embedding type. For example, a float embedding type uses a dot_product similarity measure by default.

      API name: similarity

    • 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

    • setupJinaAIServiceSettingsDeserializer

      protected static void setupJinaAIServiceSettingsDeserializer(ObjectDeserializer<JinaAIServiceSettings.Builder> op)