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
Model3DGenerationOptions
Defined in: packages/ai/src/types.ts:2877
Experimental
Options that the 3D model activity gives to an adapter when it creates a job.
3D model generation is experimental and may change.
Type Parameters#
TProviderOptions#
TProviderOptions extends object = object
Properties#
abortSignal?#
optional abortSignal?: AbortSignal;Defined in: packages/ai/src/types.ts:2901
Experimental
Abort signal made by the activity from the caller abortSignal and/or timeout. Adapters should give it to the provider SDK when the SDK supports it. It is for this request only. Never store it on a client config.
logger#
logger: InternalLogger;Defined in: packages/ai/src/types.ts:2895
Experimental
Internal logger from the generate3DModel() 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:2881
Experimental
The model to use for 3D model generation
modelOptions?#
optional modelOptions?: TProviderOptions;Defined in: packages/ai/src/types.ts:2890
Experimental
Model-specific options for 3D model generation
prompt#
prompt: MediaPrompt;Defined in: packages/ai/src/types.ts:2888
Experimental
What to make: a plain string for text-to-3D, or an ordered array of text, image, and model3d parts. Adapters route the image and mesh parts to the provider request fields, and throw at runtime when the model cannot use a part.