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`.
77 lines
2.0 KiB
Python
77 lines
2.0 KiB
Python
import json
|
|
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,
|
|
)
|
|
from openai_codex.types import (
|
|
Personality,
|
|
ReasoningSummary,
|
|
)
|
|
|
|
OUTPUT_SCHEMA = {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {"type": "string"},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {"type": "string"},
|
|
},
|
|
},
|
|
"required": ["summary", "actions"],
|
|
"additionalProperties": False,
|
|
}
|
|
|
|
SUMMARY = ReasoningSummary.model_validate("concise")
|
|
|
|
PROMPT = (
|
|
"Analyze a safe rollout plan for enabling a feature flag in production. "
|
|
"Return JSON matching the requested schema."
|
|
)
|
|
|
|
with Codex(config=runtime_config()) as codex:
|
|
thread = codex.thread_start(model="gpt-5.4", config={"model_reasoning_effort": "high"})
|
|
|
|
turn = thread.turn(
|
|
TextInput(PROMPT),
|
|
output_schema=OUTPUT_SCHEMA,
|
|
personality=Personality.pragmatic,
|
|
summary=SUMMARY,
|
|
)
|
|
result = turn.run()
|
|
structured_text = result.final_response.strip()
|
|
try:
|
|
structured = json.loads(structured_text)
|
|
except json.JSONDecodeError as exc:
|
|
raise RuntimeError(
|
|
f"Expected JSON matching OUTPUT_SCHEMA, got: {structured_text!r}"
|
|
) from exc
|
|
|
|
summary = structured["summary"]
|
|
actions = structured["actions"]
|
|
if (
|
|
not isinstance(summary, str)
|
|
or not isinstance(actions, list)
|
|
or not all(isinstance(action, str) for action in actions)
|
|
):
|
|
raise RuntimeError(
|
|
f"Expected structured output with string summary/actions, got: {structured!r}"
|
|
)
|
|
|
|
print("Status:", result.status)
|
|
print("summary:", summary)
|
|
print("actions:")
|
|
for action in actions:
|
|
print("-", action)
|
|
print("Items:", len(result.items))
|