# BaseModel3DAdapter

<!-- DO NOT EDIT: this page is autogenerated from the type comments -->

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L122)

**`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`](../type-aliases/ModelInputModalitiesByName.md) = [`ModelInputModalitiesByName`](../type-aliases/ModelInputModalitiesByName.md)

## Implements

- [`Model3DAdapter`](../interfaces/Model3DAdapter.md)\<`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](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L148)

**`Experimental`**

#### Parameters

##### config?

[`Model3DAdapterConfig`](../interfaces/Model3DAdapterConfig.md) = `{}`

##### model

`TModel`

#### Returns

`BaseModel3DAdapter`\<`TModel`, `TProviderOptions`, `TModelProviderOptionsByName`, `TModelInputModalitiesByName`\>

## Properties

### ~types

```ts
~types: object;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L140)

**`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`](../interfaces/Model3DAdapter.md).[`~types`](../interfaces/Model3DAdapter.md#types)

***

### config

```ts
protected config: Model3DAdapterConfig;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L146)

**`Experimental`**

***

### kind

```ts
readonly kind: "3dModel";
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L134)

**`Experimental`**

Discriminator for adapter kind - used to determine API shape

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`kind`](../interfaces/Model3DAdapter.md#kind)

***

### model

```ts
readonly model: TModel;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L137)

**`Experimental`**

The model this adapter is configured for

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`model`](../interfaces/Model3DAdapter.md#model)

***

### name

```ts
abstract readonly name: string;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L135)

**`Experimental`**

Adapter name identifier

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`name`](../interfaces/Model3DAdapter.md#name)

***

### supportsFileSources

```ts
readonly supportsFileSources: boolean = false;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L136)

**`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`](../interfaces/Model3DAdapter.md).[`supportsFileSources`](../interfaces/Model3DAdapter.md#supportsfilesources)

## Methods

### create3DModelJob()

```ts
abstract create3DModelJob(options): Promise<Model3DJobResult>;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:153](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L153)

**`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`](../interfaces/Model3DGenerationOptions.md)\<`TProviderOptions`\>

#### Returns

`Promise`\<[`Model3DJobResult`](../interfaces/Model3DJobResult.md)\>

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`create3DModelJob`](../interfaces/Model3DAdapter.md#create3dmodeljob)

***

### generateId()

```ts
protected generateId(): string;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:168](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L168)

**`Experimental`**

#### Returns

`string`

***

### get3DModel()

```ts
abstract get3DModel(jobId, options?): Promise<Model3DResult>;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:163](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L163)

**`Experimental`**

See [Model3DAdapter.get3DModel](../interfaces/Model3DAdapter.md#get3dmodel).

#### Parameters

##### jobId

`string`

##### options?

###### abortSignal?

`AbortSignal`

#### Returns

`Promise`\<[`Model3DResult`](../interfaces/Model3DResult.md)\>

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`get3DModel`](../interfaces/Model3DAdapter.md#get3dmodel)

***

### get3DModelStatus()

```ts
abstract get3DModelStatus(jobId, options?): Promise<Model3DStatusResult>;
```

Defined in: [packages/ai/src/activities/generate3DModel/adapter.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generate3DModel/adapter.ts#L157)

**`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`](../interfaces/Model3DStatusResult.md)\>

#### Implementation of

[`Model3DAdapter`](../interfaces/Model3DAdapter.md).[`get3DModelStatus`](../interfaces/Model3DAdapter.md#get3dmodelstatus)
