Dokumentasi ChatGPT
Bahasa Indonesia
Hubungi kami goolvyouyou@gmail.com

Terapkan Codex melalui gateway

Terapkan Codex melalui gateway LLM organisasi Anda. Konfigurasikan rute model, terbitkan kredensial pengembang, dan distribusikan konfigurasi Codex yang telah diverifikasi.

Prasyarat

Sebelum menerapkan Codex untuk pengembang, pastikan Anda memiliki:

  • Gateway yang melayani HTTPS pada URL dasar persis seperti yang akan Anda distribusikan.
  • Kredensial penyedia upstream yang disimpan oleh gateway.
  • Alias model yang disetujui untuk digunakan oleh Codex dan dipetakan ke model upstream yang dituju.
  • Kredensial gateway pengujian dengan cakupan terbatas.
  • Mekanisme pengiriman rahasia atau helper kredensial yang telah diuji.
  • Cara untuk mendistribusikan konfigurasi, executable helper, dan file katalog apa pun.

Persyaratan gateway

Sebelum menghubungkan Codex, verifikasi bahwa produk gateway mempertahankan perilaku wajib berikut:

  • Menerima permintaan Responses API dari Codex di POST /v1/responses.
  • Mengalirkan peristiwa SSE tanpa buffering dan mengakhirinya dengan response.completed.
  • Mempertahankan kelanjutan percakapan dengan input yang dikirim ulang.
  • Mempertahankan previous_response_id hanya ketika WebSocket atau transport inkremental diaktifkan.
  • Mempertahankan pemanggilan fungsi dan item function_call_output yang sesuai.
  • Merutekan setiap alias model yang digunakan oleh Codex ke model upstream yang dituju.
  • Mengautentikasi pengguna secara terpisah dan mengembalikan kesalahan yang informatif tanpa menyembunyikan penyebabnya.

Endpoint pemeriksaan kesehatan, /v1/models, respons Chat Completions, atau satu balasan teks biasa tidak membuktikan kelayakan gateway. Lihat Persyaratan kompatibilitas gateway untuk kontrak terperinci.

Luncurkan gateway

Untuk beralih dari gateway yang telah diterapkan ke pengalaman pengembang yang telah diverifikasi, selesaikan lima tahap pemeriksaan berikut secara berurutan:

  1. Pilih nama model dan verifikasi rute.
  2. Terbitkan kredensial pengembang.
  3. Uji Codex melalui gateway.
  4. Distribusikan konfigurasi.
  5. Verifikasi dari komputer pengembang.

Pilih nama dan rute model

Atur model Codex ke nama model gateway. Konfigurasikan gateway untuk merutekan nama tersebut ke model upstream yang disetujui.

Nama model gateway Konfigurasi Codex
Nama model bawaan yang disertakan dalam versi Codex Anda Atur model dalam config.toml ke nama yang sama persis.
Alias kustom, seperti company-coding-model Atur model_catalog_json ke katalog yang berisi alias dan metadata model yang sesuai.

Gunakan katalog model untuk nama kustom

Gunakan model_catalog_json ketika gateway Anda menggunakan nama model yang tidak dikenali Codex. Katalog menyediakan instruksi, opsi penalaran, batas konteks, dan kemampuan alat yang digunakan Codex untuk nama tersebut. Tanpa entri yang cocok, permintaan dapat mencapai model upstream yang dituju sementara Codex menggunakan pengaturan generik.

Misalnya, untuk menggunakan company-coding-model sebagai alias bagi gpt-6-luna:

  1. Buat alias company-coding-model di gateway dan rutekan ke model upstream gpt-6-luna yang disetujui.
  2. Unduh katalog model Codex untuk versi Codex Anda dan simpan salinannya sebagai gateway-models.json. Gunakan file ini sebagai titik awal.
  3. Edit entri gpt-6-luna dalam salinan Anda: atur slug ke company-coding-model dan pastikan metadata lainnya sesuai dengan model upstream dan kemampuan gateway. Untuk alias tanpa migrasi model, atur upgrade ke null.
  4. Pertahankan entri dalam array models tingkat teratas dan distribusikan file ke setiap klien. Katalog kustom menggantikan katalog bawaan, jadi sertakan semua model yang perlu dipilih pengguna.

