Package co.elastic.clients.elasticsearch.inference

Class AzureOpenAIServiceSettings.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<AzureOpenAIServiceSettings.Builder>
co.elastic.clients.elasticsearch.inference.AzureOpenAIServiceSettings.Builder
All Implemented Interfaces:
WithJson<AzureOpenAIServiceSettings.Builder>, ObjectBuilder<AzureOpenAIServiceSettings>
Enclosing class:
AzureOpenAIServiceSettings
public static class AzureOpenAIServiceSettings.Builder extends WithJsonObjectBuilderBase<AzureOpenAIServiceSettings.Builder> implements ObjectBuilder<AzureOpenAIServiceSettings>
Builder for AzureOpenAIServiceSettings.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiKey

      public final AzureOpenAIServiceSettings.Builder apiKey(@Nullable String value)
      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 AzureOpenAIServiceSettings.Builder apiVersion(String value)
      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 AzureOpenAIServiceSettings.Builder deploymentId(String value)
      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

      public final AzureOpenAIServiceSettings.Builder entraId(@Nullable String value)
      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

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

    • rateLimit

      public final AzureOpenAIServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)
      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 AzureOpenAIServiceSettings.Builder resourceName(String value)
      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

    • self

      protected AzureOpenAIServiceSettings.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<AzureOpenAIServiceSettings.Builder>

    • build

      public AzureOpenAIServiceSettings build()
      Builds a AzureOpenAIServiceSettings.
      Specified by:
      build in interface ObjectBuilder<AzureOpenAIServiceSettings>
      Throws:
      NullPointerException - if some of the required fields are null.