Package akka.javasdk.agent

Record Class ModelProvider.AzureOpenAi

Object
Record
akka.javasdk.agent.ModelProvider.AzureOpenAi
All Implemented Interfaces:
ModelProvider
Enclosing interface:
ModelProvider
public static record ModelProvider.AzureOpenAi(String endpoint, String deploymentName, String apiKey, double temperature, double topP, int maxTokens, int maxCompletionTokens, double frequencyPenalty, double presencePenalty, long seed, List<String> stop, String reasoningEffort, String serviceVersion, Duration connectionTimeout, Duration responseTimeout, int maxRetries, List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders) extends Record implements ModelProvider
Settings for the Azure OpenAI Large Language Model provider.

  • Constructor Details

    • AzureOpenAi

      public AzureOpenAi(String endpoint, String deploymentName, String apiKey, double temperature, double topP, int maxTokens, int maxCompletionTokens, double frequencyPenalty, double presencePenalty, long seed, List<String> stop, String reasoningEffort, String serviceVersion, Duration connectionTimeout, Duration responseTimeout, int maxRetries, List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders)
      Creates an instance of a AzureOpenAi record class.
      Parameters:
      endpoint - the value for the endpoint record component
      deploymentName - the value for the deploymentName record component
      apiKey - the value for the apiKey record component
      temperature - the value for the temperature record component
      topP - the value for the topP record component
      maxTokens - the value for the maxTokens record component
      maxCompletionTokens - the value for the maxCompletionTokens record component
      frequencyPenalty - the value for the frequencyPenalty record component
      presencePenalty - the value for the presencePenalty record component
      seed - the value for the seed record component
      stop - the value for the stop record component
      reasoningEffort - the value for the reasoningEffort record component
      serviceVersion - the value for the serviceVersion record component
      connectionTimeout - the value for the connectionTimeout record component
      responseTimeout - the value for the responseTimeout record component
      maxRetries - the value for the maxRetries record component
      additionalModelRequestHeaders - the value for the additionalModelRequestHeaders record component

  • Method Details

    • fromConfig

      public static ModelProvider.AzureOpenAi fromConfig(com.typesafe.config.Config config)

    • withEndpoint

      public ModelProvider.AzureOpenAi withEndpoint(String endpoint)

    • withDeploymentName

      public ModelProvider.AzureOpenAi withDeploymentName(String deploymentName)

    • withApiKey

      public ModelProvider.AzureOpenAi withApiKey(String apiKey)

    • withTemperature

      public ModelProvider.AzureOpenAi withTemperature(double temperature)

    • withTopP

      public ModelProvider.AzureOpenAi withTopP(double topP)

    • withMaxTokens

      public ModelProvider.AzureOpenAi withMaxTokens(int maxTokens)

    • withMaxCompletionTokens

      public ModelProvider.AzureOpenAi withMaxCompletionTokens(int maxCompletionTokens)

    • withFrequencyPenalty

      public ModelProvider.AzureOpenAi withFrequencyPenalty(double frequencyPenalty)

    • withPresencePenalty

      public ModelProvider.AzureOpenAi withPresencePenalty(double presencePenalty)

    • withSeed

      public ModelProvider.AzureOpenAi withSeed(long seed)

    • withStop

      public ModelProvider.AzureOpenAi withStop(List<String> stop)

    • withReasoningEffort

      public ModelProvider.AzureOpenAi withReasoningEffort(String reasoningEffort)

    • withServiceVersion

      public ModelProvider.AzureOpenAi withServiceVersion(String serviceVersion)

    • withConnectionTimeout

      public ModelProvider.AzureOpenAi withConnectionTimeout(Duration connectionTimeout)

    • withResponseTimeout

      public ModelProvider.AzureOpenAi withResponseTimeout(Duration responseTimeout)

    • withMaxRetries

      public ModelProvider.AzureOpenAi withMaxRetries(int maxRetries)

    • withAdditionalModelRequestHeaders

      public ModelProvider.AzureOpenAi withAdditionalModelRequestHeaders(List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • endpoint

      public String endpoint()
      Returns the value of the endpoint record component.
      Returns:
      the value of the endpoint record component

    • deploymentName

      public String deploymentName()
      Returns the value of the deploymentName record component.
      Returns:
      the value of the deploymentName record component

    • apiKey

      public String apiKey()
      Returns the value of the apiKey record component.
      Returns:
      the value of the apiKey record component

    • temperature

      public double temperature()
      Returns the value of the temperature record component.
      Returns:
      the value of the temperature record component

    • topP

      public double topP()
      Returns the value of the topP record component.
      Returns:
      the value of the topP record component

    • maxTokens

      public int maxTokens()
      Returns the value of the maxTokens record component.
      Returns:
      the value of the maxTokens record component

    • maxCompletionTokens

      public int maxCompletionTokens()
      Returns the value of the maxCompletionTokens record component.
      Returns:
      the value of the maxCompletionTokens record component

    • frequencyPenalty

      public double frequencyPenalty()
      Returns the value of the frequencyPenalty record component.
      Returns:
      the value of the frequencyPenalty record component

    • presencePenalty

      public double presencePenalty()
      Returns the value of the presencePenalty record component.
      Returns:
      the value of the presencePenalty record component

    • seed

      public long seed()
      Returns the value of the seed record component.
      Returns:
      the value of the seed record component

    • stop

      public List<String> stop()
      Returns the value of the stop record component.
      Returns:
      the value of the stop record component

    • reasoningEffort

      public String reasoningEffort()
      Returns the value of the reasoningEffort record component.
      Returns:
      the value of the reasoningEffort record component

    • serviceVersion

      public String serviceVersion()
      Returns the value of the serviceVersion record component.
      Returns:
      the value of the serviceVersion record component

    • connectionTimeout

      public Duration connectionTimeout()
      Returns the value of the connectionTimeout record component.
      Returns:
      the value of the connectionTimeout record component

    • responseTimeout

      public Duration responseTimeout()
      Returns the value of the responseTimeout record component.
      Returns:
      the value of the responseTimeout record component

    • maxRetries

      public int maxRetries()
      Returns the value of the maxRetries record component.
      Returns:
      the value of the maxRetries record component

    • additionalModelRequestHeaders

      public List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders()
      Returns the value of the additionalModelRequestHeaders record component.
      Returns:
      the value of the additionalModelRequestHeaders record component