mirror of
https://github.com/openai/codex.git
synced 2026-05-21 03:33:41 +00:00
f0166cadbb
## Why
`TurnHandle.run()` returned the raw app-server `Turn`, whose live
start/completed payloads do not include loaded `items`, so users saw
empty `items` after starting a turn. That made the handle-based path
behave differently from `Thread.run(...)`, and pushed examples toward
persisted-thread reads plus helper extraction.
This PR makes the run APIs standalone: starting a turn and running it
returns collected turn data directly, or fails visibly when required
stream events are missing.
## What Changed
- Replaces the public `RunResult` export with `TurnResult`.
- Adds turn metadata to `TurnResult`: `id`, `status`, `error`,
`started_at`, `completed_at`, and `duration_ms`, alongside
`final_response`, `items`, and `usage`.
- Changes `TurnHandle.run()` and `AsyncTurnHandle.run()` to consume
stream events with the same collector used by `Thread.run(...)`.
- Exports `TurnError` from `openai_codex.types` for the new result
shape.
- Updates tests, examples, docs, and the walkthrough notebook to use
`result.final_response` and `result.items` directly.
- Removes persisted-thread helper paths and placeholder/skipped control
flows from the public examples and notebook.
## Verification
- `python3 -m py_compile ...` over changed SDK, example, and test Python
files.
- `python3 -c "import json;
json.load(open('sdk/python/notebooks/sdk_walkthrough.ipynb'))"`
- `git diff --check`
- `PYTHONPATH=sdk/python/src python3 -c ...` import/signature smoke for
`TurnResult`, `TurnHandle.run`, and `AsyncTurnHandle.run`.
64 lines
2.4 KiB
Python
64 lines
2.4 KiB
Python
import sys
|
|
from pathlib import Path
|
|
|
|
_EXAMPLES_ROOT = Path(__file__).resolve().parents[1]
|
|
if str(_EXAMPLES_ROOT) not in sys.path:
|
|
sys.path.insert(0, str(_EXAMPLES_ROOT))
|
|
|
|
from _bootstrap import ensure_local_sdk_src, runtime_config
|
|
|
|
ensure_local_sdk_src()
|
|
|
|
from openai_codex import Codex, TextInput
|
|
|
|
with Codex(config=runtime_config()) as codex:
|
|
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})
|
|
steer_turn = thread.turn(
|
|
TextInput("Count from 1 to 40 with commas, then one summary sentence.")
|
|
)
|
|
steer_result = steer_turn.steer(TextInput("Keep it brief and stop after 10 numbers."))
|
|
|
|
steer_event_count = 0
|
|
steer_completed_status = None
|
|
steer_deltas = []
|
|
for event in steer_turn.stream():
|
|
steer_event_count += 1
|
|
if event.method == "item/agentMessage/delta":
|
|
steer_deltas.append(event.payload.delta)
|
|
continue
|
|
if event.method == "turn/completed":
|
|
steer_completed_status = event.payload.turn.status.value
|
|
|
|
if steer_completed_status is None:
|
|
raise RuntimeError("stream ended without turn/completed")
|
|
steer_preview = "".join(steer_deltas).strip()
|
|
|
|
interrupt_turn = thread.turn(
|
|
TextInput("Count from 1 to 200 with commas, then one summary sentence.")
|
|
)
|
|
interrupt_result = interrupt_turn.interrupt()
|
|
|
|
interrupt_event_count = 0
|
|
interrupt_completed_status = None
|
|
interrupt_deltas = []
|
|
for event in interrupt_turn.stream():
|
|
interrupt_event_count += 1
|
|
if event.method == "item/agentMessage/delta":
|
|
interrupt_deltas.append(event.payload.delta)
|
|
continue
|
|
if event.method == "turn/completed":
|
|
interrupt_completed_status = event.payload.turn.status.value
|
|
|
|
if interrupt_completed_status is None:
|
|
raise RuntimeError("stream ended without turn/completed")
|
|
interrupt_preview = "".join(interrupt_deltas).strip()
|
|
|
|
print("steer.result:", steer_result.model_dump(mode="json", by_alias=True))
|
|
print("steer.final.status:", steer_completed_status)
|
|
print("steer.events.count:", steer_event_count)
|
|
print("steer.assistant.preview:", steer_preview)
|
|
print("interrupt.result:", interrupt_result.model_dump(mode="json", by_alias=True))
|
|
print("interrupt.final.status:", interrupt_completed_status)
|
|
print("interrupt.events.count:", interrupt_event_count)
|
|
print("interrupt.assistant.preview:", interrupt_preview)
|