class Vercel

Methods

static Chat
chat(Request|iterable $input)

Create a chat instance from a useChat request or its UI message list.

static array
toUiMessages(iterable $messages)

Convert messages or conversation message models into UI message arrays for hydrating useChat.

static array
uiPartsFrom(Message|ConversationMessage $message)

Create the UI message parts for a single message.

static void
applyUiToolOutput(array $result, array $partRefs, string $id, mixed $output, bool $denied)

Settle a hydrated tool part with its result, wherever the call was rendered.

static void
applyUiToolError(array $result, array $partRefs, string $id, mixed $error)

Settle a hydrated tool part with its failure text.

static Collection
attachmentsFrom(Message|ConversationMessage $message)

Get a message's attachments as file instances.

static iterable
toolCallArraysFrom(Message|ConversationMessage $message)

Get a message's tool calls as their array representations.

static array|null
uiFilePartFrom(File $file)

Create a UI message file part from a file instance.

static array
fromUiMessages(iterable $messages)

Create messages from a list of Vercel AI SDK UI messages (a useChat request body).

static Message
fromUiMessage(array $message)

Create a message from a single Vercel AI SDK UI message (parts-based) array.

static Collection
toolResultsFrom(array $message)

Create tool results from a UI message's settled tool parts.

static array
approvalResponsesFrom(array $message)

Get the tool approval responses awaiting execution on a UI message, keyed by tool call id.

static Collection
toolParts(iterable $parts)

Filter the given parts down to the tool parts.

static string
toolName(array $part)

Get the tool name encoded in a UI tool part's type.

static File|null
fileFrom(array $part)

Create a file instance from a Vercel AI SDK UI message file part.

static File|null
fileFromDataUrl(string $url, string $mime)

Create a base64 file instance from a data URL.

Details

at line 37
static Chat chat(Request|iterable $input)

Create a chat instance from a useChat request or its UI message list.

Parameters

Request|iterable $input

Return Value

Chat

at line 50
static array toUiMessages(iterable $messages)

Convert messages or conversation message models into UI message arrays for hydrating useChat.

Parameters

iterable $messages

Return Value

array

at line 108
static protected array uiPartsFrom(Message|ConversationMessage $message)

Create the UI message parts for a single message.

Parameters

Message|ConversationMessage $message

Return Value

array

at line 161
static protected void applyUiToolOutput(array $result, array $partRefs, string $id, mixed $output, bool $denied)

Settle a hydrated tool part with its result, wherever the call was rendered.

Parameters

array $result
array $partRefs
string $id
mixed $output
bool $denied

Return Value

void

at line 186
static protected void applyUiToolError(array $result, array $partRefs, string $id, mixed $error)

Settle a hydrated tool part with its failure text.

Parameters

array $result
array $partRefs
string $id
mixed $error

Return Value

void

at line 204
static protected Collection attachmentsFrom(Message|ConversationMessage $message)

Get a message's attachments as file instances.

Parameters

Message|ConversationMessage $message

Return Value

Collection

at line 221
static protected iterable toolCallArraysFrom(Message|ConversationMessage $message)

Get a message's tool calls as their array representations.

Parameters

Message|ConversationMessage $message

Return Value

iterable

at line 235
static protected array|null uiFilePartFrom(File $file)

Create a UI message file part from a file instance.

Parameters

File $file

Return Value

array|null

at line 266
static array fromUiMessages(iterable $messages)

Create messages from a list of Vercel AI SDK UI messages (a useChat request body).

Parameters

iterable $messages

Return Value

array

at line 292
static Message fromUiMessage(array $message)

Create a message from a single Vercel AI SDK UI message (parts-based) array.

Parameters

array $message

Return Value

Message

at line 321
static protected Collection toolResultsFrom(array $message)

Create tool results from a UI message's settled tool parts.

Parameters

array $message

Return Value

Collection

at line 342
static array approvalResponsesFrom(array $message)

Get the tool approval responses awaiting execution on a UI message, keyed by tool call id.

Parameters

array $message

Return Value

array

at line 358
static protected Collection toolParts(iterable $parts)

Filter the given parts down to the tool parts.

Parameters

iterable $parts

Return Value

Collection

at line 371
static protected string toolName(array $part)

Get the tool name encoded in a UI tool part's type.

Parameters

array $part

Return Value

string

at line 381
static protected File|null fileFrom(array $part)

Create a file instance from a Vercel AI SDK UI message file part.

Parameters

array $part

Return Value

File|null

at line 410
static protected File|null fileFromDataUrl(string $url, string $mime)

Create a base64 file instance from a data URL.

Parameters

string $url
string $mime

Return Value

File|null