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

SummarizeAdapter.md

129 lines3.1 KB

1---
2id: SummarizeAdapter
3title: SummarizeAdapter
4---
5​
6# Interface: SummarizeAdapter\<TModel, TProviderOptions\>
7​
8Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:28](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L28)
9​
10Summarize 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 (already resolved)
18​
19## Type Parameters
20​
21### TModel
22​
23`TModel` *extends* `string` = `string`
24​
25### TProviderOptions
26​
27`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
28​
29## Properties
30​
31### ~types
32​
33```ts
34~types: object;
35```
36​
37Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:42](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L42)
38​
39**`Internal`**
40​
41Type-only properties for inference. Not assigned at runtime.
42​
43#### providerOptions
44​
45```ts
46providerOptions: TProviderOptions;
47```
48​
49***
50​
51### kind
52​
53```ts
54readonly kind: "summarize";
55```
56​
57Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L33)
58​
59Discriminator for adapter kind - used by generate() to determine API shape
60​
61***
62​
63### model
64​
65```ts
66readonly model: TModel;
67```
68​
69Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L37)
70​
71The model this adapter is configured for
72​
73***
74​
75### name
76​
77```ts
78readonly name: string;
79```
80​
81Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:35](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L35)
82​
83Adapter name identifier
84​
85***
86​
87### summarize()
88​
89```ts
90summarize: (options) => Promise<SummarizationResult>;
91```
92​
93Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:49](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L49)
94​
95Summarize the given text
96​
97#### Parameters
98​
99##### options
100​
101[`SummarizationOptions`](SummarizationOptions.md)\<`TProviderOptions`\>
102​
103#### Returns
104​
105`Promise`\<[`SummarizationResult`](SummarizationResult.md)\>
106​
107***
108​
109### summarizeStream()?
110​
111```ts
112optional summarizeStream: (options) => AsyncIterable<AGUIEvent>;
113```
114​
115Defined in: [packages/typescript/ai/src/activities/summarize/adapter.ts:58](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/summarize/adapter.ts#L58)
116​
117Stream summarization of the given text.
118Optional - if not implemented, the activity layer will fall back to
119non-streaming summarize and yield the result as a single chunk.
120​
121#### Parameters
122​
123##### options
124​
125[`SummarizationOptions`](SummarizationOptions.md)\<`TProviderOptions`\>
126​
127#### Returns
128​
129`AsyncIterable`\<[`AGUIEvent`](../type-aliases/AGUIEvent.md)\>