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

SummarizationOptions.md

89 lines1.8 KB

1---
2id: SummarizationOptions
3title: SummarizationOptions
4---
5​
6# Interface: SummarizationOptions\<TProviderOptions\>
7​
8Defined in: [packages/ai/src/types.ts:1680](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1680)
9​
10## Type Parameters
11​
12### TProviderOptions
13​
14`TProviderOptions` *extends* `object` = `Record`\<`string`, `unknown`\>
15​
16## Properties
17​
18### focus?
19​
20```ts
21optional focus: string[];
22```
23​
24Defined in: [packages/ai/src/types.ts:1687](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1687)
25​
26***
27​
28### logger
29​
30```ts
31logger: InternalLogger;
32```
33​
34Defined in: [packages/ai/src/types.ts:1694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1694)
35​
36Internal logger threaded from the summarize() entry point. Adapters must
37call logger.request() before the SDK call and logger.errors() in catch blocks.
38​
39***
40​
41### maxLength?
42​
43```ts
44optional maxLength: number;
45```
46​
47Defined in: [packages/ai/src/types.ts:1685](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1685)
48​
49***
50​
51### model
52​
53```ts
54model: string;
55```
56​
57Defined in: [packages/ai/src/types.ts:1683](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1683)
58​
59***
60​
61### modelOptions?
62​
63```ts
64optional modelOptions: TProviderOptions;
65```
66​
67Defined in: [packages/ai/src/types.ts:1689](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1689)
68​
69Provider-specific options forwarded by the summarize() activity.
70​
71***
72​
73### style?
74​
75```ts
76optional style: "bullet-points" | "paragraph" | "concise";
77```
78​
79Defined in: [packages/ai/src/types.ts:1686](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1686)
80​
81***
82​
83### text
84​
85```ts
86text: string;
87```
88​
89Defined in: [packages/ai/src/types.ts:1684](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1684)