Package co.elastic.clients.elasticsearch.inference

Class AzureAiStudioServiceSettings.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiKey

      public final AzureAiStudioServiceSettings.Builder apiKey(String value)
      Required - A valid API key of your Azure AI Studio model deployment. This key can be found on the overview page for your deployment in the management section of your Azure AI Studio 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

    • endpointType

      public final AzureAiStudioServiceSettings.Builder endpointType(String value)
      Required - The type of endpoint that is available for deployment through Azure AI Studio: token or realtime. The token endpoint type is for "pay as you go" endpoints that are billed per token. The realtime endpoint type is for "real-time" endpoints that are billed per hour of usage.

      API name: endpoint_type

    • target

      public final AzureAiStudioServiceSettings.Builder target(String value)
      Required - The target URL of your Azure AI Studio model deployment. This can be found on the overview page for your deployment in the management section of your Azure AI Studio account.

      API name: target

    • provider

      public final AzureAiStudioServiceSettings.Builder provider(String value)
      Required - The model provider for your deployment. Note that some providers may support only certain task types. Supported providers include:
      • cohere - available for text_embedding and completion task types
      • databricks - available for completion task type only
      • meta - available for completion task type only
      • microsoft_phi - available for completion task type only
      • mistral - available for completion task type only
      • openai - available for text_embedding and completion task types

      API name: provider

    • rateLimit

      public final AzureAiStudioServiceSettings.Builder rateLimit(@Nullable RateLimitSetting value)
      This setting helps to minimize the number of rate limit errors returned from Azure AI Studio. By default, the azureaistudio service sets the number of requests allowed per minute to 240.

      API name: rate_limit

    • rateLimit

      public final AzureAiStudioServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)
      This setting helps to minimize the number of rate limit errors returned from Azure AI Studio. By default, the azureaistudio service sets the number of requests allowed per minute to 240.

      API name: rate_limit

    • self

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

    • build

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