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

createChatOptions.md

51 lines1.1 KB

1---
2id: createChatOptions
3title: createChatOptions
4---
5​
6# Function: createChatOptions()
7​
8```ts
9function createChatOptions<TAdapter, TSchema, TStream>(options): TextActivityOptions<TAdapter, TSchema, TStream>;
10```
11​
12Defined in: [activities/chat/index.ts:141](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/index.ts#L141)
13​
14Create typed options for the chat() function without executing.
15This is useful for pre-defining configurations with full type inference.
16​
17## Type Parameters
18​
19### TAdapter
20​
21`TAdapter` *extends* [`AnyTextAdapter`](../type-aliases/AnyTextAdapter.md)
22​
23### TSchema
24​
25`TSchema` *extends*
26 \| `ZodType`\<`unknown`, `unknown`, `$ZodTypeInternals`\<`unknown`, `unknown`\>\>
27 \| `undefined` = `undefined`
28​
29### TStream
30​
31`TStream` *extends* `boolean` = `true`
32​
33## Parameters
34​
35### options
36​
37`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`\>
38​
39## Returns
40​
41`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`\>
42​
43## Example
44​
45```ts
46const chatOptions = createChatOptions({
47 adapter: anthropicText('claude-sonnet-4-5'),
48})
49​
50const stream = chat({ ...chatOptions, messages })
51```