AI Docs
API
Class References
Function References
- text
- textOptions
- combineStrategies
- convertMessagesToModelMessages
- convertZodToJsonSchema
- createReplayStream
- embedding
- generateMessageId
- maxIterations
- messages
- modelMessageToUIMessage
- modelMessagesToUIMessages
- normalizeToUIMessage
- parsePartialJSON
- summarize
- toServerSentEventsStream
- toServerSentEventsResponse
- toolDefinition
- uiMessageToModelMessages
- realtimeToken
- untilFinishReason
Interface References
- AIAdapter
- AIAdapterConfig
- AgentLoopState
- ApprovalRequestedStreamChunk
- AudioPart
- AudioVisualization
- BaseStreamChunk
- TextCompletionChunk
- TextOptions
- ChunkRecording
- ChunkStrategy
- ClientTool
- ContentPartSource
- ContentStreamChunk
- DefaultMessageMetadataByModality
- DocumentPart
- DoneStreamChunk
- EmbeddingOptions
- EmbeddingResult
- ErrorStreamChunk
- ImagePart
- InternalToolCallState
- JSONParser
- ModelMessage
- ProcessorResult
- ProcessorState
- RealtimeAdapter
- RealtimeClientOptions
- RealtimeConnection
- RealtimeMessage
- RealtimeSessionConfig
- RealtimeToken
- RealtimeTokenAdapter
- RealtimeTokenOptions
- ResponseFormat
- ServerTool
- StreamProcessorEvents
- StreamProcessorHandlers
- StreamProcessorOptions
- SummarizationOptions
- SummarizationResult
- TextPart
- ThinkingPart
- ThinkingStreamChunk
- Tool
- ToolCall
- ToolCallPart
- ToolCallStreamChunk
- ToolConfig
- ToolDefinition
- ToolDefinitionConfig
- ToolDefinitionInstance
- ToolInputAvailableStreamChunk
- ToolResultPart
- ToolResultStreamChunk
- UIMessage
- VideoPart
Type Alias References
- AgentLoopStrategy
- AnyClientTool
- TextStreamOptionsForModel
- TextStreamOptionsUnion
- ConstrainedContent
- ConstrainedModelMessage
- ContentPart
- ContentPartForModalities
- ExtractModalitiesForModel
- ExtractModelsFromAdapter
- InferToolInput
- InferToolName
- InferToolOutput
- MessagePart
- RealtimeEvent
- RealtimeMessagePart
- RealtimeMode
- RealtimeStatus
- ModalitiesArrayToUnion
- Modality
- StreamChunk
- StreamChunkType
- ToolCallState
- ToolResultState
Variable References
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference/interfaces/ToolResultPart.md
Interface References
ToolResultPart
Defined in: packages/ai/src/types.ts:524
Properties#
content#
ts
content:
| string
| ContentPart<unknown, unknown, unknown, unknown, unknown>[];Defined in: packages/ai/src/types.ts:529
createdAt?#
ts
optional createdAt?: Date;Defined in: packages/ai/src/types.ts:535
error?#
ts
optional error?: string;Defined in: packages/ai/src/types.ts:533
id?#
ts
optional id?: string;Defined in: packages/ai/src/types.ts:526
metadata?#
ts
optional metadata?: Record<string, unknown>;Defined in: packages/ai/src/types.ts:534
name?#
ts
optional name?: string;Defined in: packages/ai/src/types.ts:527
outcome?#
ts
optional outcome?: ToolResultOutcome;Defined in: packages/ai/src/types.ts:532
Set when the user or middleware cancelled or denied the tool call; state remains error.
state#
ts
state: ToolResultState;Defined in: packages/ai/src/types.ts:530
toolCallId#
ts
toolCallId: string;Defined in: packages/ai/src/types.ts:528
type#
ts
type: "tool-result";Defined in: packages/ai/src/types.ts:525