本页内容
OpenAI-Compatible Provider
文档首页 · Provider 指南 · 配置 · DeepSeek · Anthropic · Gemini · English
当你的 endpoint 实现 Chat Completions streaming 形态时,使用 OpenAI-compatible provider。这包括 OpenAI /v1 endpoint 和兼容网关。
最小配置
临时本地使用:
export SIGIL_OPENAI_COMPATIBLE_API_KEY="sk-..."
sigil
可复用配置:
[agent]
provider = "openai_compat"
model = "gpt-4.1"
tool_timeout_secs = 30
[model_request]
request_timeout_secs = 120
stream_idle_timeout_secs = 180
[providers.openai_compat]
base_url = "https://api.openai.com/v1"
# 优先使用 SIGIL_OPENAI_COMPATIBLE_API_KEY。
# api_key = "sk-..."
organization = "org_..."
project = "proj_..."
完整起点模板见 openai-compatible.toml。
认证
Sigil 按这个顺序解析 OpenAI-compatible 认证:
SIGIL_OPENAI_COMPATIBLE_API_KEY[providers.openai_compat].api_key
organization 和 project 只在 endpoint 或账号要求时才需要。
环境变量覆盖
| 变量 | 覆盖 |
|---|---|
SIGIL_OPENAI_COMPATIBLE_BASE_URL | [providers.openai_compat].base_url |
这些覆盖适合 CI 和本地实验,不需要修改 sigil.toml。
行为说明
该 provider 会把 Sigil 的 provider-neutral messages、tool specs、streamed tool calls、usage 和可选 system_fingerprint 映射到 Chat Completions-compatible API。
V1 不在通用 OpenAI-compatible route 上开启图片附件。文本/tool wire 形状兼容不能证明 endpoint 接受相同的 multimodal contract,因此带图请求会在 provider transport 前失败。请使用图片附件中明确支持的原生 provider。
它不提供 DeepSeek-only prefix/FIM、reasoning replay、strict tools mode 或 beta endpoint 设置。如果需要这些能力,请使用 DeepSeek provider。
验证
运行:
sigil doctor
确认 [agent].provider 是 openai_compat,base URL 包含预期 /v1 路径,并且 key 来源是预期环境变量。
常见问题
| 现象 | 检查 |
|---|---|
| 404 或 route 错误 | 确认 base_url 指向 Chat Completions-compatible /v1 root。 |
| 认证失败 | 确认已设置 SIGIL_OPENAI_COMPATIBLE_API_KEY 或 [providers.openai_compat].api_key。 |
| Tool calls 不被接受 | 确认所选 endpoint/model 支持 streamed tool calls。 |
| 计费账号或 project 不对 | 检查 organization、project 和 provider 控制台设置。 |