Kết nối với cổng LLM

Kết nối Codex với một cổng LLM bằng URL cổng, bí danh mô hình và thông tin xác thực hoặc trình phân giải token do tổ chức của bạn cung cấp.

Kiểm tra cấu hình hiện có

Trước khi thêm bất kỳ nội dung nào, hãy kiểm tra xem quản trị viên đã cấu hình Codex hay chưa.

• Với CLI, kiểm tra hồ sơ đã chọn và chạy codex doctor. Sau khi khởi động, dùng /status để xác nhận mô hình và nhà cung cấp đang hoạt động.
• Với ứng dụng macOS, kiểm tra ~/.codex/config.toml hoặc cấu hình được quản lý do tổ chức của bạn cung cấp.
• Với ứng dụng Windows, kiểm tra %USERPROFILE%\.codex\config.toml hoặc cấu hình hệ thống do tổ chức của bạn cung cấp.

Nếu nhà cung cấp cổng và mô hình mong đợi đã hoạt động, hãy chuyển đến Xác minh kết nối.

Lấy thông tin kết nối cổng

Cài đặt Codex CLI hoặc ứng dụng máy tính được tổ chức của bạn phê duyệt. Để tự cấu hình Codex, hãy lấy các giá trị sau từ nhóm phụ trách cổng:

• URL cơ sở HTTPS của cổng, bao gồm đường dẫn API, chẳng hạn như https://gateway.example.com/v1.
• Tên mô hình và ID nhà cung cấp cần sử dụng.
• Thông tin xác thực cổng có phạm vi quyền hạn xác định và biến môi trường tương ứng, hoặc một trình phân giải token đã được cài đặt cùng cấu hình của nó.
• Tệp danh mục mô hình bắt buộc, nếu có, và đường dẫn cục bộ tuyệt đối của tệp.

Cấu hình nhà cung cấp

Mở config.toml tại ~/.codex/config.toml trên macOS hoặc Linux, hoặc %USERPROFILE%\.codex\config.toml trên Windows.

Hợp nhất ví dụ này vào cấu hình hiện có, thay URL và mô hình bằng các giá trị quản trị viên đã cung cấp. Không thêm định nghĩa thứ hai cho một khóa hoặc bảng hiện có. Ví dụ này sử dụng gpt-6-sol; chỉ sử dụng mà không có danh mục tùy chỉnh nếu quản trị viên xác nhận rằng phiên bản Codex của bạn nhận diện được mô hình và siêu dữ liệu đi kèm của mô hình khớp với cổng.

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"

Nếu quản trị viên cung cấp danh mục mô hình, hãy lưu danh mục đó cục bộ và thêm model_catalog_json trước bảng TOML đầu tiên, sử dụng đường dẫn tuyệt đối của tệp. Bí danh tùy chỉnh cần siêu dữ liệu danh mục tương ứng. Ví dụ:

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

Sử dụng tên mô hình và danh mục được quản trị viên cung cấp cùng nhau. Không thêm đường dẫn danh mục trừ khi tệp tồn tại tại vị trí đó.

enterprise-gateway là ID nhà cung cấp dùng để minh họa. Sử dụng cùng một ID trong model_provider, [model_providers.<id>] và [model_providers.<id>.auth]. Ví dụ này tắt tính năng tìm kiếm trên web cho lần kiểm tra kết nối ban đầu; quản trị viên nên xác minh khả năng hỗ trợ tính năng trước khi bật.

Cung cấp thông tin xác thực cổng dưới dạng CODEX_GATEWAY_API_KEY trong môi trường của tiến trình khởi chạy Codex, sử dụng cơ chế phân phối thông tin bí mật của tổ chức. Không đặt thông tin xác thực trong TOML hoặc kho lưu trữ. Một biến được đặt trong terminal có thể không khả dụng với ứng dụng được khởi chạy từ màn hình nền.

Sử dụng tiêu đề xác thực tùy chỉnh

Nếu cổng yêu cầu một tiêu đề như X-API-Key thay vì bearer token, thay env_key trong bảng nhà cung cấp bằng:

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

Sử dụng chính xác tên tiêu đề do quản trị viên cung cấp. Codex đọc giá trị từ biến môi trường có tên đó; không đưa thông tin xác thực vào tệp cấu hình. Xem tài liệu tham khảo cấu hình để biết về model_providers.<id>.env_http_headers.

Sử dụng công cụ hỗ trợ thông tin xác thực của tổ chức

Nếu quản trị viên cung cấp cơ chế xác thực thông qua lệnh, hãy sử dụng công cụ hỗ trợ đã cài đặt và cấu hình của họ thay cho env_key. Không cấu hình đồng thời cả hai cơ chế. Công cụ hỗ trợ phải có sẵn trên máy của bạn; Codex không cài đặt công cụ đó. Ví dụ, thay cài đặt env_key trong ví dụ bằng bảng này, sử dụng đường dẫn trình phân giải và các đối số do quản trị viên cung cấp:

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