Untuk Bedrock melalui LiteLLM, terapkan perubahan katalog yang diperlukan.

Atur alias gateway, slug katalog, dan model Codex ke company-coding-model. Tambahkan pengaturan ini sebelum tabel TOML pertama dalam konfigurasi Codex yang Anda distribusikan, dengan menggunakan jalur absolut file yang sebenarnya:

model = "company-coding-model"
model_catalog_json = "/absolute/path/to/gateway-models.json"

Mulai ulang CLI atau aplikasi desktop setelah mengubah katalog karena Codex memuatnya saat dimulai.

Verifikasi rute model

Untuk setiap model, verifikasi rutenya dengan permintaan Responses nyata dan catatan gateway. Respons /v1/models dapat membantu menemukan nama, tetapi tidak membuktikan bahwa model mendukung perilaku permintaan dan alat yang diperlukan.

Perutean model dan otorisasi alat merupakan bagian terpisah dari peluncuran. Konfigurasikan koneksi MCP, distribusi plugin, dan kebijakannya secara terpisah.

Terbitkan kredensial pengembang

  1. Terbitkan satu kredensial gateway dengan cakupan terbatas untuk setiap pengembang agar Anda dapat mengatribusikan penggunaan dan mencabut akses secara individual.
  2. Tetapkan model yang disetujui, batas laju, anggaran, masa berlaku, dan periode perpanjangan untuk setiap kredensial.
  3. Kirimkan kredensial melalui pengelola rahasia atau helper kredensial yang terpasang. Jangan simpan kredensial penyedia upstream dan administrator gateway di komputer pengembang.
  4. Jika Anda menggunakan helper, ikuti kontrak autentikasi berbasis perintah dan uji pengambilan serta penyegaran token sebelum distribusi.
  5. Beri tahu pengembang cara memperpanjang kredensial dan pihak yang dapat dihubungi untuk mendapatkan bantuan.

Uji Codex melalui gateway

Sebelum mendistribusikan apa pun, ikuti Hubungkan ke gateway untuk mengonfigurasi satu pengguna pengujian terisolasi dengan blok penyedia dan mekanisme kredensial yang akan Anda distribusikan.

Jalankan pemeriksaan di bawah dari antarmuka CLI atau desktop yang sama dengan yang akan digunakan pengembang:

Pemeriksaan Tindakan Bukti keberhasilan
Koneksi Ikuti Verifikasi koneksi. Penyedia dan alias yang diharapkan aktif, prompt pengujian berhasil, dan log gateway mengidentifikasi pengguna pengujian.
Streaming Minta jawaban singkat dalam beberapa paragraf. Gateway meneruskan peristiwa SSE tanpa buffering, teks diterima secara inkremental, dan aliran berakhir dengan response.completed.
Siklus alat lokal Dalam folder sementara dengan izin hanya baca, minta Codex untuk mencantumkan file tingkat teratas dan merangkumnya. Codex mengeluarkan pemanggilan alat lokal, mengembalikan hasilnya, dan menghasilkan jawaban akhir tanpa melakukan pengeditan.
Tindak lanjut Ajukan pertanyaan lanjutan dalam utas yang sama. Jawaban menggunakan giliran sebelumnya; gateway menerima input yang dikirim ulang. Jika WebSocket atau transport inkremental diaktifkan, gateway juga mempertahankan previous_response_id.
Kesalahan dan atribusi Ulangi dengan alias pengujian yang sengaja dibuat tidak valid atau kredensial pengujian yang kedaluwarsa. Klien menerima kesalahan perutean atau autentikasi yang informatif, dan permintaan yang valid tetap diatribusikan kepada pengguna pengujian.

Setelah pemeriksaan ini berhasil, arahkan pengembang ke Hubungkan ke gateway untuk mengonfigurasi dan memverifikasi komputer mereka sendiri.

Distribusikan konfigurasi

Agar setiap komputer menggunakan jalur koneksi yang sama, distribusikan URL dasar gateway, ID penyedia, alias model yang disetujui, dan mekanisme kredensial.

Komponen yang perlu didistribusikan

Untuk menetapkan nilai default penyedia, distribusikan blok config.toml ini melalui lapisan konfigurasi yang Anda pilih. Gunakan model yang dikenali oleh versi Codex Anda, atau sediakan katalog yang sesuai sebagaimana dijelaskan di atas. Instal resolver token Anda pada jalur perintah yang dikonfigurasi:

