1. class
  2. Hypervel
  3. \
  4. Ai
  5. \
  6. Responses
  7. \
  8. StructuredAgentResponse

StructuredAgentResponse

class StructuredAgentResponse extends AgentResponse implements Arrayable, ArrayAccess, Jsonable, JsonSerializable

Traits

ProvidesStructuredResponse
HasRawResponse

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
array $structured from  ProvidesStructuredResponse

Methods

HasRawResponse
withRawResponse(Response|null $response)

Set the raw HTTP response.

from  HasRawResponse
array
__serialize()

Prepare the instance for serialization, discarding the unserializable raw HTTP response.

from  HasRawResponse
__construct(string $invocationId, array $structured, string $text, TextUsage $usage, Meta $meta)

Create a structured agent response.

TextResponse
withMessages(Collection $messages)

Provide the message context for the response.

from  TextResponse
TextResponse
withToolCallsAndResults(Collection $toolCalls, Collection $toolResults)

Provide the tool calls and results for the message.

from  TextResponse
TextResponse
withReasoning(string $reasoning)

Provide the reasoning emitted across every step of the response.

from  TextResponse
TextResponse
withSteps(Collection $steps)

Provide the steps taken to generate the response.

from  TextResponse
TextResponse
withPendingApprovals(Collection $pendingApprovals)

Mark the response as waiting for tool approval.

from  TextResponse
bool
hasPendingApprovals()

Determine whether the response has tool calls pending approval.

from  TextResponse
string
__toString()

Get the string representation of the object.

static AgentResponse
fakeWithReasoning(string $reasoning, string $text = '')

Create a fake response that reasoned before answering.

from  AgentResponse
static AgentResponse
fakeWithPendingApprovals(array|Collection $pendingApprovals)

Create a fake response that is waiting for approval.

from  AgentResponse
AgentResponse
withinConversation(string $conversationId, object|null $conversationUser = null)

Set the conversation UUID and participant for this response.

from  AgentResponse
AgentResponse
withStoredMessages(string|null $userMessageId, string|null $assistantMessageId)

Set the conversation message rows this turn wrote.

from  AgentResponse
AgentResponse
then(callable $callback)

Execute a callback with this response.

from  AgentResponse
bool
offsetExists(mixed $offset)

Determine if an item exists at an offset.

from  ProvidesStructuredResponse
mixed
offsetGet(mixed $offset)

Get an item at a given offset.

from  ProvidesStructuredResponse
void
offsetSet(mixed $offset, mixed $value)

Set the item at a given offset.

from  ProvidesStructuredResponse
void
offsetUnset(mixed $offset)

Unset the item at a given offset.

from  ProvidesStructuredResponse
array
toArray()

Get the instance as an array.

string
toJson(int $options = 0)

Convert the object to its JSON representation.

array
jsonSerialize()

Get the JSON serializable representation of the instance.

Details

in HasRawResponse at line 19
HasRawResponse withRawResponse(Response|null $response)

Set the raw HTTP response.

Parameters

Response|null $response

Return Value

HasRawResponse

in HasRawResponse at line 29
array __serialize()

Prepare the instance for serialization, discarding the unserializable raw HTTP response.

Return Value

array

at line 24
__construct(string $invocationId, array $structured, string $text, TextUsage $usage, Meta $meta)

Create a structured agent response.

Parameters

string $invocationId
array $structured
string $text
TextUsage $usage
Meta $meta

in TextResponse at line 58
TextResponse withMessages(Collection $messages)

Provide the message context for the response.

Parameters

Collection $messages

Return Value

TextResponse

in TextResponse at line 85
TextResponse withToolCallsAndResults(Collection $toolCalls, Collection $toolResults)

Provide the tool calls and results for the message.

Parameters

Collection $toolCalls
Collection $toolResults

Return Value

TextResponse

in TextResponse at line 100
TextResponse withReasoning(string $reasoning)

Provide the reasoning emitted across every step of the response.

Parameters

string $reasoning

Return Value

TextResponse

in TextResponse at line 112
TextResponse withSteps(Collection $steps)

Provide the steps taken to generate the response.

Parameters

Collection $steps

Return Value

TextResponse

in TextResponse at line 124
TextResponse withPendingApprovals(Collection $pendingApprovals)

Mark the response as waiting for tool approval.

Parameters

Collection $pendingApprovals

Return Value

TextResponse

in TextResponse at line 134
bool hasPendingApprovals()

Determine whether the response has tool calls pending approval.

Return Value

bool

at line 62
string __toString()

Get the string representation of the object.

Return Value

string

in AgentResponse at line 37
static AgentResponse fakeWithReasoning(string $reasoning, string $text = '')

Create a fake response that reasoned before answering.

Parameters

string $reasoning
string $text

Return Value

AgentResponse

in AgentResponse at line 49
static AgentResponse fakeWithPendingApprovals(array|Collection $pendingApprovals)

Create a fake response that is waiting for approval.

Parameters

array|Collection $pendingApprovals

Return Value

AgentResponse

in AgentResponse at line 58
AgentResponse withinConversation(string $conversationId, object|null $conversationUser = null)

Set the conversation UUID and participant for this response.

Parameters

string $conversationId
object|null $conversationUser

Return Value

AgentResponse

in AgentResponse at line 69
AgentResponse withStoredMessages(string|null $userMessageId, string|null $assistantMessageId)

Set the conversation message rows this turn wrote.

Parameters

string|null $userMessageId
string|null $assistantMessageId

Return Value

AgentResponse

in AgentResponse at line 80
AgentResponse then(callable $callback)

Execute a callback with this response.

Parameters

callable $callback

Return Value

AgentResponse

in ProvidesStructuredResponse at line 14
bool offsetExists(mixed $offset)

Determine if an item exists at an offset.

Parameters

mixed $offset

Return Value

bool

in ProvidesStructuredResponse at line 22
mixed offsetGet(mixed $offset)

Get an item at a given offset.

Parameters

mixed $offset

Return Value

mixed

in ProvidesStructuredResponse at line 30
void offsetSet(mixed $offset, mixed $value)

Set the item at a given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

in ProvidesStructuredResponse at line 42
void offsetUnset(mixed $offset)

Unset the item at a given offset.

Parameters

mixed $offset

Return Value

void

at line 36
array toArray()

Get the instance as an array.

Return Value

array

at line 46
string toJson(int $options = 0)

Convert the object to its JSON representation.

Parameters

int $options

Return Value

string

Exceptions

JsonException

at line 54
array jsonSerialize()

Get the JSON serializable representation of the instance.

Return Value

array