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
Model3DResult
Defined in: packages/ai/src/types.ts:2956
Experimental
The finished 3D model.
3D model generation is experimental and may change.
Properties#
files?#
optional files?: Model3DFile[];Defined in: packages/ai/src/types.ts:2967
Experimental
The files the provider returned: every mesh with its format, and the texture files. Each file has a role when the provider tells us.
format#
format: Model3DFormat;Defined in: packages/ai/src/types.ts:2962
Experimental
File format of url
jobId#
jobId: string;Defined in: packages/ai/src/types.ts:2958
Experimental
Job identifier
previewImageUrl?#
optional previewImageUrl?: string;Defined in: packages/ai/src/types.ts:2969
Experimental
URL of a preview image of the model, when the provider makes one
url#
url: string;Defined in: packages/ai/src/types.ts:2960
Experimental
URL of the main model file. The adapter picks a GLB when there is one.
usage?#
optional usage?: TokenUsage<ProviderUsageDetails>;Defined in: packages/ai/src/types.ts:2974
Experimental
Usage information for the finished generation, when the adapter can report it. For usage-based providers (e.g. fal) this carries billed.