model = "gpt-6-sol"
model_provider = "enterprise-gateway"
web_search = "disabled"

[model_providers.enterprise-gateway]
name = "Organization Gateway"
base_url = "https://gateway.example.com/v1"
wire_api = "responses"

[model_providers.enterprise-gateway.auth]
command = "/usr/local/bin/fetch-codex-gateway-token"
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000

Untuk kunci pengujian statis berumur pendek, hapus blok autentikasi, letakkan env_key = "CODEX_GATEWAY_API_KEY" di dalam [model_providers.enterprise-gateway], dan tetapkan variabel tersebut di luar TOML. Jangan gabungkan env_key dengan autentikasi berbasis perintah.

Distribusikan nilai default dan persyaratan

Gunakan Urutan prioritas konfigurasi untuk memilih tempat mendistribusikan nilai default. Untuk pengaturan yang diberlakukan dan payload MDM macOS, lihat Konfigurasi terkelola.

Untuk nilai default yang berlaku di seluruh host pada macOS atau Linux, gunakan /etc/codex/config.toml. Pada Windows, letakkan config.toml di %ProgramData%\OpenAI\Codex\. Pengguna dan profil dapat mengganti nilai default ini. Referensi tertaut menjelaskan persyaratan yang didukung dan lokasi filenya.

Distribusikan executable helper dan file katalog yang dirujuk secara terpisah.

model_catalog_json menunjuk ke file JSON lokal. Jika Anda memberlakukannya melalui requirements.toml, persyaratan tersebut menetapkan jalurnya; persyaratan itu tidak mendistribusikan file. Letakkan katalog pada jalur absolut tersebut sebelum Codex dimulai.

Tulis jalur Windows absolut yang telah diresolusikan dalam TOML. Codex tidak mengekspansi %ProgramData% di dalam model_catalog_json atau nilai command autentikasi penyedia. Sebagai contoh, gunakan jalur berikut hanya jika penerapan Anda menempatkan file di sana:

model_catalog_json = 'C:\ProgramData\OpenAI\Codex\models.json'

[model_providers.enterprise-gateway.auth]
command = 'C:\ProgramData\OpenAI\Codex\fetch-gateway-token.cmd'
args = ["print-token"]

CLI di dalam WSL membaca jalur Linux dan CODEX_HOME Linux; CLI tersebut tidak secara otomatis mewarisi konfigurasi Windows native.

Berikan nilai konfigurasi kepada pengembang

Jika Anda tidak memiliki distribusi terkelola, berikan URL gateway, ID penyedia, alias model, variabel kredensial atau resolver, dan jalur katalog apa pun kepada setiap pengembang. Arahkan mereka ke Hubungkan ke gateway untuk mengonfigurasi dan memverifikasi komputer mereka sendiri.

Penyiapan manual bukan saluran pemberlakuan kebijakan. .codex/config.toml lokal proyek tidak dapat mengganti kunci perutean penyedia atau autentikasi yang sensitif.

Verifikasi dari komputer pengembang

Untuk memastikan pengaturan yang didistribusikan telah diterima oleh komputer pengembang:

  1. Mulai ulang Codex dan pastikan penyedia serta model sesuai harapan.
  2. Jalankan pengujian singkat dalam Hubungkan ke gateway.
  3. Ajukan satu pertanyaan lanjutan untuk memastikan kelanjutan percakapan, lalu periksa log gateway untuk permintaan pengembang tersebut.

Atasi kegagalan peluncuran

Gunakan masalah yang terjadi untuk menemukan lapisan konfigurasi, kredensial, atau gateway yang memerlukan perhatian:

