Package akka.javasdk.agent

Record Class ModelProvider.OpenAi

Object
Record
akka.javasdk.agent.ModelProvider.OpenAi
All Implemented Interfaces:
ModelProvider
Enclosing interface:
ModelProvider
public static record ModelProvider.OpenAi(String apiKey, String modelName, String baseUrl, double temperature, double topP, int maxTokens, int maxCompletionTokens, Duration connectionTimeout, Duration responseTimeout, int maxRetries) extends Record implements ModelProvider
Settings for the OpenAI Large Language Model provider.

  • Constructor Details

    • OpenAi

      public OpenAi(String apiKey, String modelName, String baseUrl, double temperature, double topP, int maxTokens, int maxCompletionTokens, Duration connectionTimeout, Duration responseTimeout, int maxRetries)
      Creates an instance of a OpenAi record class.
      Parameters:
      apiKey - the value for the apiKey record component
      modelName - the value for the modelName record component
      baseUrl - the value for the baseUrl 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
      connectionTimeout - the value for the connectionTimeout record component
      responseTimeout - the value for the responseTimeout record component
      maxRetries - the value for the maxRetries record component

  • Method Details

    • fromConfig

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

    • withApiKey

      public ModelProvider.OpenAi withApiKey(String apiKey)

    • withModelName

      public ModelProvider.OpenAi withModelName(String modelName)

    • withBaseUrl

      public ModelProvider.OpenAi withBaseUrl(String baseUrl)

    • withTemperature

      public ModelProvider.OpenAi withTemperature(double temperature)

    • withTopP

      public ModelProvider.OpenAi withTopP(double topP)

    • withMaxTokens

      public ModelProvider.OpenAi withMaxTokens(int maxTokens)

    • withMaxCompletionTokens

      public ModelProvider.OpenAi withMaxCompletionTokens(int maxCompletionTokens)

    • withConnectionTimeout

      public ModelProvider.OpenAi withConnectionTimeout(Duration connectionTimeout)

    • withResponseTimeout

      public ModelProvider.OpenAi withResponseTimeout(Duration responseTimeout)

    • withMaxRetries

      public ModelProvider.OpenAi withMaxRetries(int maxRetries)

    • 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.

    • apiKey

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

    • modelName

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

    • baseUrl

      public String baseUrl()
      Returns the value of the baseUrl record component.
      Returns:
      the value of the baseUrl 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

    • 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