Bir ağ geçidini kullanıma sunun
Kuruluşunuz için bir Codex ağ geçidi bağlantısını dağıtın ve doğrulayın
Ağ geçidi yöneticisi olarak model rotalarını yapılandırın ve bir pilot kullanıcıyı yetkilendirin. Ayarları geliştiricilere dağıtmadan önce desteklediğiniz her istemcide bağlantıyı test edin. Ağ geçidi kimlik doğrulaması için yerleşik ağ geçidi OAuth'u, API key veya kimlik bilgisi yardımcılarını kullanın. Ağ geçidi kimlik doğrulamasını ChatGPT çalışma alanında oturum açmayla birleştirmek için Ağ geçidi üzerinden ChatGPT ile oturum açma bölümüne bakın.
Ön koşullar
Codex'i geliştiricilere dağıtmadan önce aşağıdakilere sahip olduğunuzu doğrulayın:
- Dağıtacağınız temel URL'nin tam olarak kendisinde HTTPS üzerinden hizmet veren bir ağ geçidi.
- Ağ geçidinde tutulan bir üst sağlayıcı kimlik bilgisi.
- Hedeflenen üst sağlayıcı modellerine eşlenmiş, Codex'e yönelik onaylı model takma adları.
- Test edilmiş bir kimlik doğrulama yöntemi: yerleşik ağ geçidi OAuth desteği, kapsamı sınırlandırılmış ağ geçidi API key'leri veya bir kimlik bilgisi yardımcısı.
- OAuth için kayıtlı bir genel istemci, onaylı test kullanıcıları ve OAuth erişim belirteçlerini doğrulamaya yönelik ağ geçidi desteği.
- API key'ler veya yardımcılar için bir gizli bilgi iletim mekanizması veya test edilmiş bir yardımcı.
- Yapılandırmayı, gerekli yardımcıları ve katalog dosyalarını dağıtmanın bir yolu.
Ağ geçidi gereksinimleri
Codex'i bağlamadan önce ağ geçidi ürününün şu gerekli davranışları koruduğunu doğrulayın:
POST /v1/responsesadresinde Codex Responses API isteklerini kabul etme.- SSE olaylarını arabelleğe almadan akış halinde iletme ve akışı
response.completedile sonlandırma. - Yeniden gönderilen girdiyle sonraki turlarda konuşmanın devamını koruma.
previous_response_iddavranışını yalnızca WebSocket veya artımlı aktarım etkinleştirildiğinde koruma.- İşlev çağrılarını ve eşleşen
function_call_outputöğelerini koruma. - Codex'e sunulan her model takma adını hedeflenen üst sağlayıcı modeline yönlendirme.
- Kullanıcıların kimliğini ayrı ayrı doğrulama ve nedeni gizlemeden yararlı hatalar döndürme.
Bir sağlık uç noktası, /v1/models, Chat Completions yanıtı veya tek bir düz metin yanıtı, ağ geçidinin uygunluğunu kanıtlamaz. Ayrıntılı sözleşme için Ağ geçidi uyumluluk gereksinimleri sayfasına bakın.
Ağ geçidini kullanıma sunun
Dağıtılmış bir ağ geçidinden doğrulanmış bir geliştirici deneyimine geçmek için şu beş kontrol noktasını sırayla tamamlayın:
- Model adlarını seçin ve rotaları doğrulayın.
- Kimlik doğrulama yöntemini seçin.
- Codex'i ağ geçidi üzerinden test edin.
- Yapılandırmayı dağıtın.
- Bir geliştirici makinesinden doğrulayın.
Model adlarını ve rotalarını seçin
Codex'in model değerini ağ geçidindeki model adı olarak ayarlayın. Ağ geçidini, bu adı onaylı üst sağlayıcı modeline yönlendirecek şekilde yapılandırın.
| Ağ geçidi model adı | Codex yapılandırması |
|---|---|
| Codex sürümünüze dâhil olan bir yerleşik model adı | config.toml içindeki model değerini tam olarak bu ada ayarlayın. |
company-coding-model gibi özel bir takma ad |
Takma adı ve ilgili modelin meta verilerini içeren uzak veya yerel bir katalog sağlayın. |
Özel adlar için model kataloğu kullanın
Yerel bir katalog için models.json örneğiyle başlayın.
Ağ geçidiniz Codex'in tanımadığı bir model adı kullanıyorsa bir model kataloğu sağlayın. Katalog, Codex'in bu ad için kullandığı talimatları, akıl yürütme seçeneklerini, bağlam sınırlarını ve araç yeteneklerini sağlar. Eşleşen bir giriş olmadan istek hedeflenen üst modele ulaşabilir, ancak Codex genel ayarları kullanır.
Model meta verilerini merkezi olarak güncellemek için model_providers.<id>.model_catalog_url ile uzak bir katalog barındırın veya model_catalog_json ile yerel bir dosya dağıtın. Tek kimlik doğrulama yöntemi yerleşik ağ geçidi OAuth desteği olduğunda yerel bir katalog kullanın; OAuth tek başına uzak katalog keşfini etkinleştirmez. Her iki ayar için yapılandırma başvurusuna bakın.
Bulut veya ağ geçidi sağlayıcınızdan Codex sürümünüzle uyumlu bir katalog uç noktası veya dosyası edinin. Onaylı her takma adı ve ilgili modelin meta verilerini içerdiğinden emin olun. Katalog uygulaması için Ağ geçitleri ve bulutlar için model kataloglarını uygulama bölümüne bakın.
Uzak katalog sunma
Sağlayıcınızın sunduğu HTTPS katalog uç noktasını kullanın.
Uç noktanın tam URL'sini seçilen sağlayıcının config.toml tablosunda dağıtın:
model = "company-coding-model"
model_provider = "enterprise-gateway"
web_search = "disabled"
[model_providers.enterprise-gateway]
name = "Organization Gateway"
base_url = "https://gateway.example.com/v1"
model_catalog_url = "https://gateway.example.com/codex/models"
wire_api = "responses"
env_key = "CODEX_GATEWAY_API_KEY"CODEX_GATEWAY_API_KEY değerini Codex işleminin kullanımına sunun. Çıkarımı ağ geçidi üzerinden yönlendirmek için
base_url değerini ayrıca ayarlayın. Bu değeri atlarsanız Codex, geçerli kimlik doğrulama
modu için varsayılan OpenAI uç noktasını kullanır.
Keşif için API key tabanlı, komut tabanlı veya Codex arka ucu üzerinden kimlik doğrulama gerekir. Yerleşik ağ geçidi OAuth desteği veya özel üstbilgiler tek başına keşfi tetiklemez.
Onaylanmış modelleriniz değiştiğinde katalog güncellemelerini sağlayıcınızla koordine edin. Yapılandırmasını değiştirdikten sonra istemciyi yeniden başlatın.
requirements.toml aracılığıyla zorunlu kılınanlar dâhil olmak üzere geçerli tüm model_catalog_json
ayarlarını kaldırın. Bu ayar uzak URL'ye göre önceliklidir ve getirme işlemini engeller.
Yerel katalog dağıtma
Sağlayıcının sunduğu dosyayı başlangıçta yüklemek için model_catalog_json kullanın. Yerel bir özel
katalog, birlikte gelen kataloğun yerini alır.
Ağ geçidi takma adını, katalogdaki slug değerini ve Codex'in model değerini company-coding-model olarak ayarlayın. Dosyanın gerçek mutlak yolunu kullanarak bu ayarları dağıttığınız Codex yapılandırmasındaki ilk TOML tablosundan önce ekleyin:
model = "company-coding-model"
model_catalog_json = "/absolute/path/to/gateway-models.json"Codex kataloğu başlangıçta yüklediği için, kataloğu değiştirdikten sonra CLI'yi veya masaüstü uygulamasını yeniden başlatın.
Model rotalarını doğrulayın
Her model için rotayı gerçek bir Responses isteği ve ağ geçidi
kayıtlarıyla doğrulayın. /v1/models yanıtı adları keşfetmeye yardımcı olabilir, ancak bir
modelin gerekli istek ve araç davranışını desteklediğini kanıtlamaz.
Model yönlendirmesi ve araç yetkilendirmesi, kullanıma sunma sürecinin ayrı parçalarıdır. MCP bağlantılarını, eklenti dağıtımını ve bunların ilkelerini ayrı ayrı yapılandırın.
Kimlik doğrulama yöntemini seçin
Yerleşik ağ geçidi OAuth desteği
- PKCE ile yetkilendirme kodu akışını destekleyen bir genel OAuth istemcisi kaydedin ve oturum açabilecek kullanıcıları veya grupları onaylayın.
- Ağ geçidini, verilen erişim belirtecini seçili çerezde veya özel üstbilgide doğrulayacak şekilde yapılandırın. Onaylı modelleri, hız sınırlarını ve bütçeleri her kullanıcının kimliğine uygulayın.
- Yerleşik ağ geçidi OAuth desteği yönergelerini izleyerek yetkilendirme ve belirteç URL'lerini, genel istemci kimliğini, kapsamları, isteğe bağlı kaynağı, belirteç iletim ayarlarını ve varsa sabit yönlendirme bağlantı noktasını toplayın. Eşleşen geri döngü yönlendirme URI'sini kimlik sağlayıcınıza kaydedin.
- Dağıtmayı planladığınız CLI veya masaüstü uygulamasında bir test kullanıcısıyla tarayıcıda oturum açmayı, belirteç yenilemeyi ve erişimi iptal etmeyi test edin. Uzak CLI kullanıcıları da dahil olmak üzere tarayıcının geri çağrı adresine erişebildiğini doğrulayın.
Kullanıcılar bireysel olarak oturum açar. İstemci sırrı, ağ geçidi API key'i veya çalıştırılabilir yardımcı dosyası yerine OAuth yapılandırmasını dağıtırsınız. Üst sağlayıcı kimlik bilgilerini ağ geçidinde tutun.
API key'ler veya kimlik bilgisi yardımcıları
- Kullanımı geliştiriciyle ilişkilendirebilmek ve erişimi ayrı ayrı iptal edebilmek için her geliştiriciye kapsamı sınırlandırılmış bir ağ geçidi kimlik bilgisi oluşturun.
- Her kimlik bilgisi için onaylı modelleri, istek sınırlarını, bütçeyi, son geçerlilik tarihini ve yenileme dönemini ayarlayın.
- Kimlik bilgilerini gizli bilgi yöneticiniz veya kurulu bir kimlik bilgisi yardımcısı üzerinden iletin. Üst sağlayıcı ve ağ geçidi yöneticisi kimlik bilgilerini geliştirici makinelerinde tutmayın.
- Bir yardımcı kullanıyorsanız komut destekli kimlik doğrulama sözleşmesini izleyin ve dağıtımdan önce token alma ve yenileme işlemlerini test edin.
- Geliştiricilere kimlik bilgilerini nasıl yenileyeceklerini ve yardım için kiminle iletişime geçeceklerini bildirin.
Codex'i ağ geçidi üzerinden test edin
Herhangi bir şeyi dağıtmadan önce, Sağlayıcıyı yapılandırma yönergelerini izleyerek yalıtılmış tek bir test kullanıcısını dağıtmayı planladığınız sağlayıcı bloğu ve kimlik doğrulama yöntemiyle yapılandırın.
Ağ geçidi model kataloğunu sunuyorsa Codex ile uyumlu bir models dizisi döndürdüğünü doğrulayın. Kullanıcının kimlik bilgisiyle OpenAI çıkarımı yapılırken ağ geçidinin gerekli ChatGPT üstbilgilerini Codex arka ucuna ilettiğini doğrulayın.
Pilot uygulamanız için istemci sürümünü, işletim sistemini, sağlayıcı kimliğini, model takma adını ve kimlik doğrulama yöntemini kaydedin. Aşağıdaki kontrolleri desteklemeyi planladığınız her CLI veya masaüstü arayüzünde çalıştırın. Hem yalnızca ağ geçidiyle kimlik doğrulamayı hem de ChatGPT ile oturum açmanın yanında ağ geçidi kimlik doğrulamasını sunuyorsanız her birleşimi ayrı ayrı test edin.
| Kontrol | İşlem | Başarı kanıtı |
|---|---|---|
| Etkin yapılandırma | Yapılandırma katmanlarını inceleyin ve amaçlanan sağlayıcıyı, modeli ve gereksinimleri doğrulayın. | Pilot uygulama dağıtılan ayarları kullanır. Kullanıcı veya profil varsayılanları farklı bir rota seçmez. |
| Bağlantı | Bağlantıyı doğrulama adımlarını izleyin. | Beklenen sağlayıcı ve takma ad etkindir, test promptu başarılı olur ve ağ geçidi günlükleri test kullanıcısını tanımlar. |
| Akış | Birkaç paragraftan oluşan kısa bir yanıt isteyin. | Metin aşamalı olarak gelir ve etkin aktarım response.completed üretir. Ağ geçidinin SSE olaylarını arabelleğe almadan ilettiğini doğrulamak için HTTP'yi ayrıca test edin. |
| Yerel araç döngüsü | Salt okunur izinlere sahip geçici bir klasörde Codex'ten üst düzey dosyaları listelemesini ve özetlemesini isteyin. | Codex yerel bir araç çağrısı yapar, sonucu döndürür ve düzenleme yapmadan nihai yanıt üretir. |
| Devam sorusu | Aynı konuşmada bir devam sorusu sorun. | Yanıt önceki turu kullanır; ağ geçidi yeniden gönderilen girdiyi kabul eder. WebSocket veya artımlı aktarım etkinse previous_response_id değerini de korur. |
| Hatalar ve ilişkilendirme | Kasıtlı olarak geçersiz bir test takma adı veya süresi dolmuş bir test kimlik bilgisiyle tekrarlayın. | İstemci yararlı bir yönlendirme veya kimlik doğrulama hatası alır ve geçerli istekler test kullanıcısıyla ilişkilendirilmeye devam eder. |
Otomatik onay etkinse, amaçladığınız politika kapsamında inceleme gerektiren bir araç işlemini tetiklemek için geçici bir test klasörü kullanın. Ağ geçidinin inceleme isteğini işlediğini ve istemcinin onay kararını uyguladığını doğrulayın. Onay gerektirmeyen salt okunur bir araç çağrısı bu yolu test etmez. Pilot uygulamayı genişletmeden önce desteklenmeyen iş akışlarını kaydedin.
Kullanıma sunma işlemi mevcut kullanıcıların sağlayıcısını değiştiriyorsa, desteklenen her istemcide yeni bir konuşmayı ve değişiklikten önce oluşturulmuş bir konuşmayı test edin. Kullanıcıların mevcut konuşmayı görüntüleyip görüntüleyemediğini, sürdürebilip sürdüremediğini veya dallandırıp dallandıramadığını kaydedin ve engellenen iş akışları için bir kurtarma prosedürü sağlayın. Varsayılan sağlayıcının değiştirilmesinin konuşma geçmişini taşıdığını varsaymayın.
Bu kontroller başarıyla tamamlandıktan sonra geliştiricilere devri hazırlayın.
Yapılandırmayı dağıtın
Her makinenin aynı bağlantı yolunu kullanmasını sağlamak için ağ geçidi temel URL'sini, sağlayıcı kimliğini, onaylı model takma adını ve kimlik doğrulama ayarlarını dağıtın.
Dağıtılacak öğeler
Yerleşik ağ geçidi OAuth desteği için sağlayıcı tablosunu ve
[model_providers.<id>.gateway_oauth] tablosunu bağlantı
kılavuzundan alıp
yukarıda toplanan kayıt değerleriyle dağıtın. requires_openai_auth = false ayarını koruyun ve
env_key, experimental_bearer_token ile komut tabanlı auth tablosunu
OAuth ağ geçidi için tek kimlik doğrulama yöntemi olduğunda dahil etmeyin.
Kimlik bilgisi yardımcısı için aşağıdaki config.toml bloğunu seçtiğiniz
yapılandırma katmanı üzerinden dağıtın. Codex sürümünüzün tanıdığı bir model kullanın veya
yukarıda açıklanan eşleşen kataloğu sağlayın. Belirteç çözümleyicinizi
yapılandırılmış komut yoluna yükleyin:
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 = 300000Kısa ömürlü statik bir test anahtarı için kimlik doğrulama bloğunu kaldırın, env_key = "CODEX_GATEWAY_API_KEY" değerini [model_providers.enterprise-gateway] içine yerleştirin ve bu değişkeni TOML dışında ayarlayın. env_key ile komut destekli kimlik doğrulamayı birlikte kullanmayın.
Varsayılanları ve gereksinimleri dağıtın
Kullanıcılarınız Codex'te ChatGPT ile oturum açmıyorsa, ekip ayarlarını kendi sunucunuzdan dağıtabilirsiniz. Codex bu ayarları, model isteklerini nasıl yönlendirdiğinizden bağımsız olarak alır.
Varsayılanları nereye dağıtacağınızı seçmek için Yapılandırma önceliği sayfasını kullanın. Zorunlu kılınan ayarlar ve macOS MDM yükleri için Yönetilen yapılandırma sayfasına bakın.
macOS veya Linux'ta makine genelindeki varsayılanlar için /etc/codex/config.toml kullanın.
Windows'ta config.toml dosyasını %ProgramData%\OpenAI\Codex\ konumuna yerleştirin. Kullanıcılar ve
profiller bu varsayılanları geçersiz kılabilir. Bağlantı verilen kaynaklar, desteklenen
gereksinimleri ve dosya konumlarını açıklar.
Başvurulan tüm yardımcı yürütülebilir dosyaları ve yerel katalog dosyalarını ayrı olarak dağıtın.
Uzak bir katalog URL'sini zorunlu kılmak için eksiksiz sağlayıcı tanımını
requirements.toml içinde, [model_providers.<id>] altında belirtin. Zorunlu kılınan sağlayıcı
tanımı, normal yapılandırmadaki eşleşen sağlayıcı tablosunun yerini alır;
base_url değerini, kimlik doğrulama ayarlarını ve diğer gerekli alanları ekleyin.
Sağlayıcı seçimini de zorunlu kılmanız gerekiyorsa model_provider gereksinimini kullanın.
model_catalog_json, yerel bir JSON dosyasını işaret eder. Bunu
requirements.toml üzerinden zorunlu kılarsanız gereksinim yolu sabitler; dosyayı
dağıtmaz. Codex başlamadan önce kataloğu bu mutlak yola yerleştirin.
TOML'de çözümlenmiş mutlak Windows yollarını yazın. Codex,
%ProgramData% ifadesini model_catalog_json veya sağlayıcı kimlik doğrulamasının command değerleri içinde genişletmez.
Örneğin aşağıdaki yolları yalnızca dağıtımınız dosyaları buralara yerleştirdiyse kullanın:
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"]WSL içindeki bir CLI, Linux yollarını ve Linux CODEX_HOME konumunu okur; yerel Windows yapılandırmasını otomatik olarak
devralmaz.
Yönlendirme başlıklarını dağıtın
Ağ geçidiniz istekleri yapılandırmaya veya araca göre yönlendiriyorsa, beklediği başlıkları yönettiğiniz requirements.toml dosyasındaki sağlayıcıya ekleyin. Aşağıdaki örnek bir yönlendirme yapılandırması kimliği sağlar ve istemciyi Codex olarak tanımlar:
[model_providers.enterprise-gateway.http_headers]
x-portkey-config = "<gateway-routing-config-id>"
x-portkey-metadata = '{"tool_id":"codex"}'İstemci ortamından sağlanan başlık değerleri için env_http_headers kullanın. Bir test isteği gönderin ve seçilen rotayı ağ geçidi günlüklerinde doğrulayın. Başlık seçenekleri için Özel model sağlayıcıları bölümüne bakın.
Yapılandırma değerlerini geliştiricilere iletin
Geliştiricilere, test ettiğiniz pilot uygulamayla eşleşen tek bir kurulum yolu sunun. Yapılandırmayı merkezi olarak dağıtsanız bile aşağıdaki bilgileri ekleyin:
| Devir öğesi | Sağlanacak bilgiler |
|---|---|
| Onaylı istemci | Pilot uygulamada kullanılan istemci, sürüm, işletim sistemi ve kurulum veya güncelleme talimatları. |
| Yapılandırmanın dağıtımı | Ayarların zaten yönetilip yönetilmediği veya yerel kurulum gerektirip gerektirmediği; ayrı olarak yüklenen yardımcı programları veya katalog dosyalarını belirtin. |
| Beklenen bağlantı | Sağlayıcı kimliği, model takma adı ve API yolu dahil ağ geçidi URL'si. Kullanıcıların hangi değerleri değiştirebileceğini açıklayın. |
| Oturum açma adımları | Kullanıcıların bir ChatGPT çalışma alanında oturum açması mı, ağ geçidinde kimlik doğrulaması mı, yoksa her ikisini de yapması mı gerektiği. Gerekli çalışma alanını ve ağ geçidi kimlik doğrulama yöntemini belirtin. |
| Kimlik bilgileri ve kataloglar | OAuth kayıt değerleri, kimlik bilgisi ortam değişkeni veya yüklü yardımcı program yapılandırması ile varsa katalog URL'si ya da çözümlenmiş yerel yol. Gizli bilgileri onaylı gizli bilgi dağıtım mekanizmanız üzerinden iletin. |
| Doğrulama ve destek | Bağlantı testi, beklenen sonuç, ağ geçidi sorumlusu ve bir hata bildirilirken eklenecek bilgiler. |
Yönetilen makineler için geliştiricileri Mevcut yapılandırmayı kontrol etme bölümüne yönlendirin. Manuel kurulum için Sağlayıcıyı yapılandırma bölümüne yönlendirin.
Bu kullanıma sunma işlemi sağlayıcıyı değiştiriyorsa mevcut konuşmalar için test ettiğiniz talimatları ekleyin. Pilot uygulamanın bir sorun ortaya çıkarması durumunda önceki çalışan yapılandırmayı kullanıma sunma sorumlusunun erişimine açık tutun.
Manuel kurulum, ayarları zorunlu kılma kanalı değildir. Projeye yerel .codex/config.toml, hassas sağlayıcı veya kimlik doğrulama yönlendirme anahtarlarını geçersiz kılamaz.
Bir geliştirici makinesinden doğrulayın
Dağıtılan ayarların bir geliştirici makinesine ulaştığını doğrulamak için:
- Onaylı istemcinin ve gerekli yardımcı program veya katalog dosyalarının yüklü olduğunu doğrulayın. Codex'i yeniden başlatın ve devir talimatlarındaki oturum açma adımlarını tamamlayın.
- Beklenen sağlayıcıyı ve modeli doğrulayın. CLI'da
/statuskullanın. Etkin ayarlar devir bilgilerinden farklı olduğunda yapılandırma katmanlarını incelemek için/debug-configkullanın. - Ağ geçidine bağlanma bölümündeki kısa testi çalıştırın.
- Konuşmanın devam ettiğini doğrulamak için bir devam sorusu sorun, ardından ağ geçidi günlüklerinde ilgili geliştiricinin isteğini kontrol edin.
Pilot uygulama, desteklediğiniz istemci ve kimlik doğrulama birleşimlerinde başarıyla tamamlandıktan sonra erişimi genişletin. İstemci, ağ geçidi veya politika güncellemelerinden sonra kontrolleri tekrarlayabilmek için test edilen yapılandırmayı ve sonuçları kullanıma sunma talimatlarınızla birlikte saklayın.
Kullanıma sunma hatalarını giderin
Müdahale gerektiren yapılandırma, kimlik bilgisi veya ağ geçidi katmanını bulmak için sorunu temel alın:
| Sorun | Çözüm |
|---|---|
| Yeniden başlatmanın ardından beklenen sağlayıcı görünmüyor. | Öncelik kazanan yapılandırma katmanını inceleyin. Kullanıcı veya profil yapılandırması sistem varsayılanlarını geçersiz kılabilir. |
| Kimlik doğrulama tüm kullanıcılar için başarısız oluyor. | Ağ geçidi kimlik doğrulamasını ve üst sağlayıcı kimlik bilgisini kontrol edin; isteği hangi hizmetin reddettiğini belirleyin. |
| Kimlik doğrulama bir kullanıcı için başarısız oluyor. | Bu kullanıcının kimlik sağlayıcısına erişimini, ağ geçidi kimlik bilgisini veya belirteç çözümleyicisini kontrol edin. |
| Akış takılıyor. | Ağ geçidinin arabelleğe alma davranışını ve akışı sonlandıran response.completed olayının iletimini inceleyin. |
| Bir model eksik veya genel yetenekleri kullanıyor. | Özel bir takma ad için ağ geçidi takma adının, Codex model değerinin ve katalogdaki slug değerinin eşleştiğini doğrulayın. Katalog yolunu ve yüklü Codex sürümüyle uyumluluğunu kontrol edin, ardından Codex'i yeniden başlatın. |
| Bir Windows yolu çalışmıyor. | Çözümlenmiş mutlak yollar kullanın. TOML'de tek ters eğik çizgi içeren Windows yolları için tek tırnaklı dizeler kullanın. |
Mevcut bir ağ geçidi dağıtımını yeniden kullanın
Kuruluşunuz Claude Code'u zaten bir ağ geçidi üzerinden kullanıyorsa ağ geçidi
ürününü, ağ yolunu, günlük kaydını ve Bedrock erişimini yeniden kullanabilirsiniz. Mevcut
çalışan kurulumu koruyarak Codex'e yönelik bir Responses rotası, kimlik bilgisi, model takma adları ve config.toml ekleyin.
Claude istemci ayarları ve
/v1/messages sözleşmesi Codex'i yapılandırmaz.
| Mevcut Claude dağıtımı | Codex'e geçiş |
|---|---|
| Ağ geçidi ürünü, DNS, TLS, özel ağ bağlantıları, günlük kaydı, hassas bilgi maskeleme ve izleme | Bu hizmetleri koruyun. Ağ geçidi uyumluluk gereksinimlerini karşılayan, Codex'e yönelik bir rota ekleyin. |
| Bedrock hesabı, sağlayıcı kimlik bilgisi, IAM sınırı, çıkarım profilleri ve kimlik bilgisi rotasyonu | Bunları yalnızca yeni Codex takma adlarının arkasındaki üst sağlayıcı modellerine erişim yetkisi veriyorlarsa koruyun. Sağlayıcı kimlik bilgisi ağ geçidinde kalır. |
Claude /v1/messages rotası, Bedrock InvokeModel biçimi, Anthropic üstbilgileri ve Claude'a özgü yeniden denemeler veya hatalar |
Bunları uyumluluk kanıtı olarak yeniden kullanmayın. Codex; POST /v1/responses, Responses akışı, konuşmayı sürdürme, araç çağrıları ve yararlı hata iletileri gerektirir. |
ANTHROPIC_AUTH_TOKEN, ANTHROPIC_API_KEY veya apiKeyHelper |
Codex, apiKeyHelper desteği sunmaz. Yerleşik ağ geçidi OAuth desteğini, env_key ile kapsamı sınırlandırılmış bir anahtarı veya Codex komut tabanlı belirteç çözümleyicisini yapılandırın. |
Claude model adları, ANTHROPIC_MODEL, ANTHROPIC_DEFAULT_*_MODEL, modelOverrides ve Bedrock profil eşlemeleri |
Ağ geçidi ekibinizin model adlarını seçmesini ve varsa özel takma adları yapılandırmasını sağlayın. Ekibin sağladığı model adını ve varsa model kataloğu JSON dosyasını kullanın. |
Claude settings.json, managed-settings.json, JSON env blokları, plist veya kayıt defteri yükleri |
Aynı MDM veya yapılandırma yönetimi kanalını koruyun, ancak bunun yerine Codex config.toml dosyasını ve desteklenen requirements.toml değerlerini dağıtın. |
Güvenli bir geçiş için şu adımları sırayla tamamlayın:
- Mevcut Claude yolunun envanterini çıkarın: ağ geçidi URL'si, kimlik bilgisi kaynağı, gerekli başlıklar, model takma adları, Bedrock profil eşlemeleri ve yönetilen dağıtım kanalı.
- Codex'e yönelik paralel bir Responses rotası ve Codex model takma adları ekleyin.
- Ağ geçidinin yerleşik OAuth yöntemini, bir API key veya kimlik bilgisi yardımcı programını seçin ve bir test kullanıcısını yetkilendirin. Statik bir kimlik bilgisini
env_keyüzerinden sunun; yardımcı program için Codex'in komut tabanlı çözümleyici sözleşmesini uygulayın ve test edin. - Üçüncü adımda seçtiğiniz kimlik doğrulama yöntemini kullanarak ilgili geliştirici için sağlayıcıyı yapılandırın. Yönetilen bir kullanıma sunma işleminde, yükü Ağ geçidini kullanıma sunma bölümünde açıklanan Codex yollarına ve öncelik sırasına uyarlayın.
- Geliştiricinin kullandığı gerçek CLI veya masaüstü arayüzünde kısa bağlantı kontrolünü çalıştırın, ardından Codex'i ağ geçidi üzerinden test etme bölümündeki akış, devam, araç çağrısı, hata, günlük kaydı ve takma ad yönlendirme kontrollerinin tamamını çalıştırın.
- Pilot uygulama başarıyla tamamlandıktan sonra kalan geliştiricilere yapılandırmayı dağıtın.
Model kataloğu başvuru kaynağı
Yerel bir models.json dosyasıyla başlayın
Önce Codex'i çalıştırdığınız makinede ağ geçidi sağlayıcınızı yapılandırın ve seçin.
Bu kataloğu Codex'in çalıştığı makinede models.json olarak kaydedin.
gateway-model yerine ağ geçidinizin kabul ettiği model kimliğini tam olarak yazın. Görünen ad,
kullanıcıların model seçicide gördüğü etikettir.
{
"models": [
{
"slug": "gateway-model",
"display_name": "Gateway model",
"base_instructions": "Help the user with their coding tasks.",
"supported_reasoning_levels": [],
"shell_type": "shell_command",
"visibility": "list",
"supported_in_api": true,
"priority": 0,
"support_verbosity": false,
"truncation_policy": { "mode": "tokens", "limit": 10000 },
"experimental_supported_tools": []
}
]
}Daha kapsamlı bir örnek için Codex'in model kataloğuna bakın.
model_catalog_json ayarını config.toml içinde dosyanın mutlak yoluna ayarlayın.
Codex'i yeniden başlatın, Gateway model seçeneğini seçin ve bir istek gönderin.
Ağ geçidinin slug alanında belirlediğiniz model kimliğini aldığını kontrol edin.
Birlikte gelen bir modelin takma adı için, kullandığınız Codex sürümüne ait
katalog kaydının tamamını kopyalayın ve slug ile display_name değerlerini değiştirin. Takma adın geçiş hedefi yoksa upgrade değerini null olarak ayarlayın. Bu işlem modelin
bağlam penceresini, akıl yürütme seçeneklerini ve araç ayarlarını korur.
İstemcilere katalog sunun
Bu sayfa, model kataloğunu tanımlayan ve model seçicinin çalışmasını sağlayan Codex Models biçimini uygulayan geliştiricilere yöneliktir. Ağ geçidi veya bulut hizmeti gibi bir çıkarım sağlayıcısı geliştiriyorsanız, Codex masaüstü uygulamasının ve CLI'ın modellerinizi keşfetmesini, bunların talimatlarını ve yetenek ayarlarını kullanmasını sağlamak için bu belirtimi kullanın.
Bir kuruluşu yönetiyorsanız ve model kataloğunu kontrol etmek istiyorsanız,
model_catalog_url yapılandırma kılavuzuna bakın.
Bu biçimi desteklemek için kimlik doğrulamalı bir katalog uç noktası uygulayın. İstekte bulunan Codex sürümü için üst sağlayıcınızın güncel varsayılanlarını alın, kendi değişikliklerinizi uygulayın ve oluşan kataloğu döndürün.
client_version Katalog uç noktasını uygulayın
Varsayılan katalog uç noktası, sağlayıcının /models yoludur ve base_url altında bulunur.
Örneğin, base_url = "https://gateway.example.com/v1" olduğunda Codex şu isteği gönderir:
GET /v1/models?client_version=0.162.1
Authorization: Bearer <PROVIDER_ACCESS_TOKEN>Varsayılan keşif, komut tabanlı kimlik doğrulamayı ve ChatGPT gibi Codex arka ucu üzerinden
kimlik doğrulamayı destekler. Komut tabanlı kimlik doğrulama olmadan API key ile kimlik doğrulama kullanan
özel bir sağlayıcıda uzaktan keşfi etkinleştirmek için model_providers.<id>.model_catalog_url ayarını
açıkça belirtin. Tek başına bir API key, varsayılan yolda keşfi
tetiklemez.
Tam bir katalog URL'si seçmek için model_catalog_url kullanın; örneğin
https://gateway.example.com/codex/models. Bu ayar, varsayılan
/v1/models uç noktasını da gösterebilir. Codex, /models eklemeden bu URL'yi doğrudan kullanır.
API key ile keşif için features.api_key_model_discovery ayarını etkin tutun; bu ayar
varsayılan olarak açıktır. Özel üstbilgiler tek başına keşfi etkinleştirmez.
Codex, seçilen sağlayıcının kimlik doğrulama bilgilerini ve yapılandırılmış üstbilgileri gönderir ve
client_version ile sağlayıcının varsa query_params değerlerini ekler. Kataloğu, bu kimlik bilgilerini
almaya yetkili bir hizmette barındırın.
İstekte bulunanın kimliğini doğrulayın, ilgili üst sağlayıcı varsayılanlarını alın, kendi
değişikliklerinizi uygulayın ve ModelsResponse JSON'unun tamamını doğrudan döndürün. Her
kayda benzersiz ve boş olmayan bir slug verin. Açıkça belirtilmiş bir model_catalog_url için Codex,
yönlendirmeleri ve 1 MiB'tan büyük yanıtları reddeder. Çıkarım isteklerinde model erişim
denetimini uygulamaya devam edin.
Uç noktayı kullanan istemcilerden yürürlükteki tüm model_catalog_json ayarlarını kaldırın:
yerel dosya önceliklidir ve uzaktan veri alınmasını engeller.
İstemcinin şemasına uyum sağlayın
Katalog isteğindeki client_version sorgu parametresini okuyun. Codex,
CLI sürümünü ön sürüm son ekleri kaldırılmış olarak major.minor.patch biçiminde gönderir. Masaüstü
istemcilerinde bu, uygulamayla birlikte gelen CLI sürümüdür.
Herkese açık Codex deposundaki eşleşen rust-v<version> etiketini veya özel bir derleme için
tam kaynak commit'ini kullanın. Bu bağlantılar rust-v0.162.1 kullanır;
istemcinizle eşleşen revizyonu seçin:
- Şema için
ModelsResponseveModelInfoyanıt türlerini okuyun. - Eksiksiz bir örnek için pakete dahil edilen
models.jsondosyasını inceleyin. Bu dosya bir JSON Schema belgesi değil, katalog verisidir.
Pakete dahil edilen dosya, bir sürümün anlık görüntüsüdür. Kataloğunuzu oluşturmadan önce güncel varsayılanları alın.
Üst sağlayıcının güncel varsayılanlarını alın
OpenAI modellerini sunan bulut sağlayıcıları, varsayılanları OpenAI'dan alır. Ağ geçitleri, dağıtılan modelin ayarlarını ve hesap ve bölge bazında kullanılabilirliğini korumak için bulut sağlayıcılarının veya üst sağlayıcılarının kataloğunu okur. İstekte bulunan Codex sürümünü her adımda iletin ve her uç noktada ayrı ayrı kimlik doğrulaması yapın.
Varsayılanları doğrudan OpenAI'dan almak için Codex model uç noktasını
aynı client_version değeriyle çağırın. Örneğin, bir OpenAI API key ile:
curl --fail --silent --show-error \
'https://chatgpt.com/backend-api/codex/models?client_version=0.162.1' \
-H "Authorization: Bearer $OPENAI_API_KEY"ChatGPT entegrasyonu için istekte bulunanın ChatGPT erişim belirtecini ve
uygun durumlarda ChatGPT-Account-ID üstbilgisini kullanın. Üst sağlayıcının uç noktası için
yetkilendirilmiş kimlik bilgilerini kullanın; ağ geçidinizin kendi API key değeri OpenAI'da kimlik doğrulaması sağlamaz.
En üst düzeydeki models dizisi dahil, yanıtın tamamını ayrıştırın. Bu uç nokta,
talimatlar, akıl yürütme varsayılanları, araç ayarları,
bağlam sınırları ve hizmet katmanları gibi Codex meta verilerini döndürür. Herkese açık /v1/models uç noktası
bu kataloğu sağlamaz.
Codex sürümü değişmemiş olsa bile bu varsayılanları yenileyin. İstekleri hedeflenen üst sağlayıcı kimliğiyle sınırlı tutun ve yanıtın önbellek denetimlerine uyun: kataloglar, istekte bulunanın erişimine bağlı olabilir. Kendi değişikliklerinizi ayrı tutun; böylece bunları güncel varsayılanlara yeniden uygulayabilirsiniz.
Sağlayıcıya özgü değişiklikleri uygulayın
Sürümün yanıt yapısını koruyarak alan değerlerini değiştirin:
- Modelleri, istekte bulunanın kullanabilecekleriyle sınırlayın. Her
slugdeğerini desteklenen bir çıkarım rotasıyla eşleştirin vedisplay_name,descriptionveyaprioritydeğerlerini ayarlayın. Model geçişi içermeyen bir takma ad içinupgradedeğerininullolarak ayarlayın. - Akıl yürütme seçeneklerini, bağlam sınırlarını, girdi türlerini ve hizmet katmanlarını
modelinizin ve rotanızın desteklediği değerlere ayarlayın. Varsayılanları desteklenen
seçeneklerle sınırlı tutun. Hizmet katmanları olmayan bir rota için
service_tiersveadditional_speed_tiersalanlarını temizleyin vedefault_service_tierdeğerininullolarak ayarlayın. - Yerine kullanılacak alternatifleri test etmediyseniz üst sağlayıcının talimatlarını ve araç ayarlarını koruyun. Meta veriler, modele yeni yetenekler eklemez veya çıkarım erişimi vermez.
Bir ağ geçidi model takma adı için model meta verilerinin nasıl sağlanacağını inceleyin. Oluşan kataloğu desteklenen her Codex sürümüyle test edin.
Herkese açık Rust türlerini kullanın
İstemcinin şemasıyla aynı herkese açık Git etiketindeki veya commit'indeki crate'leri kullanın:
codex_protocol::openai_models::{ModelsResponse, ModelInfo}içincodex-protocolkullanın.serde_json::from_slice::<ModelsResponse>()ile ayrıştırın,catalog.modelsüzerinde düzenleme yapın ve sarmalayıcının tamamınıserde_json::to_vec()ile serileştirin. Sarmalayıcı, model talimatlarının uyumluluk alanlarını işler.- İlgili revizyonun pakete dahil edilen statik kataloğunu
ModelsResponseolarak yüklemek içincodex-models-manager::bundled_models_response()kullanın. Bu işlev, üst sağlayıcının güncel varsayılanlarını almaz.