Tài liệu tham khảo về xác thực nhà cung cấp tùy chỉnh quy định lệnh, đối số, thời gian chờ, khoảng thời gian làm mới và quy ước đầu ra token. Hỏi quản trị viên cách gia hạn phiên đăng nhập nếu công cụ hỗ trợ không còn lấy được token.

Sử dụng đường dẫn tuyệt đối đã được phân giải cho tệp thực thi của công cụ hỗ trợ và tệp danh mục.

Cấu hình CLI

Theo mặc định, CLI đọc ~/.codex/config.toml trên macOS hoặc Linux. Sau khi lưu cài đặt nhà cung cấp, chạy codex. Trong WSL, sử dụng cấu hình và đường dẫn Linux trừ khi CODEX_HOME trỏ đến nơi khác.

Cấu hình ứng dụng macOS

Ứng dụng macOS đọc cùng tệp ~/.codex/config.toml. Sau khi lưu cài đặt nhà cung cấp, hãy khởi động lại ứng dụng. Nếu sử dụng biến môi trường cho thông tin xác thực, hãy bảo đảm tiến trình ứng dụng có thể truy cập biến đó.

Cấu hình ứng dụng Windows

Đặt cài đặt nhà cung cấp trong %USERPROFILE%\.codex\config.toml, rồi khởi động lại ứng dụng. Với cơ chế xác thực thông qua lệnh, sử dụng trình phân giải do quản trị viên cài đặt. Ví dụ, thay bảng xác thực Unix bằng:

[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

Trong TOML trên Windows, chuỗi nguyên văn đặt trong dấu nháy đơn giữ nguyên dấu gạch chéo ngược. Đồng thời thay các đường dẫn danh mục Unix, ví dụ bằng 'C:\ProgramData\OpenAI\Codex\models.json', sử dụng đường dẫn thực tế do quản trị viên cung cấp.

Cấu hình MCP servers và plugin riêng. Thông tin xác thực cổng mô hình không cấp quyền truy cập vào các công cụ hoặc hệ thống được kết nối của bạn.

Xác minh kết nối

Khởi động lại ứng dụng khách sau khi thay đổi cấu hình. Trong CLI, khởi chạy codex và dùng /status để kiểm tra mô hình và nhà cung cấp đang hoạt động. Trong ứng dụng máy tính, kiểm tra mô hình đã chọn và cấu hình.

Gửi lời nhắc này trong một tác vụ mới:

Reply with exactly: gateway-ok

Kết quả mong đợi là gateway-ok. Chỉ riêng phản hồi không chứng minh được tuyến nào đã xử lý yêu cầu: hãy nhờ quản trị viên xác nhận rằng cổng đã ghi nhận người dùng của bạn, bí danh mô hình và tuyến thượng nguồn dự kiến. Không xác định mô hình bằng cách hỏi tên của nó.

Thao tác này xác minh kết nối ban đầu. Quản trị viên cũng nên hoàn thành các bước kiểm tra triển khai cho truyền phát, công cụ và các lượt hội thoại tiếp theo.

Khắc phục sự cố kết nối

Khi yêu cầu trợ giúp, hãy cung cấp thông báo lỗi sau khi loại bỏ token và các lời nhắc nhạy cảm.

Sử dụng bản triển khai cổng hiện có

Nếu tổ chức của bạn đã sử dụng cổng với một công cụ lập trình khác, bạn có thể sử dụng lại đường truyền mạng, cơ chế ghi nhật ký và quyền truy cập nhà cung cấp của cổng đó. Làm việc với nhóm phụ trách cổng để cấu hình và kiểm thử kết nối Codex:

1. Xác định URL cổng hiện có, cơ chế thông tin xác thực, các tiêu đề bắt buộc, tuyến mô hình và phương thức phân phối cấu hình.
2. Nhờ nhóm phụ trách cổng xác nhận rằng cổng hỗ trợ hành vi API mà Codex yêu cầu và cấu hình một tuyến mô hình Codex.
3. Lấy thông tin xác thực cổng có phạm vi quyền hạn xác định hoặc công cụ hỗ trợ thông tin xác thực, tên mô hình và mọi danh mục mô hình bắt buộc từ nhóm phụ trách cổng.
4. Cấu hình Codex bằng các giá trị đó.
5. Xác minh kết nối trong CLI hoặc ứng dụng máy tính bạn dự định sử dụng. Yêu cầu nhóm phụ trách cổng hoàn thành các bước kiểm tra truyền phát, công cụ và lượt hội thoại tiếp theo.
6. Sau khi thử nghiệm thí điểm đạt yêu cầu, làm theo Triển khai Codex thông qua cổng để phân phối cấu hình cho các nhà phát triển khác.

Để xem danh sách kiểm tra di chuyển dành cho quản trị viên và cách ánh xạ cấu hình, xem Tái sử dụng bản triển khai cổng hiện có.

Tài liệu liên quan

• Codex CLI
• MCP servers
• Plugin