Record Class AgentResponse

java.lang.Object

java.lang.Record

dev.langchain4j.agentic.observability.AgentResponse

Record Components:

chatRequest - the last request sent to the chat model by an AI agent in this invocation, or null for the other kinds of agents and for an AI agent returning a TokenStream, whose model call completes only after the invocation is reported

chatResponse - the last response of the chat model of an AI agent in this invocation, with the token usage of all the model calls of the invocation, and their model name only when all of them report the same one; null in the same cases as chatRequest

decisionResponse - the response of the decision model of a decision agent in this invocation, with its answers and their probabilities, or null for the other kinds of agents

public record AgentResponse(AgenticScope agenticScope, AgentInstance agent, Map<String,Object> inputs, Object output, ChatRequest chatRequest, ChatResponse chatResponse, DecisionResponse decisionResponse)
extends Record

The outcome of an agent invocation, reported to AgentListener.afterAgentInvocation(AgentResponse).

Constructor Summary

Constructors

Constructor	Description
AgentResponse(AgenticScope agenticScope, AgentInstance agent, Map<String,Object> inputs, Object output, ChatRequest chatRequest, ChatResponse chatResponse)
AgentResponse(AgenticScope agenticScope, AgentInstance agent, Map<String,Object> inputs, Object output, ChatRequest chatRequest, ChatResponse chatResponse, DecisionResponse decisionResponse)	Creates an instance of a AgentResponse record class.

Method Summary

Modifier and Type	Method	Description
AgentInstance	agent()	Returns the value of the agent record component.
AgenticScope	agenticScope()	Returns the value of the agenticScope record component.
String	agentId()
String	agentName()
ChatRequest	chatRequest()	Returns the value of the chatRequest record component.
ChatResponse	chatResponse()	Returns the value of the chatResponse record component.
DecisionResponse	decisionResponse()	Returns the value of the decisionResponse 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.
Map<String,Object>	inputs()	Returns the value of the inputs record component.
Object	output()	Returns the value of the output record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

AgentResponse

public AgentResponse(AgenticScope agenticScope,
 AgentInstance agent,
 Map<String,Object> inputs,
 Object output,
 ChatRequest chatRequest,
 ChatResponse chatResponse)

AgentResponse

public AgentResponse(AgenticScope agenticScope,
 AgentInstance agent,
 Map<String,Object> inputs,
 Object output,
 ChatRequest chatRequest,
 ChatResponse chatResponse,
 DecisionResponse decisionResponse)

Creates an instance of a AgentResponse record class.

Parameters:

agenticScope - the value for the agenticScope record component

agent - the value for the agent record component

inputs - the value for the inputs record component

output - the value for the output record component

chatRequest - the value for the chatRequest record component

chatResponse - the value for the chatResponse record component

decisionResponse - the value for the decisionResponse record component

Method Details

agentName

public String agentName()

agentId

public String agentId()

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.

agenticScope

public AgenticScope agenticScope()

Returns the value of the agenticScope record component.

Returns:

the value of the agenticScope record component

agent

public AgentInstance agent()

Returns the value of the agent record component.

Returns:

the value of the agent record component

inputs

public Map<String,Object> inputs()

Returns the value of the inputs record component.

Returns:

the value of the inputs record component

output

public Object output()

Returns the value of the output record component.

Returns:

the value of the output record component

chatRequest

public ChatRequest chatRequest()

Returns the value of the chatRequest record component.

Returns:

the value of the chatRequest record component

chatResponse

public ChatResponse chatResponse()

Returns the value of the chatResponse record component.

Returns:

the value of the chatResponse record component

decisionResponse

public DecisionResponse decisionResponse()

Returns the value of the decisionResponse record component.

Returns:

the value of the decisionResponse record component