文档
ProxAI 文档
Section titled “ProxAI 文档”ProxAI 是一个本地 OpenAI 兼容代理：接收本地 OpenAI-compatible 请求，修复部分上游不兼容的请求形态，按显式配置路由到 provider，并在已支持的协议对之间做转换。
一个请求如何经过 ProxAI
Section titled “一个请求如何经过 ProxAI”安装并本地运行从新环境到启动本地代理、找到应用目录并编辑 config.toml 的最快路径。添加或路由 Provider按 model、request protocol、provider protocol 和 upstream model rewrite 做路由。排查失败请求常见症状、可能原因、下一步检查，以及该看哪些日志/capture。理解协议行为协议取值、请求 path、透传/转换路径，以及每个协议的交互示例。
选择你的路径
Section titled “选择你的路径”使用 ProxAI
面向任务的文档：运行、配置、路由、观测和排障本地代理。
使用者视角
协议指南
协议概念、支持的 wire 行为、流式预期和各协议交互示例。
协议视角
开发者指南
内部架构、模块边界、转换设计、流式内部实现和错误渲染。
维护者视角
参考
精确配置参考、CLI flags、默认值、协议取值、错误 payload 和行为契约。
查表视角
使用 ProxAI
Section titled “使用 ProxAI”快速开始本地运行 ProxAI，找到应用目录，编辑 config.toml，并让客户端接入。安装与升级获取二进制、定位运行时文件、安全升级，并在保留配置的前提下回滚。客户端接入Base URL、endpoint、本地 API key、模型路由、错误格式和流式客户端行为。设置 ProviderProvider 名称、协议、base URL、API key、defaults 和显式 routes。常用 RecipesProvider 设置、模型路由、安全 capture 和流式诊断的任务路径。配置说明server、routing、providers、capture、logging 与错误响应配置。路由与 Providerroute 如何选择 provider，以及 provider protocol 如何决定出站 wire 行为。观测与诊断日志、capture、请求摘要，以及本地调试时的隐私边界。流式与工具调用面向用户的终止事件、工具调用卡住和 timeout 层级指南。调试工作流分类失败、捕获一个 phase，并分享脱敏证据的步骤化工作流。常见排障请求、provider、流式等常见症状、可能原因与下一步检查。
协议总览协议取值、pipeline 阶段、当前运行时路径和每个协议的 walkthrough。如何选择协议配置透传或转换路由前，先决定入站协议和 provider 协议。信息损失与保真度理解透传、支持的转换、有损映射和更高保真的协议选择。OpenAI ResponsesItem 化 output、稳定 item id、hosted tools 和类型化 streaming events。OpenAI Chat CompletionsChoices、assistant messages、tool call chunks、finish reason 和 `[DONE]`。Anthropic MessagesMessage envelope、扁平 content blocks、stop reason 和 content block streams。流式行为客户端可见的流式预期、terminal event 与卡住的工具调用超时。
架构请求生命周期、模块边界、pipeline 阶段，以及协议转换如何接入代理链路。模块边界解析、路由、转换、provider 行为、HTTP carrier、错误和观测分别应该放在哪里。配置流程config.toml、示例、CLI overrides、校验、providers 与运行时状态如何组合。错误流程内部错误如何变成紧凑的客户端 HTTP 和 SSE 错误。协议转换面向协议 pair 的转换规则、wire model 对齐、SDK 比对和流式标识模型。流式内部实现carrier、BodyObserver、SSE scanner 与协议状态机。错误处理内部实现强类型错误、ErrorResponseSpec、fields、payload 与 HTTP/SSE 渲染。贡献者检查清单运行时配置、转换 pair、流式、错误、测试和文档的操作清单。
配置参考config.example.toml 单一来源参考，以及字段说明和默认值速查入口。CLI运行 flag、route override、capture 子命令和默认端点。默认值与限制默认端点、超时、并发、请求体大小和 capture 默认值。协议协议取值、请求 path、可用位置与支持的转换对。兼容性矩阵协议 pair 在请求、响应、流式、工具、reasoning 和已知有损点上的支持情况。路由匹配Route 匹配结果、protocol guard、model pattern 和 fallback 行为。Capture PhasesPhase 边界、配置开关、CLI phase 名称与隐私风险。环境与文件App 目录、生成的运行时文件、仓库文档和本地产物边界。错误响应客户端 payload、type 枚举、HTTP status 语义与保留 headers。状态与停止原因对齐 stop_reason、finish_reason、status 和流式终止事件。行为契约ProxAI 跨版本承诺的稳定行为。术语表协议、phase、路由、provider、streaming、capture 和错误的共享术语。