Package akka.javasdk.agent

Record Class ModelProvider.LocalAI

Object

Record

akka.javasdk.agent.ModelProvider.LocalAI

All Implemented Interfaces:

ModelProvider

Enclosing interface:

ModelProvider

public static record ModelProvider.LocalAI(String baseUrl, String modelName, Double temperature, Double topP, int maxTokens)
extends Record
implements ModelProvider

Settings for the Local AI Large Language Model provider.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.javasdk.agent.ModelProvider

ModelProvider.Anthropic, ModelProvider.Custom, ModelProvider.FromConfig, ModelProvider.GoogleAIGemini, ModelProvider.HuggingFace, ModelProvider.LocalAI, ModelProvider.Ollama, ModelProvider.OpenAi

Constructor Summary

Constructors

Constructor	Description
LocalAI(String baseUrl, String modelName, Double temperature, Double topP, int maxTokens)	Creates an instance of a LocalAI record class.

Method Summary

Modifier and Type	Method	Description
String	baseUrl()	Returns the value of the baseUrl record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ModelProvider.LocalAI	fromConfig(com.typesafe.config.Config config)
final int	hashCode()	Returns a hash code value for this object.
int	maxTokens()	Returns the value of the maxTokens record component.
String	modelName()	Returns the value of the modelName record component.
Double	temperature()	Returns the value of the temperature record component.
Double	topP()	Returns the value of the topP record component.
final String	toString()	Returns a string representation of this record class.
ModelProvider.LocalAI	withMaxTokens(int maxTokens)
ModelProvider.LocalAI	withModelName(String modelName)
ModelProvider.LocalAI	withTemperature(double temperature)
ModelProvider.LocalAI	withTopP(double topP)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LocalAI

public LocalAI(String baseUrl,
 String modelName,
 Double temperature,
 Double topP,
 int maxTokens)

Creates an instance of a LocalAI 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

maxTokens - the value for the maxTokens record component

Method Details

fromConfig

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

withModelName

public ModelProvider.LocalAI withModelName(String modelName)

withTemperature

public ModelProvider.LocalAI withTemperature(double temperature)

withTopP

public ModelProvider.LocalAI withTopP(double topP)

withMaxTokens

public ModelProvider.LocalAI withMaxTokens(int maxTokens)

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

maxTokens

public int maxTokens()

Returns the value of the maxTokens record component.

Returns:

the value of the maxTokens record component