StructuredTextResponse
class StructuredTextResponse extends TextResponse implements ArrayAccess
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 | |
| array | $structured | from ProvidesStructuredResponse |
Methods
Prepare the instance for serialization, discarding the unserializable raw HTTP response.
Create a structured text response.
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.
Get the string representation of the object.
Determine if an item exists at an offset.
Set the item at a given offset.
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 20
__construct(array $structured, string $text, TextUsage $usage, Meta $meta)
Create a structured text response.
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.
at line 32
string
__toString()
Get the string representation of the object.
in
ProvidesStructuredResponse at line 14
bool
offsetExists(mixed $offset)
Determine if an item exists at an offset.
in
ProvidesStructuredResponse at line 22
mixed
offsetGet(mixed $offset)
Get an item at a given offset.
in
ProvidesStructuredResponse at line 30
void
offsetSet(mixed $offset, mixed $value)
Set the item at a given offset.
in
ProvidesStructuredResponse at line 42
void
offsetUnset(mixed $offset)
Unset the item at a given offset.