Masalah Penanganan
Penyedia yang diharapkan tidak muncul setelah mulai ulang. Periksa lapisan konfigurasi yang berlaku. Konfigurasi pengguna atau profil dapat mengganti nilai default sistem.
Autentikasi gagal untuk semua pengguna. Periksa autentikasi gateway dan kredensial penyedia upstream; identifikasi layanan yang menolak permintaan.
Autentikasi gagal untuk satu pengguna. Periksa kredensial gateway atau resolver token pengguna tersebut.
Streaming terhenti. Periksa buffering gateway dan penerusan response.completed penutup.
Model tidak muncul atau menggunakan kemampuan generik. Untuk alias kustom, pastikan alias gateway, model Codex, dan slug katalog cocok. Periksa jalur katalog dan kompatibilitasnya dengan versi Codex yang terpasang, lalu mulai ulang Codex.
Jalur Windows gagal. Gunakan jalur absolut yang telah diresolusikan. Dalam TOML, gunakan string dengan tanda kutip tunggal untuk jalur Windows dengan garis miring terbalik tunggal.

Gunakan kembali penerapan gateway yang ada

Jika organisasi Anda sudah menggunakan Claude Code melalui gateway, Anda mungkin dapat menggunakan kembali produk gateway, jalur jaringan, pencatatan log, dan akses Bedrock. Tambahkan rute Responses yang melayani Codex, kredensial, alias model, dan config.toml sambil mempertahankan penyiapan yang sudah berfungsi. Pengaturan klien Claude dan kontrak /v1/messages tidak mengonfigurasi Codex.

Penerapan Claude yang ada Migrasi Codex
Produk gateway, DNS, TLS, jaringan privat, pencatatan log, penyamaran data, dan pemantauan Pertahankan layanan ini. Tambahkan rute yang melayani Codex dan memenuhi Persyaratan kompatibilitas gateway.
Akun Bedrock, kredensial penyedia, batas IAM, profil inferensi, dan rotasi kredensial Pertahankan hanya jika semuanya mengizinkan model upstream di balik alias Codex baru. Kredensial penyedia tetap berada di gateway.
Rute Claude /v1/messages, format Bedrock InvokeModel, header Anthropic, serta percobaan ulang atau kesalahan khusus Claude Jangan gunakan kembali hal-hal ini sebagai bukti kompatibilitas. Codex memerlukan POST /v1/responses, streaming Responses, kelanjutan percakapan, pemanggilan alat, dan kesalahan yang informatif.
ANTHROPIC_AUTH_TOKEN, ANTHROPIC_API_KEY, atau apiKeyHelper Codex tidak mendukung apiKeyHelper. Terbitkan kredensial gateway Codex dengan cakupan terbatas dan konfigurasikan menggunakan env_key atau resolver token berbasis perintah untuk Codex.
Nama model Claude, ANTHROPIC_MODEL, ANTHROPIC_DEFAULT_*_MODEL, modelOverrides, dan pemetaan profil Bedrock Minta tim gateway Anda memilih nama model dan mengonfigurasi alias kustom yang diperlukan. Gunakan nama model dan JSON katalog model apa pun yang mereka sediakan.
settings.json Claude, managed-settings.json, blok JSON env, plist, atau payload registri Pertahankan saluran MDM atau pengelolaan konfigurasi yang sama, tetapi distribusikan config.toml Codex dan nilai requirements.toml yang didukung sebagai gantinya.

Untuk bermigrasi dengan aman, selesaikan langkah-langkah berikut secara berurutan:

  1. Inventarisasi jalur Claude saat ini: URL gateway, sumber kredensial, header wajib, alias model, pemetaan profil Bedrock, dan saluran pengiriman terkelola.
  2. Tambahkan rute Responses paralel yang melayani Codex dan alias model Codex.
  3. Terbitkan satu kredensial Codex dengan cakupan terbatas. Jika Codex akan menggunakan kredensial statis, sediakan kredensial baru tersebut melalui env_key; jika Claude menggunakan helper kredensial, implementasikan dan uji kontrak resolver berbasis perintah untuk Codex.
  4. Konfigurasikan pengembang tersebut dengan blok penyedia. Untuk peluncuran terkelola, sesuaikan payload dengan jalur dan urutan prioritas Codex yang dijelaskan dalam Terapkan Codex melalui gateway.
  5. Jalankan pemeriksaan koneksi singkat pada antarmuka CLI atau desktop yang benar-benar digunakan pengembang, lalu jalankan pemeriksaan lengkap untuk streaming, kelanjutan percakapan, pemanggilan alat, kesalahan, pencatatan log, dan perutean alias dalam Uji Codex melalui gateway.
  6. Setelah uji coba awal berhasil, distribusikan konfigurasi kepada pengembang lainnya.

Dokumentasi terkait