Codex'i bir ağ geçidi üzerinden dağıtın

Codex'i kuruluşunuzun LLM ağ geçidi üzerinden dağıtın. Model rotalarını yapılandırın, geliştirici kimlik bilgilerini oluşturun ve doğrulanmış bir Codex yapılandırmasını dağıtı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 adresinde HTTPS üzerinden hizmet veren bir ağ geçidi.
  • Ağ geçidinde tutulan bir üst sağlayıcı kimlik bilgisi.
  • Hedeflenen üst sağlayıcı modelleriyle eşleştirilmiş, Codex'e sunulan onaylı model takma adları.
  • Kapsamı sınırlandırılmış bir test ağ geçidi kimlik bilgisi.
  • Bir gizli bilgi iletim mekanizması veya test edilmiş bir kimlik bilgisi yardımcısı.
  • Yapılandırmayı, yardımcı yürütülebilir dosyaları ve varsa 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/responses adresinde Codex Responses API isteklerini kabul etme.
  • SSE olaylarını arabelleğe almadan akış halinde iletme ve akışı response.completed ile sonlandırma.
  • Yeniden gönderilen girdiyle sonraki turlarda konuşmanın devamını koruma.
  • previous_response_id davranışı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:

  1. Model adlarını seçin ve rotaları doğrulayın.
  2. Geliştirici kimlik bilgilerini oluşturun.
  3. Codex'i ağ geçidi üzerinden test edin.
  4. Yapılandırmayı dağıtın.
  5. 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çidindeki model adı Codex yapılandırması
Codex sürümünüzde bulunan bir yerleşik model adı model değerini config.toml içinde tam olarak bu ada ayarlayın.
company-coding-model gibi özel bir takma ad model_catalog_json değerini, takma adı ve ilgili modelin meta verilerini içeren bir kataloğa ayarlayın.

Özel adlar için model kataloğu kullanın

Ağ geçidiniz Codex'in tanımadığı bir model adı kullanıyorsa model_catalog_json kullanı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 kayıt olmadığında, Codex genel ayarları kullanırken istek hedeflenen üst sağlayıcı modeline ulaşabilir.

Örneğin, company-coding-model adını gpt-6-luna için takma ad olarak kullanmak üzere:

  1. Ağ geçidinde company-coding-model takma adını oluşturun ve bunu onaylı üst sağlayıcı modeli gpt-6-luna hedefine yönlendirin.
  2. Codex sürümünüze ait Codex model kataloğunu indirin ve bir kopyasını gateway-models.json olarak kaydedin. Başlangıç noktası olarak bu dosyayı kullanın.
  3. Kopyanızdaki gpt-6-luna kaydını düzenleyin: slug değerini company-coding-model olarak ayarlayın ve kalan meta verilerin üst sağlayıcı modeliyle ve ağ geçidinin yetenekleriyle eşleştiğini kontrol edin. Model geçişi olmayan bir takma ad için upgrade değerini null olarak ayarlayın.
  4. Kayıtları üst düzey models dizisinde tutun ve dosyayı her istemciye dağıtın. Özel katalog, paketle gelen kataloğun yerini alır; bu nedenle kullanıcıların seçmesi gereken her modeli ekleyin.

LiteLLM üzerinden Bedrock kullanırken gerekli katalog düzenlemelerini uygulayın.

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.

Geliştirici kimlik bilgilerini oluşturun

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. 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, dağıtmayı planladığınız sağlayıcı bloğu ve kimlik bilgisi mekanizmasıyla yalıtılmış bir test kullanıcısını yapılandırmak için Bir ağ geçidine bağlanın sayfasını izleyin.

Aşağıdaki kontrolleri geliştiricilerin kullanacağı CLI veya masaüstü arayüzünden çalıştırın:

Kontrol İşlem Başarı kanıtı
Bağlantı Bağlantıyı doğrulayın adımlarını izleyin. Beklenen sağlayıcı ve takma ad etkindir, test promptu başarıyla tamamlanır ve ağ geçidi günlükleri test kullanıcısını tanımlar.
Akış Birkaç kısa paragraftan oluşan bir yanıt isteyin. Ağ geçidi SSE olaylarını arabelleğe almadan iletir, metin parça parça gelir ve akış response.completed ile sona erer.
Yerel araç döngüsü Salt okunur izinlere sahip, sonradan silinebilecek 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 turu 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 davranışını da korur.
Hatalar ve kullanıcıyla 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.

