mirror of
https://github.com/openai/codex.git
synced 2026-05-20 11:12:43 +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`.
44 lines
1.1 KiB
Python
44 lines
1.1 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,
|
|
temporary_sample_image_path,
|
|
)
|
|
|
|
ensure_local_sdk_src()
|
|
|
|
import asyncio
|
|
|
|
from openai_codex import AsyncCodex, LocalImageInput, TextInput
|
|
|
|
|
|
async def main() -> None:
|
|
with temporary_sample_image_path() as image_path:
|
|
async with AsyncCodex(config=runtime_config()) as codex:
|
|
thread = await codex.thread_start(
|
|
model="gpt-5.4", config={"model_reasoning_effort": "high"}
|
|
)
|
|
|
|
turn = await thread.turn(
|
|
[
|
|
TextInput(
|
|
"Read this generated local image and summarize the colors/layout in 2 bullets."
|
|
),
|
|
LocalImageInput(str(image_path.resolve())),
|
|
]
|
|
)
|
|
result = await turn.run()
|
|
|
|
print("Status:", result.status)
|
|
print(result.final_response)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
asyncio.run(main())
|