Package org.openhab.core.voice.text

Record Class InterpreterContext

java.lang.Object

java.lang.Record

org.openhab.core.voice.text.InterpreterContext

@NonNullByDefault
public record InterpreterContext(Conversation conversation, List<LLMTool> tools, @Nullable String locationItem)
extends Record

Context passed to the HumanLanguageInterpreter when interpreting a new input text.

Author:

Miguel Álvarez Díez - Initial contribution

Constructor Summary

Constructors

Constructor	Description
InterpreterContext(Conversation conversation, List<LLMTool> tools, @Nullable String locationItem)	Creates an instance of a InterpreterContext record class.

Method Summary

Modifier and Type	Method	Description
Conversation	conversation()	Returns the value of the conversation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	locationItem()	Returns the value of the locationItem record component.
List<LLMTool>	tools()	Returns the value of the tools record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

InterpreterContext

public InterpreterContext(Conversation conversation,
 List<LLMTool> tools,
 @Nullable String locationItem)

Creates an instance of a InterpreterContext record class.

Parameters:

conversation - the value for the conversation record component

tools - the value for the tools record component

locationItem - the value for the locationItem record component

Method Details

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

conversation

public Conversation conversation()

Returns the value of the conversation record component.

Returns:

the value of the conversation record component

tools

public List<LLMTool> tools()

Returns the value of the tools record component.

Returns:

the value of the tools record component

locationItem

public @Nullable String locationItem()

Returns the value of the locationItem record component.

Returns:

the value of the locationItem record component