docs: Add a new document page for #2230 changes #2231
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| 1. When the model emits a tool call, the runner evaluates `needs_approval`. | ||
| 2. If an approval decision for that tool call is already stored in the [`RunContextWrapper`][agents.run_context.RunContextWrapper] (for example, from `always_approve=True`), the runner proceeds without prompting. Per-call approvals are scoped to the specific call ID; use `always_approve=True` to allow future calls automatically. | ||
| 3. Otherwise, execution pauses and `RunResult.interruptions` (or `RunResultStreaming.interruptions`) contains `ToolApprovalItem` entries with details such as `agent.name`, `name`, and `arguments`. | ||
| 4. Convert the result to a `RunState` with `result.to_state()`, call `state.approve(...)` or `state.reject(...)` (optionally passing `always_approve` or `always_reject`), and then resume with `Runner.run(agent, state)` or `Runner.run_streamed(agent, state)`. |
There was a problem hiding this comment.
The HITL flow here relies on RunResult.interruptions, result.to_state(), and RunState to serialize/approve/resume, but those APIs do not exist in this repo (there is no RunState class in src/agents, and RunResult lacks interruptions/to_state). As written, the documented flow and example code will fail for users because the core types and properties are missing, so the doc should either be updated to match the actual API or the referenced features need to be implemented.
Useful? React with 👍 / 👎.
This pull request adds a new document page for #2230 HITL enhancement.