Package co.elastic.clients.elasticsearch.inference

Class AzureOpenAIServiceSettings

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

  • Field Details

  • Method Details

    • of

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

    • apiKey

      @Nullable public final String apiKey()
      A valid API key for your Azure OpenAI account. You must specify either api_key or entra_id. If you do not provide either or you provide both, you will receive an error when you try to create your model.

      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 - The Azure API version ID to use. It is recommended to use the latest supported non-preview version.

      API name: api_version

    • deploymentId

      public final String deploymentId()
      Required - The deployment name of your deployed models. Your Azure OpenAI deployments can be found though the Azure OpenAI Studio portal that is linked to your subscription.

      API name: deployment_id

    • entraId

      @Nullable public final String entraId()
      A valid Microsoft Entra token. You must specify either api_key or entra_id. If you do not provide either or you provide both, you will receive an error when you try to create your model.

      API name: entra_id

    • rateLimit

      @Nullable public final RateLimitSetting rateLimit()
      This setting helps to minimize the number of rate limit errors returned from Azure. The azureopenai service sets a default number of requests allowed per minute depending on the task type. For text_embedding, it is set to 1440. For completion, it is set to 120.

      API name: rate_limit

    • resourceName

      public final String resourceName()
      Required - The name of your Azure OpenAI resource. You can find this from the list of resources in the Azure Portal for your subscription.

      API name: resource_name

    • 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

    • setupAzureOpenAIServiceSettingsDeserializer

      protected static void setupAzureOpenAIServiceSettingsDeserializer(ObjectDeserializer<AzureOpenAIServiceSettings.Builder> op)