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

untilFinishReason.md

40 lines860 Bytes

1---
2id: untilFinishReason
3title: untilFinishReason
4---
5​
6# Function: untilFinishReason()
7​
8```ts
9function untilFinishReason(stopReasons): AgentLoopStrategy;
10```
11​
12Defined in: [packages/typescript/ai/src/activities/chat/agent-loop-strategies.ts:41](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/activities/chat/agent-loop-strategies.ts#L41)
13​
14Creates a strategy that continues until a specific finish reason is encountered
15​
16## Parameters
17​
18### stopReasons
19​
20`string`[]
21​
22Finish reasons that should stop the loop
23​
24## Returns
25​
26[`AgentLoopStrategy`](../type-aliases/AgentLoopStrategy.md)
27​
28AgentLoopStrategy that stops on specific finish reasons
29​
30## Example
31​
32```typescript
33const stream = chat({
34 adapter: openaiText(),
35 model: "gpt-4o",
36 messages: [...],
37 tools: [weatherTool],
38 agentLoopStrategy: untilFinishReason(["stop", "length"]),
39});
40```