StreamedAgentResponse
class StreamedAgentResponse extends AgentResponse
Traits
Properties
| Response|null | $raw | The raw HTTP response, if available for the provider. |
from HasRawResponse |
| Message> | $messages | from TextResponse | |
| ToolCall> | $toolCalls | from TextResponse | |
| ToolResult> | $toolResults | from TextResponse | |
| Step> | $steps | from TextResponse | |
| PendingApproval> | $pendingApprovals | from TextResponse | |
| string | $reasoning | from TextResponse | |
| string | $invocationId | from AgentResponse | |
| string|null | $conversationId | from AgentResponse | |
| object|null | $conversationUser | from AgentResponse | |
| string|null | $userMessageId | from AgentResponse | |
| string|null | $assistantMessageId | from AgentResponse | |
| StreamEvent> | $events |
Methods
Prepare the instance for serialization, discarding the unserializable raw HTTP response.
Build an agent response from its recorded stream events.
Provide the tool calls and results for the message.
Provide the reasoning emitted across every step of the response.
Determine whether the response has tool calls pending approval.
Create a fake response that reasoned before answering.
Create a fake response that is waiting for approval.
Set the conversation UUID and participant for this response.
Set the conversation message rows this turn wrote.
Join reasoning blocks, separating each block with a blank line.
Details
in
HasRawResponse at line 19
HasRawResponse
withRawResponse(Response|null $response)
Set the raw HTTP response.
in
HasRawResponse at line 29
array
__serialize()
Prepare the instance for serialization, discarding the unserializable raw HTTP response.
at line 33
__construct(string $invocationId, Collection $events, Meta $meta)
Build an agent response from its recorded stream events.
in
TextResponse at line 58
TextResponse
withMessages(Collection $messages)
Provide the message context for the response.
in
TextResponse at line 85
TextResponse
withToolCallsAndResults(Collection $toolCalls, Collection $toolResults)
Provide the tool calls and results for the message.
in
TextResponse at line 100
TextResponse
withReasoning(string $reasoning)
Provide the reasoning emitted across every step of the response.
in
TextResponse at line 112
TextResponse
withSteps(Collection $steps)
Provide the steps taken to generate the response.
in
TextResponse at line 124
TextResponse
withPendingApprovals(Collection $pendingApprovals)
Mark the response as waiting for tool approval.
in
TextResponse at line 134
bool
hasPendingApprovals()
Determine whether the response has tool calls pending approval.
in
TextResponse at line 142
string
__toString()
Get the string representation of the object.
in
AgentResponse at line 37
static AgentResponse
fakeWithReasoning(string $reasoning, string $text = '')
Create a fake response that reasoned before answering.
in
AgentResponse at line 49
static AgentResponse
fakeWithPendingApprovals(array|Collection $pendingApprovals)
Create a fake response that is waiting for approval.
in
AgentResponse at line 58
AgentResponse
withinConversation(string $conversationId, object|null $conversationUser = null)
Set the conversation UUID and participant for this response.
in
AgentResponse at line 69
AgentResponse
withStoredMessages(string|null $userMessageId, string|null $assistantMessageId)
Set the conversation message rows this turn wrote.
in
AgentResponse at line 80
AgentResponse
then(callable $callback)
Execute a callback with this response.
in
JoinsReasoning at line 16
static protected string
joinReasoning(iterable $blocks)
Join reasoning blocks, separating each block with a blank line.