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
- 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
- ToolCallState
- ToolResultState
Variable References
AI/LLM: This documentation page is available in plain markdown format at/ai/latest/docs/reference/variables/CUSTOM_EVENT.md
CUSTOM_EVENT
ts
const CUSTOM_EVENT: object;Defined in: packages/ai/src/custom-events.ts:17
Well-known CUSTOM event names.
Type Declaration#
APPROVAL_REQUESTED#
ts
readonly APPROVAL_REQUESTED: "approval.requested" = 'approval.requested';APPROVAL_RESOLVED#
ts
readonly APPROVAL_RESOLVED: "approval.resolved" = 'approval.resolved';ARTIFACT_CREATED#
ts
readonly ARTIFACT_CREATED: "artifact.created" = 'artifact.created';FILE_CHANGED#
ts
readonly FILE_CHANGED: "file.changed" = 'file.changed';PORT_OPENED#
ts
readonly PORT_OPENED: "port.opened" = 'port.opened';PROCESS_STDERR#
ts
readonly PROCESS_STDERR: "process.stderr" = 'process.stderr';PROCESS_STDOUT#
ts
readonly PROCESS_STDOUT: "process.stdout" = 'process.stdout';SANDBOX_CREATED#
ts
readonly SANDBOX_CREATED: "sandbox.created" = 'sandbox.created';SANDBOX_RESUMED#
ts
readonly SANDBOX_RESUMED: "sandbox.resumed" = 'sandbox.resumed';