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
BaseModel3DAdapter
Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:122
Experimental
Abstract base class for 3D model generation adapters. Extend this class to implement a 3D model adapter for a specific provider.
Generic parameters match Model3DAdapter - all pre-resolved by the provider function.
3D model generation is experimental and may change.
Type Parameters#
TModel#
TModel extends string = string
TProviderOptions#
TProviderOptions extends object = Record<string, unknown>
TModelProviderOptionsByName#
TModelProviderOptionsByName extends Record<string, any> = Record<string, any>
TModelInputModalitiesByName#
TModelInputModalitiesByName extends ModelInputModalitiesByName = ModelInputModalitiesByName
Implements#
- Model3DAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName>
Constructors#
Constructor#
new BaseModel3DAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName>(config?, model): BaseModel3DAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName>;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:148
Experimental
Parameters#
config?#
Model3DAdapterConfig = {}
model#
TModel
Returns#
BaseModel3DAdapter<TModel, TProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName>
Properties#
~types#
~types: object;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:140
Internal
Type-only properties for inference. Not assigned at runtime.
modelInputModalitiesByName#
modelInputModalitiesByName: TModelInputModalitiesByName;modelProviderOptionsByName#
modelProviderOptionsByName: TModelProviderOptionsByName;providerOptions#
providerOptions: TProviderOptions;Implementation of#
config#
protected config: Model3DAdapterConfig;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:146
Experimental
kind#
readonly kind: "3dModel";Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:134
Experimental
Discriminator for adapter kind - used to determine API shape
Implementation of#
model#
readonly model: TModel;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:137
Experimental
The model this adapter is configured for
Implementation of#
name#
abstract readonly name: string;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:135
Experimental
Adapter name identifier
Implementation of#
supportsFileSources#
readonly supportsFileSources: boolean = false;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:136
Experimental
Declares that this adapter can consume { type: 'file' } content sources (provider Files API references). The activity rejects file sources before the request for adapters that do not declare this.
Implementation of#
Model3DAdapter.supportsFileSources
Methods#
create3DModelJob()#
abstract create3DModelJob(options): Promise<Model3DJobResult>;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:153
Experimental
Create a new 3D model generation job. Returns a job ID to poll the status and to read the finished model.
Parameters#
options#
Model3DGenerationOptions<TProviderOptions>
Returns#
Promise<Model3DJobResult>
Implementation of#
Model3DAdapter.create3DModelJob
generateId()#
protected generateId(): string;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:168
Experimental
Returns#
string
get3DModel()#
abstract get3DModel(jobId, options?): Promise<Model3DResult>;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:163
Experimental
See Model3DAdapter.get3DModel.
Parameters#
jobId#
string
options?#
abortSignal?#
AbortSignal
Returns#
Promise<Model3DResult>
Implementation of#
get3DModelStatus()#
abstract get3DModelStatus(jobId, options?): Promise<Model3DStatusResult>;Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:157
Experimental
Get the current status of a 3D model generation job. Adapters should give options.abortSignal to the provider request when supported.
Parameters#
jobId#
string
options?#
abortSignal?#
AbortSignal
Returns#
Promise<Model3DStatusResult>