Dokumentasi ChatGPT
Bahasa Indonesia
Hubungi kami goolvyouyou@gmail.com

Hubungkan ke gateway

Hubungkan Codex ke gateway LLM menggunakan URL gateway, alias model, dan kredensial atau resolver token yang disediakan organisasi Anda.

Periksa konfigurasi yang sudah ada

Sebelum menambahkan apa pun, periksa apakah administrator Anda sudah mengonfigurasi Codex.

  • Untuk CLI, periksa profil yang dipilih dan jalankan codex doctor. Setelah dijalankan, gunakan /status untuk memastikan model dan penyedia yang aktif.
  • Untuk aplikasi macOS, periksa ~/.codex/config.toml atau konfigurasi terkelola yang didistribusikan organisasi Anda.
  • Untuk aplikasi Windows, periksa %USERPROFILE%\.codex\config.toml atau konfigurasi sistem yang didistribusikan organisasi Anda.

Jika penyedia gateway dan model yang diharapkan sudah aktif, lanjutkan ke Verifikasi koneksi.

Dapatkan detail koneksi gateway Anda

Instal Codex CLI atau aplikasi desktop yang disetujui oleh organisasi Anda. Untuk mengonfigurasi Codex sendiri, dapatkan nilai berikut dari tim gateway Anda:

  • URL dasar gateway HTTPS, termasuk jalur API-nya, seperti https://gateway.example.com/v1.
  • Nama model dan ID penyedia yang akan digunakan.
  • Kredensial gateway dengan cakupan terbatas beserta variabel lingkungannya, atau resolver token yang terinstal beserta konfigurasinya.
  • File katalog model yang diperlukan beserta jalur lokal absolutnya.

Konfigurasikan penyedia

Buka config.toml di ~/.codex/config.toml pada macOS atau Linux, atau %USERPROFILE%\.codex\config.toml pada Windows.

Gabungkan contoh ini ke dalam konfigurasi yang sudah ada, lalu ganti URL dan model dengan nilai yang diberikan administrator Anda. Jangan menambahkan definisi kedua untuk kunci atau tabel yang sudah ada. Contoh ini menggunakan gpt-6-sol; gunakan tanpa katalog kustom hanya jika administrator Anda memastikan bahwa versi Codex Anda mengenali model tersebut dan metadata bawaannya sesuai dengan gateway.

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"
env_key = "CODEX_GATEWAY_API_KEY"

Jika administrator Anda menyediakan katalog model, simpan secara lokal dan tambahkan model_catalog_json sebelum tabel TOML pertama, menggunakan jalur absolut file tersebut. Alias kustom memerlukan metadata katalog yang sesuai. Contohnya:

model_catalog_json = "/etc/codex/gateway-models.json"

Gunakan nama model dan katalog yang disediakan secara bersamaan oleh administrator Anda. Jangan menambahkan jalur katalog kecuali file tersebut ada di lokasi itu.

enterprise-gateway adalah contoh ID penyedia. Gunakan ID yang sama di model_provider, [model_providers.<id>], dan [model_providers.<id>.auth]. Contoh ini menonaktifkan pencarian web untuk pengujian koneksi awal; administrator Anda harus memverifikasi dukungan fitur sebelum mengaktifkannya.

Sediakan kredensial gateway Anda sebagai CODEX_GATEWAY_API_KEY di lingkungan proses yang menjalankan Codex, menggunakan mekanisme distribusi rahasia organisasi Anda. Jangan menyimpan kredensial dalam TOML atau repositori. Variabel yang ditetapkan di terminal mungkin tidak tersedia bagi aplikasi yang dijalankan dari desktop.

Gunakan header autentikasi kustom

Jika gateway Anda memerlukan header seperti X-API-Key alih-alih token bearer, ganti env_key dalam tabel penyedia dengan:

env_http_headers = { "X-API-Key" = "CODEX_GATEWAY_API_KEY" }

Gunakan nama header persis seperti yang diberikan administrator Anda. Codex membaca nilainya dari variabel lingkungan yang disebutkan; jangan simpan kredensial dalam file konfigurasi. Lihat referensi konfigurasi untuk model_providers.<id>.env_http_headers.

Gunakan alat bantu kredensial organisasi

Jika administrator Anda menyediakan autentikasi berbasis perintah, gunakan alat bantu yang telah diinstal beserta konfigurasinya sebagai pengganti env_key. Jangan mengonfigurasi kedua mekanisme tersebut. Alat bantu harus sudah tersedia di komputer Anda; Codex tidak menginstalnya. Misalnya, ganti contoh pengaturan env_key dengan tabel ini, menggunakan jalur resolver dan argumen yang diberikan administrator Anda:

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

Referensi autentikasi penyedia kustom mendefinisikan perintah, argumen, batas waktu, interval penyegaran, dan kontrak keluaran token. Tanyakan kepada administrator Anda cara memperbarui sesi masuk jika alat bantu tidak dapat lagi mengambil token.

Gunakan jalur absolut yang telah diresolusikan untuk file eksekusi alat bantu dan file katalog.

Konfigurasikan CLI

