此相容層主要用於測試和比較模型能力,對於大多數使用案例而言,不被視為長期或可用於生產環境的解決方案。雖然它旨在保持完整功能且不會有破壞性變更,但優先考量的是 Claude API 的可靠性和有效性。
有關已知相容性限制的更多資訊,請參閱重要的 OpenAI 相容性限制。
如果您在使用 OpenAI SDK 相容性功能時遇到任何問題,請透過此相容性回饋表單分享您的回饋。
為了獲得最佳體驗並存取 Claude API 的完整功能集(PDF 處理、引用、思考和提示快取),請使用原生的 Claude API。
要使用 OpenAI SDK 相容性功能,您需要:
import os
from openai import OpenAI
client = OpenAI(
api_key=os.environ.get("ANTHROPIC_API_KEY"), # Your Claude API key
base_url="https://api.anthropic.com/v1/", # the Claude API endpoint
)
response = client.chat.completions.create(
model="claude-opus-5", # Claude model name
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Who are you?"},
],
)
print(response.choices[0].message.content)以下是與使用 OpenAI 最主要的差異:
strict 參數會被忽略,這表示工具使用的 JSON 不保證會遵循所提供的結構描述。若要保證結構描述的一致性,請使用原生的 Claude API 搭配 Structured Outputs。大多數不支援的欄位會被靜默忽略,而不是產生錯誤。這些都記錄在以下章節中。
如果您已經對提示進行了大量調整,它很可能是專門針對 OpenAI 進行了良好調校。請考慮使用提示最佳實務指南為 Claude 重新設計提示。
OpenAI SDK 的大多數輸入都可以清楚地直接對應到 Anthropic 的 API 參數,但一個明顯的差異是 system / developer 提示的處理方式。透過 OpenAI,這兩種提示可以放在聊天對話的任何位置。由於 Anthropic 僅支援初始系統訊息,API 會取得所有 system/developer 訊息,並以單一換行符號(\n)將它們串接在一起。然後,這個完整的字串會作為單一系統訊息提供在訊息的開頭。
您可以透過新增 thinking 參數來啟用思考。在目前的模型上,思考是自適應的,由 Claude 決定何時思考以及思考的深度,而在 Claude 5 模型上則預設啟用;手動設定的擴展思考是一種舊版模式。雖然思考可以改善 Claude 在複雜任務上的推理能力,但 OpenAI SDK 不會回傳 Claude 的詳細思考過程。若要使用完整的思考功能,包括存取 Claude 的逐步推理輸出,請使用原生的 Claude API。
response = client.chat.completions.create(
model="claude-sonnet-4-6",
messages=[{"role": "user", "content": "Who are you?"}],
extra_body={"thinking": {"type": "enabled", "budget_tokens": 2000}},
)速率限制遵循 Anthropic 針對 /v1/messages 端點的標準限制。
| 欄位 | 支援狀態 |
|---|---|
model | 使用 Claude 模型名稱 |
max_tokens | 完全支援 |
max_completion_tokens | 完全支援 |
stream | 完全支援 |
stream_options | 完全支援 |
top_p | 完全支援 |
parallel_tool_calls | 完全支援 |
stop | 所有非空白字元的停止序列皆可運作 |
temperature | 介於 0 和 1 之間(含)。大於 1 的值會被限制為 1。 |
n | 必須恰好為 1 |
logprobs | 忽略 |
metadata | 忽略 |
response_format | 忽略。若需要 JSON 輸出,請使用原生 Claude API 搭配 Structured Outputs |
prediction | 忽略 |
presence_penalty | 忽略 |
frequency_penalty | 忽略 |
seed | 忽略 |
service_tier | 忽略 |
audio | 忽略 |
logit_bias | 忽略 |
store | 忽略 |
user | 忽略 |
modalities | 忽略 |
top_logprobs | 忽略 |
reasoning_effort | 忽略 |
tools / functions 欄位messages 陣列欄位| 欄位 | 支援狀態 |
|---|---|
id | 完全支援 |
choices[] | 長度永遠為 1 |
choices[].finish_reason | 完全支援 |
choices[].index | 完全支援 |
choices[].message.role | 完全支援 |
choices[].message.content | 完全支援 |
choices[].message.tool_calls | 完全支援 |
object | 完全支援 |
created | 完全支援 |
model | 完全支援 |
finish_reason | 完全支援 |
content | 完全支援 |
usage.completion_tokens | 完全支援 |
usage.prompt_tokens | 完全支援 |
usage.total_tokens | 完全支援 |
usage.completion_tokens_details | 永遠為空 |
usage.prompt_tokens_details | 永遠為空 |
choices[].message.refusal | 永遠為空 |
choices[].message.audio | 永遠為空 |
logprobs | 永遠為空 |
service_tier | 永遠為空 |
system_fingerprint | 永遠為空 |
相容層維持與 OpenAI API 一致的錯誤格式。然而,詳細的錯誤訊息不會完全相同。請僅將錯誤訊息用於記錄和除錯。
雖然 OpenAI SDK 會自動管理標頭,但以下是 Claude API 支援的完整標頭清單,供需要直接使用它們的開發者參考。
| 標頭 | 支援狀態 |
|---|---|
x-ratelimit-limit-requests | 完全支援 |
x-ratelimit-limit-tokens | 完全支援 |
x-ratelimit-remaining-requests | 完全支援 |
x-ratelimit-remaining-tokens | 完全支援 |
x-ratelimit-reset-requests | 完全支援 |
x-ratelimit-reset-tokens | 完全支援 |
retry-after | 完全支援 |
request-id | 完全支援 |
openai-version | 永遠為 2020-10-01 |
authorization | 完全支援 |
openai-processing-ms | 永遠為空 |
Was this page helpful?