AgentResult
Defined in: src/types/agent.ts:147
Result returned by the agent loop.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AgentResult(data): AgentResult;Defined in: src/types/agent.ts:178
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { stopReason: StopReason; lastMessage: Message; traces?: AgentTrace[]; metrics?: AgentMetrics; structuredOutput?: unknown; } |
data.stopReason | StopReason |
data.lastMessage | Message |
data.traces? | AgentTrace[] |
data.metrics? | AgentMetrics |
data.structuredOutput? | unknown |
Returns
Section titled “Returns”AgentResult
Properties
Section titled “Properties”readonly type: "agentResult";Defined in: src/types/agent.ts:148
stopReason
Section titled “stopReason”readonly stopReason: StopReason;Defined in: src/types/agent.ts:153
The stop reason from the final model response.
lastMessage
Section titled “lastMessage”readonly lastMessage: Message;Defined in: src/types/agent.ts:158
The last message added to the messages array.
traces?
Section titled “traces?”readonly optional traces?: AgentTrace[];Defined in: src/types/agent.ts:164
Local execution traces collected during the agent invocation. Contains timing and hierarchy of operations within the agent loop.
structuredOutput?
Section titled “structuredOutput?”readonly optional structuredOutput?: unknown;Defined in: src/types/agent.ts:170
The validated structured output from the LLM, if a schema was provided. Type represents any validated Zod schema output.
metrics?
Section titled “metrics?”readonly optional metrics?: AgentMetrics;Defined in: src/types/agent.ts:176
Aggregated metrics for the agent’s loop execution. Tracks cycle counts, token usage, tool execution stats, and model latency.
Methods
Section titled “Methods”toJSON()
Section titled “toJSON()”toJSON(): object;Defined in: src/types/agent.ts:208
Custom JSON serialization that excludes traces and metrics by default. This prevents accidentally sending large trace/metric data over the wire when serializing AgentResult for API responses.
Traces and metrics remain accessible via their properties for debugging, but won’t be included in JSON.stringify() output.
Returns
Section titled “Returns”object
Object representation without traces/metrics for safe serialization
toString()
Section titled “toString()”toString(): string;Defined in: src/types/agent.ts:223
Extracts and concatenates all text content from the last message. Includes text from TextBlock and ReasoningBlock content blocks.
Returns
Section titled “Returns”string
The agent’s last message as a string, with multiple blocks joined by newlines.