Skip to content

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

ts
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

ts
~types: object;

Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:140

Internal

Type-only properties for inference. Not assigned at runtime.

modelInputModalitiesByName

ts
modelInputModalitiesByName: TModelInputModalitiesByName;

modelProviderOptionsByName

ts
modelProviderOptionsByName: TModelProviderOptionsByName;

providerOptions

ts
providerOptions: TProviderOptions;

Implementation of

Model3DAdapter.~types


config

ts
protected config: Model3DAdapterConfig;

Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:146

Experimental


kind

ts
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

Model3DAdapter.kind


model

ts
readonly model: TModel;

Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:137

Experimental

The model this adapter is configured for

Implementation of

Model3DAdapter.model


name

ts
abstract readonly name: string;

Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:135

Experimental

Adapter name identifier

Implementation of

Model3DAdapter.name


supportsFileSources

ts
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()

ts
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()

ts
protected generateId(): string;

Defined in: packages/ai/src/activities/generate3DModel/adapter.ts:168

Experimental

Returns

string


get3DModel()

ts
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

Model3DAdapter.get3DModel


get3DModelStatus()

ts
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>

Implementation of

Model3DAdapter.get3DModelStatus