Bu kontroller başarıyla tamamlandıktan sonra geliştiricileri kendi makinelerini yapılandırıp doğrulamaları için Bir ağ geçidine bağlanın sayfasına yönlendirin.

Yapılandırmayı dağıtın

Her makinenin aynı bağlantı yolunu kullanması için ağ geçidi temel URL'sini, sağlayıcı kimliğini, onaylı model takma adını ve kimlik bilgisi mekanizmasını dağıtın.

Dağıtılacak öğeler

Sağlayıcı varsayılanlarını ayarlamak için bu 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. Token çözümleyicinizi yapılandırılan 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 = 300000

Kı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

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 yardımcı yürütülebilir dosyaları ve katalog dosyalarını ayrı olarak dağıtı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.

Yapılandırma değerlerini geliştiricilere iletin

Yönetilen dağıtımınız yoksa her geliştiriciye ağ geçidi URL'sini, sağlayıcı kimliğini, model takma adını, kimlik bilgisi değişkenini veya çözümleyicisini ve varsa katalog yolunu verin. Kendi makinelerini yapılandırıp doğrulamaları için onları Bir ağ geçidine bağlanın sayfasına yönlendirin.

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:

  1. Codex'i yeniden başlatın ve beklenen sağlayıcı ile modeli doğrulayın.
  2. Bir ağ geçidine bağlanın sayfasındaki kısa testi çalıştırın.
  3. Konuşmanın devam ettiğini doğrulamak için bir devam sorusu sorun, ardından bu geliştiricinin isteğini ağ geçidi günlüklerinde kontrol edin.

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şlatma sonrasında beklenen sağlayıcı eksik. Öncelikli 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 ağ geçidi kimlik bilgisini veya token çözümleyicisini kontrol edin.
Akış takılıyor. Ağ geçidinin arabelleğe alma davranışını ve sonlandırıcı 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'in model değerinin ve katalogdaki slug değerinin eşleştiğini doğrulayın. Katalog yolunu ve kurulu 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ğ, günlük kaydı, hassas bilgilerin maskelenmesi 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 yetki veriyorlarsa koruyun. Sağlayıcı kimlik bilgisi ağ geçidinde kalır.
Claude /v1/messages rotası, Bedrock InvokeModel biçimi, Anthropic üst bilgileri ve Claude'a özgü yeniden denemeler veya hatalar Bunları uyumluluk kanıtı olarak yeniden kullanmayın. Codex; POST /v1/responses, Responses akışı, konuşmanın devamı, araç çağrıları ve yararlı hatalar gerektirir.
ANTHROPIC_AUTH_TOKEN, ANTHROPIC_API_KEY veya apiKeyHelper Codex, apiKeyHelper desteği sunmaz. Kapsamı sınırlandırılmış bir Codex ağ geçidi kimlik bilgisi oluşturun ve bunu env_key veya Codex'in komut destekli token çözümleyicisiyle yapılandırın.
Claude model adları, ANTHROPIC_MODEL, ANTHROPIC_DEFAULT_*_MODEL, modelOverrides ve Bedrock profil eşlemeleri Ağ geçidi ekibinizden model adlarını seçmesini ve varsa özel takma adları yapılandırmasını isteyin. 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:

  1. Mevcut Claude yolunun envanterini çıkarın: ağ geçidi URL'si, kimlik bilgisi kaynağı, gerekli üst bilgiler, model takma adları, Bedrock profil eşlemeleri ve yönetilen iletim kanalı.
  2. Codex'e yönelik paralel bir Responses rotası ve Codex model takma adları ekleyin.
  3. Kapsamı sınırlandırılmış bir Codex kimlik bilgisi oluşturun. Codex statik bir kimlik bilgisi kullanacaksa bu yeni kimlik bilgisini env_key üzerinden sunun; Claude bir kimlik bilgisi yardımcısı kullanıyorsa Codex'in komut destekli çözümleyici sözleşmesini uygulayın ve test edin.
  4. Bu geliştiriciyi sağlayıcı bloğuyla yapılandırın. Yönetilen bir kullanıma sunma sürecinde yükü, Codex'i bir ağ geçidi üzerinden dağıtın sayfasında açıklanan Codex yollarına ve öncelik sırasına uyarlayın.
  5. Geliştiricinin gerçekten kullandığı 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 edin bölümündeki akış, konuşmanın devamı, araç çağrısı, hata, günlük kaydı ve takma ad yönlendirme kontrollerinin tamamını çalıştırın.
  6. Pilot çalışma başarıyla tamamlandıktan sonra kalan geliştiricilere yapılandırmayı dağıtın.

İlgili belgeler