Secara default, CLI membaca ~/.codex/config.toml pada macOS atau Linux. Setelah menyimpan pengaturan penyedia, jalankan codex. Di dalam WSL, gunakan konfigurasi dan jalur Linux kecuali CODEX_HOME menunjuk ke lokasi lain.

Konfigurasikan aplikasi macOS

Aplikasi macOS membaca ~/.codex/config.toml yang sama. Setelah menyimpan pengaturan penyedia, mulai ulang aplikasi. Jika Anda menggunakan variabel lingkungan untuk kredensial, pastikan variabel tersebut tersedia bagi proses aplikasi.

Konfigurasikan aplikasi Windows

Tempatkan pengaturan penyedia di %USERPROFILE%\.codex\config.toml, lalu mulai ulang aplikasi. Untuk autentikasi berbasis perintah, gunakan resolver yang diinstal oleh administrator Anda. Misalnya, ganti tabel autentikasi Unix dengan:

[model_providers.enterprise-gateway.auth]
command = 'C:\Program Files\OpenAI\Codex\fetch-codex-gateway-token.exe'
args = ["print-token"]
timeout_ms = 30000
refresh_interval_ms = 300000

Dalam TOML Windows, string literal dengan tanda kutip tunggal mempertahankan garis miring terbalik. Ganti juga jalur katalog Unix, misalnya dengan 'C:\ProgramData\OpenAI\Codex\models.json', menggunakan jalur sebenarnya yang diberikan administrator Anda.

Konfigurasikan MCP server dan plugin secara terpisah. Kredensial gateway model tidak memberikan otorisasi akses ke alat atau sistem Anda yang terhubung.

Verifikasi koneksi

Mulai ulang klien setelah mengubah konfigurasi. Di CLI, jalankan codex dan gunakan /status untuk memeriksa model dan penyedia yang aktif. Di aplikasi desktop, periksa model yang dipilih dan konfigurasinya.

Kirim prompt ini dalam tugas baru:

Reply with exactly: gateway-ok

Hasil yang diharapkan adalah gateway-ok. Respons saja tidak membuktikan rute mana yang menanganinya: minta administrator Anda memastikan bahwa gateway mencatat pengguna, alias model, dan rute upstream yang dimaksud. Jangan mengidentifikasi model dengan menanyakan namanya.

Langkah ini memverifikasi koneksi awal. Administrator juga harus menyelesaikan pemeriksaan penerapan untuk streaming, alat, dan giliran percakapan lanjutan.

Atasi masalah koneksi

Gejala Yang perlu diperiksa
Penyedia yang diharapkan tidak aktif. Periksa profil yang dipilih dan urutan prioritas konfigurasi. Pastikan kunci tingkat teratas tidak berada di dalam tabel penyedia.
Autentikasi gagal. Periksa apakah variabel kredensial tersedia bagi proses klien, atau apakah alat bantu yang terinstal dapat mengambil token yang masih berlaku. Minta administrator membedakan autentikasi gateway dari autentikasi upstream.
Model tidak ditemukan. Pastikan nama model yang diberikan sudah benar dan minta administrator memeriksa rutenya.
Model menggunakan kemampuan yang tidak diharapkan. Minta administrator memeriksa apakah metadata katalog sesuai dengan model yang diwakili alias tersebut.
Streaming terhenti atau percakapan lanjutan gagal. Minta pemilik gateway memeriksa buffering proxy, peristiwa penutup response.completed, dan Kompatibilitas gateway.
Jalur katalog atau alat bantu tidak berfungsi. Pastikan file tersebut ada di jalur absolut yang dikonfigurasi dalam lingkungan yang menjalankan Codex.

Saat meminta bantuan, sertakan pesan kesalahan setelah menghapus token dan prompt sensitif.

Gunakan deployment gateway yang sudah ada

Jika organisasi Anda sudah menggunakan gateway dengan alat pemrograman lain, Anda mungkin dapat menggunakan kembali jalur jaringan, pencatatan log, dan akses penyedianya. Bekerja samalah dengan tim gateway Anda untuk mengonfigurasi dan menguji koneksi Codex:

  1. Identifikasi URL gateway yang sudah ada, mekanisme kredensial, header yang diperlukan, rute model, dan metode distribusi konfigurasi.
  2. Minta tim gateway Anda memastikan bahwa gateway mendukung perilaku API yang diperlukan Codex dan mengonfigurasi rute model Codex.
  3. Dapatkan kredensial gateway dengan cakupan terbatas atau alat bantu kredensial, nama model, dan katalog model yang diperlukan dari tim gateway Anda.
  4. Konfigurasikan Codex dengan nilai tersebut.
  5. Verifikasi koneksi di CLI atau aplikasi desktop yang ingin Anda gunakan. Minta tim gateway Anda menyelesaikan pemeriksaan streaming, alat, dan percakapan lanjutan.
  6. Setelah uji coba berhasil, ikuti Terapkan Codex melalui gateway untuk mendistribusikan konfigurasi kepada pengembang lain.

Untuk daftar periksa migrasi administrator dan pemetaan konfigurasi, lihat Gunakan kembali deployment gateway yang sudah ada.

Dokumentasi terkait