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

TextAdapter.md

155 lines3.5 KB

1---
2id: TextAdapter
3title: TextAdapter
4---
5​
6# Interface: TextAdapter\<TModel, TProviderOptions, TInputModalities, TMessageMetadataByModality\>
7​
8Defined in: [activities/chat/adapter.ts:52](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L52)
9​
10Text adapter interface with pre-resolved generics.
11​
12An adapter is created by a provider function: `provider('model')` → `adapter`
13All type resolution happens at the provider call site, not in this interface.
14​
15Generic parameters:
16- TModel: The specific model name (e.g., 'gpt-4o')
17- TProviderOptions: Provider-specific options for this model (already resolved)
18- TInputModalities: Supported input modalities for this model (already resolved)
19- TMessageMetadata: Metadata types for content parts (already resolved)
20​
21## Type Parameters
22​
23### TModel
24​
25`TModel` *extends* `string`
26​
27### TProviderOptions
28​
29`TProviderOptions` *extends* `Record`\<`string`, `any`\>
30​
31### TInputModalities
32​
33`TInputModalities` *extends* `ReadonlyArray`\<[`Modality`](../type-aliases/Modality.md)\>
34​
35### TMessageMetadataByModality
36​
37`TMessageMetadataByModality` *extends* [`DefaultMessageMetadataByModality`](DefaultMessageMetadataByModality.md)
38​
39## Properties
40​
41### ~types
42​
43```ts
44~types: object;
45```
46​
47Defined in: [activities/chat/adapter.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L68)
48​
49**`Internal`**
50​
51Type-only properties for inference. Not assigned at runtime.
52​
53#### inputModalities
54​
55```ts
56inputModalities: TInputModalities;
57```
58​
59#### messageMetadataByModality
60​
61```ts
62messageMetadataByModality: TMessageMetadataByModality;
63```
64​
65#### providerOptions
66​
67```ts
68providerOptions: TProviderOptions;
69```
70​
71***
72​
73### chatStream()
74​
75```ts
76chatStream: (options) => AsyncIterable<StreamChunk>;
77```
78​
79Defined in: [activities/chat/adapter.ts:77](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L77)
80​
81Stream text completions from the model
82​
83#### Parameters
84​
85##### options
86​
87[`TextOptions`](TextOptions.md)\<`TProviderOptions`\>
88​
89#### Returns
90​
91`AsyncIterable`\<[`StreamChunk`](../type-aliases/StreamChunk.md)\>
92​
93***
94​
95### kind
96​
97```ts
98readonly kind: "text";
99```
100​
101Defined in: [activities/chat/adapter.ts:59](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L59)
102​
103Discriminator for adapter kind
104​
105***
106​
107### model
108​
109```ts
110readonly model: TModel;
111```
112​
113Defined in: [activities/chat/adapter.ts:63](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L63)
114​
115The model this adapter is configured for
116​
117***
118​
119### name
120​
121```ts
122readonly name: string;
123```
124​
125Defined in: [activities/chat/adapter.ts:61](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L61)
126​
127Provider name identifier (e.g., 'openai', 'anthropic')
128​
129***
130​
131### structuredOutput()
132​
133```ts
134structuredOutput: (options) => Promise<StructuredOutputResult<unknown>>;
135```
136​
137Defined in: [activities/chat/adapter.ts:89](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/adapter.ts#L89)
138​
139Generate structured output using the provider's native structured output API.
140This method uses stream: false and sends the JSON schema to the provider
141to ensure the response conforms to the expected structure.
142​
143#### Parameters
144​
145##### options
146​
147`StructuredOutputOptions`\<`TProviderOptions`\>
148​
149Structured output options containing chat options and JSON schema
150​
151#### Returns
152​
153`Promise`\<`StructuredOutputResult`\<`unknown`\>\>
154​
155Promise with the raw data (validation is done in the chat function)