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

ChatMiddlewareConfig.md

99 lines2.6 KB

1---
2id: ChatMiddlewareConfig
3title: ChatMiddlewareConfig
4---
5​
6# Interface: ChatMiddlewareConfig
7​
8Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:126](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L126)
9​
10Chat configuration that middleware can observe or transform.
11This is a subset of the chat engine's effective configuration
12that middleware is allowed to modify.
13​
14## Extended by
15​
16- [`StructuredOutputMiddlewareConfig`](StructuredOutputMiddlewareConfig.md)
17​
18## Properties
19​
20### maxTokens?
21​
22```ts
23optional maxTokens: number;
24```
25​
26Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:132](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L132)
27​
28***
29​
30### messages
31​
32```ts
33messages: ModelMessage<
34 | string
35 | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
36 | null>[];
37```
38​
39Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:127](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L127)
40​
41***
42​
43### metadata?
44​
45```ts
46optional metadata: Record<string, unknown>;
47```
48​
49Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:133](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L133)
50​
51***
52​
53### modelOptions?
54​
55```ts
56optional modelOptions: Record<string, unknown>;
57```
58​
59Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:134](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L134)
60​
61***
62​
63### systemPrompts
64​
65```ts
66systemPrompts: SystemPrompt[];
67```
68​
69Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:128](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L128)
70​
71***
72​
73### temperature?
74​
75```ts
76optional temperature: number;
77```
78​
79Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:130](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L130)
80​
81***
82​
83### tools
84​
85```ts
86tools: Tool<SchemaInput, SchemaInput, string>[];
87```
88​
89Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:129](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L129)
90​
91***
92​
93### topP?
94​
95```ts
96optional topP: number;
97```
98​
99Defined in: [packages/typescript/ai/src/activities/chat/middleware/types.ts:131](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/middleware/types.ts#L131)