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
WorldGenerationOptions
Defined in: packages/ai/src/types.ts:2658
Experimental
Options for world generation (live session or finished job).
World generation is an experimental feature and may change.
Type Parameters#
TProviderOptions#
TProviderOptions extends object = object
Properties#
abortSignal?#
optional abortSignal?: AbortSignal;Defined in: packages/ai/src/types.ts:2683
Experimental
Effective abort signal composed by the activity from caller abortSignal and/or timeout. Adapters should forward this to the provider SDK when supported. Request-specific — never store on a global client config.
logger#
logger: InternalLogger;Defined in: packages/ai/src/types.ts:2677
Experimental
Internal logger threaded from the generateWorld() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.
model#
model: string;Defined in: packages/ai/src/types.ts:2662
Experimental
The model to use for world generation
modelOptions?#
optional modelOptions?: TProviderOptions;Defined in: packages/ai/src/types.ts:2671
Experimental
Provider-specific options. Live adapters (Reactor) use mint fields here. Job adapters (World Labs) use image/video inputs, wait, and poll. Reactor resolution/seed/audio are browser sendCommand fields, not token-mint fields.
prompt#
prompt: string;Defined in: packages/ai/src/types.ts:2664
Experimental
Natural-language description of the world or scene