Skip to content

Commit f3ab518

Browse files
committed
docs(ai-chat): document HITL pause suspension and maxDuration
1 parent 4e919e7 commit f3ab518

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/ai-chat/patterns/human-in-the-loop.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Turn N:
2020
LLM streams text → calls askUser tool (no execute)
2121
streamText ends with tool-call in `input-available` state
2222
onTurnComplete fires (finishReason = "tool-calls")
23-
Agent idle
23+
Agent suspends (compute freed) — maxDuration does not tick while paused
2424
2525
Frontend:
2626
Renders question + option buttons from tool input
@@ -36,6 +36,14 @@ Turn N+1:
3636

3737
The AI SDK's `toUIMessageStream` automatically reuses the assistant message ID across the pause (we pass `originalMessages` internally), so `responseMessage` in the post-resume `onTurnComplete` is the **full merged message** — the original text, the completed tool call, and any follow-up content — not just the new parts.
3838

39+
## Duration and cost while paused
40+
41+
A pause doesn't hold compute. After the model calls a no-execute tool, the turn finishes and the run stays warm for `idleTimeoutInSeconds` (default 30s), then **suspends** and frees its compute, the same way [`wait.for`](/wait-for) does. The user's `addToolOutput` wakes it back up.
42+
43+
Because the run is suspended while it waits, the human's thinking time is not billed and does **not** count against [`maxDuration`](/runs/max-duration). `maxDuration` measures active CPU time and excludes suspended waitpoint time, exactly like `wait.for`, so a user can take minutes, hours, or days to answer without the run hitting `maxDuration`. The only time that counts is each turn's actual compute plus the short warm window before each suspend.
44+
45+
You don't need to raise `maxDuration` or end the run to support long human waits. How long a single suspended pause stays open is governed by the run's suspend timeout, not `maxDuration`; if a wait outlives it the run ends, and the next `addToolOutput` boots a fresh continuation that picks up the resolved tool result.
46+
3947
## Backend: define the tool
4048

4149
A HITL tool has an `inputSchema` describing what the model can ask, but **no `execute` function**. When the LLM calls it, `streamText` returns control to your agent.

0 commit comments

Comments
 (0)