Ruby OpenAI 项目介绍
Ruby OpenAI是一个用Ruby编程语言与OpenAI API交互的项目。项目旨在为Ruby开发人员提供一个简单却强大的工具,以便轻松地使用如GPT-4Chat、Whisper和DALL·E等OpenAI的服务。
项目特点
- 文本流:可以使用GPT-4进行流式文本传输。
- 音频处理:Whisper可以用来转录和翻译音频。
- 图像生成:通过DALL·E生成图像。
这些功能使得开发人员能够轻松地在Ruby应用中集成AI能力,比如自然语言处理和图像生成。
安装
你可以通过Bundler或者直接安装gem来安装Ruby OpenAI:
使用Bundler
在项目的Gemfile文件中添加一句话:
gem "ruby-openai"
然后在终端执行:
$ bundle install
直接安装
使用如下命令安装:
$ gem install ruby-openai
并在代码中引入:
require "openai"
使用方式
- 获取API密钥:首先需要从OpenAI平台获取API密钥。
- 初始化客户端:可以直接将获取的密钥传入一个新的客户端对象来进行快速测试。
client = OpenAI::Client.new(
access_token: "你的API密钥",
log_errors: true
)
高级配置
为了更为稳健的设置,你可以在项目初始化时配置API密钥,例如在一个openai.rb
文件中进行配置。建议使用环境变量来传递API密钥,而不是将其硬编码在代码中。
OpenAI.configure do |config|
config.access_token = ENV.fetch("OPENAI_ACCESS_TOKEN")
config.organization_id = ENV.fetch("OPENAI_ORGANIZATION_ID", nil)
config.log_errors = true
end
然后可以如下创建客户端:
client = OpenAI::Client.new
功能概述
聊天功能
使用GPT-4模型,你可以生成会话风格的文本回复。以下是一个简单的例子:
response = client.chat(
parameters: {
model: "gpt-4o",
messages: [{ role: "user", content: "你好!"}],
temperature: 0.7,
}
)
puts response.dig("choices", 0, "message", "content")
图像生成
可以通过DALL·E模型来生成图像。
分批处理请求
支持批量处理API请求以便异步运行,适用于聊天完成和嵌入等场景。
向量存储
向量存储对象提供了文件搜索的能力,你可以创建和管理向量存储以便进行高效的文件检索。
贡献和支持
这个项目使用MIT许可证进行分发,并且欢迎开发者社区中的贡献。详细的贡献指南和代码行为规范可以在项目的GitHub页面找到。
Ruby OpenAI提供了丰富的功能和灵活的配置,便于开发者在自己的应用中集成强大的AI能力,无论是对文本、音频还是图像的处理。