Package co.elastic.clients.elasticsearch.inference

Class AzureAiStudioServiceSettings

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

  • Field Details

  • Method Details

    • of

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

    • apiKey

      public final String apiKey()
      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 String endpointType()
      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 String target()
      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 String provider()
      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

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

    • 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

    • setupAzureAiStudioServiceSettingsDeserializer

      protected static void setupAzureAiStudioServiceSettingsDeserializer(ObjectDeserializer<AzureAiStudioServiceSettings.Builder> op)