Package akka.javasdk.agent

Record Class ModelProvider.Ollama

Object
Record
akka.javasdk.agent.ModelProvider.Ollama
All Implemented Interfaces:
ModelProvider
Enclosing interface:
ModelProvider
public static record ModelProvider.Ollama(String baseUrl, String modelName, Double temperature, Double topP, Duration connectionTimeout, Duration responseTimeout, int maxRetries, boolean think, List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders) extends Record implements ModelProvider
Settings for the Ollama Large Language Model provider.

  • Constructor Details

    • Ollama

      public Ollama(String baseUrl, String modelName, Double temperature, Double topP, Duration connectionTimeout, Duration responseTimeout, int maxRetries, boolean think, List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders)
      Creates an instance of a Ollama record class.
      Parameters:
      baseUrl - the value for the baseUrl record component
      modelName - the value for the modelName record component
      temperature - the value for the temperature record component
      topP - the value for the topP 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
      think - the value for the think record component
      additionalModelRequestHeaders - the value for the additionalModelRequestHeaders record component

  • Method Details

    • fromConfig

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

    • withBaseUrl

      public ModelProvider.Ollama withBaseUrl(String baseUrl)

    • withModelName

      public ModelProvider.Ollama withModelName(String modelName)

    • withTemperature

      public ModelProvider.Ollama withTemperature(double temperature)

    • withTopP

      public ModelProvider.Ollama withTopP(double topP)

    • withConnectionTimeout

      public ModelProvider.Ollama withConnectionTimeout(Duration connectionTimeout)

    • withResponseTimeout

      public ModelProvider.Ollama withResponseTimeout(Duration responseTimeout)

    • withMaxRetries

      public ModelProvider.Ollama withMaxRetries(int maxRetries)

    • withThink

      public ModelProvider.Ollama withThink(boolean think)

    • withAdditionalModelRequestHeaders

      public ModelProvider.Ollama withAdditionalModelRequestHeaders(List<akka.http.javadsl.model.HttpHeader> additionalModelRequestHeaders)
      Description copied from interface: ModelProvider
      Returns a copy of this provider with the given extra HTTP headers on every request to the model API. Use it for authentication tokens to an AI gateway or proxy, or for routing and tracing headers.

      For a provider built in code, the given headers replace whatever the configuration set for that provider. For ModelProvider.FromConfig, they are added to the headers of the provider that the configuration resolves to, and a header named in both takes the value given here.

      ModelProvider.Custom throws UnsupportedOperationException unless the implementation overrides this method.

      Specified by:
      withAdditionalModelRequestHeaders in interface ModelProvider
      Parameters:
      additionalModelRequestHeaders - the headers to add to each model request
      Returns:
      a copy of this provider carrying the given headers

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

    • baseUrl

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

    • modelName

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

    • 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

    • think

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