ruby-openai

环境要求

• 已安装 Ruby 环境（README 未指定最低版本要求）
• 从 https://platform.openai.com/account/api-keys 获取的 OpenAI API Key
• 如需调用 Usage 等管理员接口，需准备 OPENAI_ADMIN_TOKEN（在 https://platform.openai.com/settings/
• 多个组织时需从 https://platform.openai.com/account/org-settings 获取 Organization ID

安装与启动步骤

1. 1安装 Gem

   在终端执行 gem install，把 ruby-openai 客户端库装到当前 Ruby 环境中；如项目使用 Bundler，可自行加入 Gemfile 后 bundle install。

   gem install ruby-openai

   复制

2. 2引入库

   在 Ruby 代码文件顶部 require 该库，注意引入名是 openai 而不是 ruby-openai，README 中明确写为 require "openai"。

   require "openai"

   复制

3. 3获取 API Key

   登录 OpenAI 平台，在 API keys 页面创建密钥；若属于多个组织，再到组织设置页记下 Organization ID。此步只涉及网页操作，无命令。

4. 4初始化客户端

   直接把 token 传给 OpenAI::Client.new 做快速测试；README 建议开发环境开启 log_errors 便于查看报错。

   client = OpenAI::Client.new(
     access_token: "access_token_goes_here",
     log_errors: true
   )

   复制

5. 5配置管理员 Token

   仅在使用 Usage 等 Admin API 时需要。通过 OpenAI.configure 读取环境变量 OPENAI_ADMIN_TOKEN 完成全局配置。

   OpenAI.configure do |config|
     config.admin_token = ENV.fetch("OPENAI_ADMIN_TOKEN")
   end

   复制

关键配置

如何确认成功

初始化客户端后发起一次调用，若返回类似 {"id"=>"chatcmpl-...", "object"=>"chat.completion.chunk"} 的哈希或流式 chunk，说明配置成功。

常见问题

注意事项

• 库的引入名是 openai，命令是 require "openai"，不要写成 ruby-openai
• 示例中的 access_token_goes_here 是占位值，必须替换成自己的真实密钥，且不要提交到代码仓库
• 生产环境关闭 log_errors，避免日志泄露私有数据
• 调用管理员接口前必须先配置 admin_token，否则 Usage 相关方法无法使用