Vercel.AI.Prompt

Public types in the Vercel.AI.Prompt namespace.

Classes

Type	Summary
ContentToolModelOutput	Multi-part tool output.
DataUrlParts	Media type and base64 payload from a data URL. Maps to splitDataUrl.
DataUrls	Data URL parsing. Maps to splitDataUrl.
ErrorJsonToolModelOutput	Error JSON tool output.
ErrorTextToolModelOutput	Error text tool output.
FilePartInput	A file-part value before it is converted to the v4 provider shape.
FileParts	File-part conversion. Maps to convertToLanguageModelV4FilePart.
Instructions	Instructions for a call: a string, one system message, or a list of system messages. Maps to Instructions. A single system message is kept as a one-item Messages list.
InvalidDataContentException	File content could not be converted. Maps to InvalidDataContentError.
InvalidPromptException	The prompt input is invalid. Maps to InvalidPromptError.
JsonToolModelOutput	JSON tool output.
LanguageModelFilePart	A file part in the v4 provider prompt. Maps to the result of convertToLanguageModelV4FilePart.
PreparedTool	A tool after String).
PreparedToolChoice	A tool choice sent to a language model. Maps to the result of prepareToolChoice.
PreservedStreamError	An error-shaped value that must be returned unchanged.
PromptInput	The prompt of a call: a user string or a list of messages. Maps to prompt: string \| ModelMessage[].
Prompts	Prompt normalization. Maps to standardizePrompt.
PromptTool	A tool passed to String).
PromptTools	Tool preparation. Maps to prepareTools.
ProviderStreamError	A provider stream payload that already carries status metadata.
StandardizedPrompt	A standardized prompt. Maps to the result of standardizePrompt.
StandardizePromptInput	Input for StandardizePrompt(StandardizePromptInput).
StreamErrors	Normalizes provider stream failures. Maps to normalizeStreamProviderError.
StreamProviderError	A normalized stream provider error. Maps to StreamProviderError.
TextToolModelOutput	Text tool output.
TimeoutConfiguration	Timeout configuration for GenerateTextAsync and StreamTextAsync. Maps to TimeoutConfiguration. Upstream takes a number (the total timeout in milliseconds) or an object. A TimeSpan converts to the total timeout, as the number form does upstream. An expired timeout aborts the call with a TimeoutError reason.
ToolChoices	Tool-choice normalization. Maps to prepareToolChoice.
ToolDescriptionContext	Context passed to a function-valued tool description.
ToolModelContentPart	One content part inside a content tool output.
ToolModelOutput	A tool result sent back to the model. Maps to ToolResultOutput.
ToolModelOutputCall	Arguments passed to toModelOutput.
ToolOutputs	Builds the model-facing tool result. Maps to createToolModelOutput.
ToolOutputs.Undefined	Sentinel for an undefined tool output.

Interfaces

Type	Summary
IToolJsonValue	A value that supplies its own JSON form, matching JavaScript toJSON.