Package co.elastic.clients.elasticsearch.inference

Class WatsonxServiceSettings

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

  • Field Details

  • Method Details

    • of

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

    • apiKey

      public final String apiKey()
      Required - A valid API key of your Watsonx account. You can find your Watsonx 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

    • apiVersion

      public final String apiVersion()
      Required - A version parameter that takes a version date in the format of YYYY-MM-DD. For the active version data parameters, refer to the Wastonx documentation.

      API name: api_version

    • modelId

      public final String modelId()
      Required - The name of the model to use for the inference task. Refer to the IBM Embedding Models section in the Watsonx documentation for the list of available text embedding models.

      API name: model_id

    • projectId

      public final String projectId()
      Required - The identifier of the IBM Cloud project to use for the inference task.

      API name: project_id

    • rateLimit

      @Nullable public final RateLimitSetting rateLimit()
      This setting helps to minimize the number of rate limit errors returned from Watsonx. By default, the watsonxai service sets the number of requests allowed per minute to 120.

      API name: rate_limit

    • url

      public final String url()
      Required - The URL of the inference endpoint that you created on Watsonx.

      API name: url

    • 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

    • setupWatsonxServiceSettingsDeserializer

      protected static void setupWatsonxServiceSettingsDeserializer(ObjectDeserializer<WatsonxServiceSettings.Builder> op)