Codex.
Điều kiện cần có
- Bạn đã hoàn tất Tạo tài khoản.
- Bạn đã hoàn tất Lấy API Key.
- Node.js 18 trở lên đã được cài đặt.
- Codex CLI đã được cài đặt và
codex --versionhoạt động. - Bạn có một dự án TypeScript hoặc JavaScript.
Trường hợp sử dụng
Codex SDK hữu ích khi bạn cần đưa Codex vào một quy trình kỹ thuật hiện có.| Trường hợp | Phù hợp để làm gì |
|---|---|
| Tự động hóa CI/CD | Kích hoạt kiểm tra mã, phân tích nguyên nhân gốc, đề xuất sửa lỗi hoặc báo cáo có cấu trúc trong pipeline. |
| Tự động review mã | Chạy tác vụ review trong GitHub Actions, GitLab CI/CD, Azure DevOps Pipelines hoặc Jenkins, rồi đăng kết quả thành comment trên mã. |
| Công cụ phát triển nội bộ | Thêm Codex vào nền tảng nội bộ để tạo kế hoạch migration, phân tích kho mã hoặc chẩn đoán lỗi build. |
| Trợ lý kỹ thuật trong ứng dụng | Khởi tạo thread Codex từ ứng dụng của bạn và để Codex xử lý tác vụ kỹ thuật nhiều bước. |
| Quy trình đầu ra có cấu trúc | Yêu cầu Codex trả về JSON schema, rồi gọi SCM, Slack, hệ thống ticket hoặc API nội bộ. |
Cài đặt SDK
Cài Codex SDK trong dự án của bạn.Sao chép giá trị kết nối
Cấu hình biến môi trường
Lưu API Key, Base URL và tên mô hình trong biến môi trường phía máy chủ..env, viết:
Khởi tạo Codex
Tạo một phiên bảnCodex trong mã phía máy chủ. Truyền apiKey và baseUrl vào constructor.
CODEX_API_KEY là API Key bạn đã tạo trong bảng điều khiển. Sao chép CODEX_BASE_URL và CODEX_MODEL từ bảng điều khiển.
Kiểm tra kết nối
Bắt đầu bằng một prompt chỉ đọc.Ví dụ review mã
Cookbook chính thức của OpenAI trình bày một quy trình review mã tự động. Quy trình kích hoạt Codex trong CI/CD runner, để Codex đọc diff của PR, yêu cầu đầu ra JSON schema có cấu trúc, rồi gọi SCM API để đăng comment inline. Bạn có thể dùng mẫu này cho:- Review PR tự động.
- Quy trình review cho repository on-premise hoặc SCM không phải GitHub.
- Tạo ticket, gửi thông báo Slack hoặc cập nhật dashboard chất lượng nội bộ từ kết quả có cấu trúc.
Sự cố thường gặp
Nên dùng Base URL nào
Nên dùng Base URL nào
Dùng Base URL hiện tại hiển thị trong bảng điều khiển. Không sao chép địa chỉ cố định từ tài liệu, ảnh chụp màn hình hoặc cấu hình cũ.
Nên dùng tên mô hình nào
Nên dùng tên mô hình nào
Dùng tên mô hình hiển thị trong bảng điều khiển. Sao chép đầy đủ giá trị, bao gồm chữ hoa, chữ thường, dấu gạch nối và hậu tố phiên bản.
Có thể gọi từ frontend trình duyệt không
Có thể gọi từ frontend trình duyệt không
Không khuyến nghị. Mã frontend sẽ làm lộ API Key. Hãy gọi SDK từ mã phía máy chủ, job backend hoặc môi trường tự động hóa được kiểm soát.
Xác thực thất bại
Xác thực thất bại
Kiểm tra API Key đã được sao chép đầy đủ, tiến trình chạy có đọc được biến môi trường và Base URL thuộc cùng tài khoản hoặc môi trường trong bảng điều khiển.