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

ExtendedModelDef.md

106 lines2.1 KB

1---
2id: ExtendedModelDef
3title: ExtendedModelDef
4---
5​
6# Interface: ExtendedModelDef\<TName, TInput, TOptions, TFeatures, TTools\>
7​
8Defined in: [packages/ai/src/extend-adapter.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L21)
9​
10Definition for a custom model to add to an adapter.
11​
12## Example
13​
14```typescript
15const customModels = [
16 createModel('my-custom-model', ['text', 'image']),
17] as const
18```
19​
20## Type Parameters
21​
22### TName
23​
24`TName` *extends* `string` = `string`
25​
26The model name as a literal string type
27​
28### TInput
29​
30`TInput` *extends* `ReadonlyArray`\<[`Modality`](../type-aliases/Modality.md)\> = `ReadonlyArray`\<[`Modality`](../type-aliases/Modality.md)\>
31​
32Array of supported input modalities
33​
34### TOptions
35​
36`TOptions` = `unknown`
37​
38Provider options type for this model
39​
40### TFeatures
41​
42`TFeatures` *extends* `ReadonlyArray`\<`string`\> = `ReadonlyArray`\<`string`\>
43​
44### TTools
45​
46`TTools` *extends* `ReadonlyArray`\<`string`\> = `ReadonlyArray`\<`string`\>
47​
48## Properties
49​
50### features?
51​
52```ts
53optional features: TFeatures;
54```
55​
56Defined in: [packages/ai/src/extend-adapter.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L35)
57​
58Optional declared features (e.g. 'reasoning', 'structured_outputs')
59​
60***
61​
62### input
63​
64```ts
65input: TInput;
66```
67​
68Defined in: [packages/ai/src/extend-adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L31)
69​
70Supported input modalities for this model
71​
72***
73​
74### modelOptions
75​
76```ts
77modelOptions: TOptions;
78```
79​
80Defined in: [packages/ai/src/extend-adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L33)
81​
82Type brand for provider options - use `{} as YourOptionsType`
83​
84***
85​
86### name
87​
88```ts
89name: TName;
90```
91​
92Defined in: [packages/ai/src/extend-adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L29)
93​
94The model name identifier
95​
96***
97​
98### tools?
99​
100```ts
101optional tools: TTools;
102```
103​
104Defined in: [packages/ai/src/extend-adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L37)
105​
106Optional declared provider tools (e.g. 'web_search')