Package org.openhab.core.voice.text.conversation

Enum Class ConversationRole

java.lang.Object

java.lang.Enum<ConversationRole>

org.openhab.core.voice.text.conversation.ConversationRole

All Implemented Interfaces:

Serializable, Comparable<ConversationRole>, Constable

@NonNullByDefault
public enum ConversationRole
extends Enum<ConversationRole>

The ConversationRole class defines the role/author of a message in a Conversation.

Author:

Miguel Álvarez Díez - Initial contribution

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
OPENHAB	For messages generated by an interpreter
THINKING	For LLM thinking
TOOL_CALL	For LLM tool calling
TOOL_RETURN	For LLM tool call calling result
USER	For user messages

Method Summary

Modifier and Type	Method	Description
static ConversationRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConversationRole[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER

public static final ConversationRole USER

For user messages

OPENHAB

public static final ConversationRole OPENHAB

For messages generated by an interpreter

THINKING

public static final ConversationRole THINKING

For LLM thinking

TOOL_CALL

public static final ConversationRole TOOL_CALL

For LLM tool calling

TOOL_RETURN

public static final ConversationRole TOOL_RETURN

For LLM tool call calling result

Method Details

values

public static ConversationRole[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ConversationRole valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null