Skip to content

Commit 6e790ca

Browse files
committed
docs: updates for #2667
1 parent d216493 commit 6e790ca

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

docs/results.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,17 @@ These surfaces answer different questions:
4545
| Property or helper | What it contains | Best for |
4646
| --- | --- | --- |
4747
| [`input`][agents.result.RunResultBase.input] | The base input for this run segment. If a handoff input filter rewrote the history, this reflects the filtered input the run continued with. | Auditing what this run actually used as input |
48-
| [`to_input_list()`][agents.result.RunResultBase.to_input_list] | A replay-ready next-turn input list built from `input` plus the converted `new_items` from this run. | Manual chat loops and client-managed conversation state |
48+
| [`to_input_list()`][agents.result.RunResultBase.to_input_list] | An input-item view of the run. The default `mode="preserve_all"` keeps the full converted history from `new_items`; `mode="normalized"` prefers canonical continuation input when handoff filtering rewrites model history. | Manual chat loops, client-managed conversation state, and plain-item history inspection |
4949
| [`new_items`][agents.result.RunResultBase.new_items] | Rich [`RunItem`][agents.items.RunItem] wrappers with agent, tool, handoff, and approval metadata. | Logs, UIs, audits, and debugging |
5050
| [`raw_responses`][agents.result.RunResultBase.raw_responses] | Raw [`ModelResponse`][agents.items.ModelResponse] objects from each model call in the run. | Provider-level diagnostics or raw response inspection |
5151

5252
In practice:
5353

54-
- Use `to_input_list()` when your application manually carries the entire conversation transcript.
54+
- Use `to_input_list()` when you want a plain input-item view of the run.
55+
- Use `to_input_list(mode="normalized")` when you want the canonical local input for the next `Runner.run(..., input=...)` call after handoff filtering or nested handoff history rewrites.
5556
- Use [`session=...`](sessions/index.md) when you want the SDK to load and save history for you.
5657
- If you are using OpenAI server-managed state with `conversation_id` or `previous_response_id`, usually pass only the new user input and reuse the stored ID instead of resending `to_input_list()`.
58+
- Use the default `to_input_list()` mode or `new_items` when you need the full converted history for logs, UIs, or audits.
5759

5860
Unlike the JavaScript SDK, Python does not expose a separate `output` property for the model-shaped delta only. Use `new_items` when you need SDK metadata, or inspect `raw_responses` when you need the raw model payloads.
5961

0 commit comments

Comments
 (0)