mirror of
https://github.com/openai/codex.git
synced 2026-09-11 20:36:49 +00:00
1ac689cc7d
## Why Remote compaction already uses the normal Responses API, leaving the legacy `/responses/compact` runner unused. ## What changed - Remove the legacy runner, endpoint client, request types, analytics variant, and obsolete test helpers and snapshots. - Move tool-output trimming and its metadata tests into `compact_remote_history` for reuse by remote compaction v2. - Consolidate retained-history filtering in the v2 implementation and remove redundant `RemoteCompactionV2` settings from tests. ## Testing Extend the retained-history unit test to explicitly check that hook prompts survive compaction. GitOrigin-RevId: 999bb1391aa22c3c281d6a96f98817d6c9e46ed9
30 lines
1.8 KiB
Markdown
30 lines
1.8 KiB
Markdown
# codex-api
|
|
|
|
Typed clients for Codex/OpenAI APIs built on top of the generic transport in `codex-client`.
|
|
|
|
- Hosts the request/response models and request builders for Responses and related Codex APIs.
|
|
- Owns provider configuration (base URLs, headers, query params), auth header injection, retry tuning, and stream idle settings.
|
|
- Parses SSE streams into `ResponseEvent`/`ResponseStream`, including rate-limit snapshots and API-specific error mapping.
|
|
- Serves as the wire-level layer consumed by `codex-core`; higher layers handle auth refresh and business logic.
|
|
|
|
## Core interface
|
|
|
|
The public interface of this crate is intentionally small and uniform:
|
|
|
|
- **Responses endpoint**
|
|
- Input:
|
|
- `ResponsesApiRequest` for the request body (`model`, `instructions`, `input`, `tools`, `parallel_tool_calls`, reasoning/text controls).
|
|
- `ResponsesOptions` for transport/header concerns (`conversation_id`, `session_source`, `extra_headers`, `compression`, `turn_state`).
|
|
- Output: a `ResponseStream` of `ResponseEvent` (both re-exported from `common`).
|
|
|
|
- **Memory summarize endpoint**
|
|
- Input: `MemorySummarizeInput` (re-exported as `codex_api::MemorySummarizeInput`):
|
|
- `model: String`.
|
|
- `raw_memories: Vec<RawMemory>` (serialized as `traces` for wire compatibility).
|
|
- `RawMemory` includes `id`, `metadata.source_path`, and normalized `items`.
|
|
- `reasoning: Option<Reasoning>`.
|
|
- Output: `Vec<MemorySummarizeOutput>`.
|
|
- `MemoriesClient::summarize_input(&MemorySummarizeInput, extra_headers)` wraps JSON encoding and retry/telemetry wiring.
|
|
|
|
All HTTP details (URLs, headers, retry/backoff policies, SSE framing) are encapsulated in `codex-api` and `codex-client`. Callers construct prompts/inputs using protocol types and work with typed streams of `ResponseEvent` or other endpoint-specific response values.
|