Sebelum Anda memulai

Lapisan kompatibilitas ini ditujukan untuk menguji dan membandingkan kemampuan model dengan usaha pengembangan minimal dan tidak dianggap sebagai solusi jangka panjang atau siap produksi untuk kebanyakan kasus penggunaan. Untuk pengalaman terbaik dan akses ke rangkaian fitur lengkap API Anthropic (dukungan PDF, kutipan, pemikiran diperpanjang, dan caching prompt), kami merekomendasikan menggunakan API Anthropic asli.

Memulai dengan OpenAI SDK

Untuk menggunakan fitur kompatibilitas OpenAI SDK, Anda perlu:

  1. Menggunakan OpenAI SDK resmi
  2. Mengubah hal-hal berikut
    • Perbarui URL dasar Anda untuk mengarah ke API Anthropic
    • Ganti kunci API Anda dengan kunci API Anthropic
    • Perbarui nama model Anda untuk menggunakan model Claude
  3. Tinjau dokumentasi di bawah untuk fitur-fitur yang didukung

Contoh mulai cepat

Batasan penting kompatibilitas OpenAI

Perilaku API

Berikut adalah perbedaan paling substansial dari penggunaan OpenAI:

  • Parameter strict untuk pemanggilan fungsi diabaikan, yang berarti JSON penggunaan alat tidak dijamin mengikuti skema yang disediakan
  • Input audio tidak didukung; ini akan diabaikan dan dihapus dari input
  • Caching prompt tidak didukung, tetapi didukung di SDK Anthropic
  • Pesan sistem/pengembang diangkat dan digabungkan ke awal percakapan, karena Anthropic hanya mendukung satu pesan sistem awal.

Sebagian besar bidang yang tidak didukung diabaikan secara diam-diam daripada menghasilkan kesalahan. Semua ini didokumentasikan di bawah.

Pertimbangan kualitas output

Jika Anda telah melakukan banyak penyesuaian pada prompt Anda, kemungkinan akan disetel dengan baik khusus untuk OpenAI. Pertimbangkan untuk menggunakan penyempurna prompt di Anthropic Console sebagai titik awal yang baik.

Pengangkatan pesan sistem / pengembang

Sebagian besar input ke SDK OpenAI dengan jelas dipetakan langsung ke parameter API Anthropic, tetapi satu perbedaan yang berbeda adalah penanganan prompt sistem / pengembang. Kedua prompt ini dapat diletakkan di seluruh percakapan chat melalui OpenAI. Karena Anthropic hanya mendukung pesan sistem awal, kami mengambil semua pesan sistem/pengembang dan menggabungkannya bersama dengan satu baris baru (\n) di antara mereka. String lengkap ini kemudian disediakan sebagai satu pesan sistem di awal pesan.

Dukungan pemikiran diperpanjang

Anda dapat mengaktifkan kemampuan pemikiran diperpanjang dengan menambahkan parameter thinking. Meskipun ini akan meningkatkan penalaran Claude untuk tugas-tugas kompleks, SDK OpenAI tidak akan mengembalikan proses pemikiran terperinci Claude. Untuk fitur pemikiran diperpanjang lengkap, termasuk akses ke output penalaran langkah demi langkah Claude, gunakan API Anthropic asli.

Batas rate

Batas rate mengikuti batas standar Anthropic untuk endpoint /v1/messages.

Dukungan API Kompatibel OpenAI Terperinci

Bidang permintaan

Bidang sederhana

BidangStatus dukungan
modelGunakan nama model Claude
max_tokensDidukung sepenuhnya
max_completion_tokensDidukung sepenuhnya
streamDidukung sepenuhnya
stream_optionsDidukung sepenuhnya
top_pDidukung sepenuhnya
parallel_tool_callsDidukung sepenuhnya
stopSemua urutan stop non-whitespace berfungsi
temperatureAntara 0 dan 1 (inklusif). Nilai lebih besar dari 1 dibatasi pada 1.
nHarus tepat 1
logprobsDiabaikan
metadataDiabaikan
response_formatDiabaikan
predictionDiabaikan
presence_penaltyDiabaikan
frequency_penaltyDiabaikan
seedDiabaikan
service_tierDiabaikan
audioDiabaikan
logit_biasDiabaikan
storeDiabaikan
userDiabaikan
modalitiesDiabaikan
top_logprobsDiabaikan
Reasoning_effortDiabaikan

Bidang tools / functions

Bidang array messages

Bidang respons

BidangStatus dukungan
idDidukung sepenuhnya
choices[]Akan selalu memiliki panjang 1
choices[].finish_reasonDidukung sepenuhnya
choices[].indexDidukung sepenuhnya
choices[].message.roleDidukung sepenuhnya
choices[].message.contentDidukung sepenuhnya
choices[].message.tool_callsDidukung sepenuhnya
objectDidukung sepenuhnya
createdDidukung sepenuhnya
modelDidukung sepenuhnya
finish_reasonDidukung sepenuhnya
contentDidukung sepenuhnya
usage.completion_tokensDidukung sepenuhnya
usage.prompt_tokensDidukung sepenuhnya
usage.total_tokensDidukung sepenuhnya
usage.completion_tokens_detailsSelalu kosong
usage.prompt_tokens_detailsSelalu kosong
choices[].message.refusalSelalu kosong
choices[].message.audioSelalu kosong
logprobsSelalu kosong
service_tierSelalu kosong
system_fingerprintSelalu kosong

Kompatibilitas pesan kesalahan

Lapisan kompatibilitas mempertahankan format kesalahan yang konsisten dengan API OpenAI. Namun, pesan kesalahan terperinci tidak akan setara. Kami merekomendasikan hanya menggunakan pesan kesalahan untuk pencatatan dan debugging.

Kompatibilitas header

Meskipun SDK OpenAI secara otomatis mengelola header, berikut adalah daftar lengkap header yang didukung oleh API Anthropic untuk pengembang yang perlu bekerja dengan mereka secara langsung.

HeaderStatus Dukungan
x-ratelimit-limit-requestsDidukung sepenuhnya
x-ratelimit-limit-tokensDidukung sepenuhnya
x-ratelimit-remaining-requestsDidukung sepenuhnya
x-ratelimit-remaining-tokensDidukung sepenuhnya
x-ratelimit-reset-requestsDidukung sepenuhnya
x-ratelimit-reset-tokensDidukung sepenuhnya
retry-afterDidukung sepenuhnya
x-request-idDidukung sepenuhnya
openai-versionSelalu 2020-10-01
authorizationDidukung sepenuhnya
openai-processing-msSelalu kosong