Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ExtendedModelDef.md

74 lines1.5 KB

Interface: ExtendedModelDef<TName, TInput, TOptions>

Defined in: packages/typescript/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

Properties

input

input: TInput;

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

Supported input modalities for this model


modelOptions

modelOptions: TOptions;

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

Type brand for provider options - use {} as YourOptionsType


name

name: TName;

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

The model name identifier