0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/ExtendedModelDef.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

2.1 KiB

id title
ExtendedModelDef ExtendedModelDef

Interface: ExtendedModelDef<TName, TInput, TOptions, TFeatures, TTools>

Defined in: packages/ai/src/extend-adapter.ts:21

Definition for a custom model to add to an adapter.

Example

const customModels = [
  createModel('my-custom-model', ['text', 'image']),
] as const

Type Parameters

TName

TName extends string = string

The model name as a literal string type

TInput

TInput extends ReadonlyArray<Modality> = ReadonlyArray<Modality>

Array of supported input modalities

TOptions

TOptions = unknown

Provider options type for this model

TFeatures

TFeatures extends ReadonlyArray<string> = ReadonlyArray<string>

TTools

TTools extends ReadonlyArray<string> = ReadonlyArray<string>

Properties

features?

optional features?: TFeatures;

Defined in: packages/ai/src/extend-adapter.ts:35

Optional declared features (e.g. 'reasoning', 'structured_outputs')


input

input: TInput;

Defined in: packages/ai/src/extend-adapter.ts:31

Supported input modalities for this model


modelOptions

modelOptions: TOptions;

Defined in: packages/ai/src/extend-adapter.ts:33

Type brand for provider options - use {} as YourOptionsType


name

name: TName;

Defined in: packages/ai/src/extend-adapter.ts:29

The model name identifier


tools?

optional tools?: TTools;

Defined in: packages/ai/src/extend-adapter.ts:37

Optional declared provider tools (e.g. 'web_search')