Package akka.javasdk.agent

Record Class Guardrail.Message.AiMessage

Object

Record

akka.javasdk.agent.Guardrail.Message.AiMessage

Record Components:

thinking - the model's thinking, never null, but empty when the model returns none

attributes - values that the model provider sets, never null, but empty when the model provider sets none. The keys and the value types are provider-specific.

All Implemented Interfaces:

Guardrail.Message

Enclosing interface:

Guardrail.Message

public static record Guardrail.Message.AiMessage(String text, List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests, Optional<String> thinking, Map<String,Object> attributes)
extends Record
implements Guardrail.Message

A model reply with its text, requested tool calls, thinking, and provider attributes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Guardrail.Message.AiMessage.ToolCallRequest	A tool call the model requested: its id, tool name, and raw arguments.

Nested classes/interfaces inherited from interface akka.javasdk.agent.Guardrail.Message

Guardrail.Message.AiMessage, Guardrail.Message.ToolCallResponse, Guardrail.Message.UserMessage

Constructor Summary

Constructors

Constructor	Description
AiMessage(String text, List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests)
AiMessage(String text, List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests, Optional<String> thinking, Map<String,Object> attributes)	Creates an instance of a AiMessage record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	attributes()	Returns the value of the attributes 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.
String	text()	Returns the value of the text record component.
Optional<String>	thinking()	Returns the value of the thinking record component.
List<Guardrail.Message.AiMessage.ToolCallRequest>	toolCallRequests()	Returns the value of the toolCallRequests 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

AiMessage

public AiMessage(String text,
 List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests)

AiMessage

public AiMessage(String text,
 List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests,
 Optional<String> thinking,
 Map<String,Object> attributes)

Creates an instance of a AiMessage record class.

Parameters:

text - the value for the text record component

toolCallRequests - the value for the toolCallRequests record component

thinking - the value for the thinking record component

attributes - the value for the attributes 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.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

toolCallRequests

public List<Guardrail.Message.AiMessage.ToolCallRequest> toolCallRequests()

Returns the value of the toolCallRequests record component.

Returns:

the value of the toolCallRequests record component

thinking

public Optional<String> thinking()

Returns the value of the thinking record component.

Returns:

the value of the thinking record component

attributes

public Map<String,Object> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component