项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 4498
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- Ruby 环境(gem 由 Bundler 管理)
- 已初始化的 Ruby 项目;Rails 集成需 Rails 项目
- 至少一个 AI 提供商的 API Key(如 OPENAI_API_KEY)
安装与启动步骤
-
1添加 ruby_llm 依赖
在项目目录下用 Bundler 添加 2.0 候选版 gem,README 明确指定版本号 2.0.0.rc2
bundle add ruby_llm --version 2.0.0.rc2 -
2设置 API Key 环境变量
配置需要从环境变量读取密钥,此处以 OpenAI 为例,把 sk-xxxxxxxx 换成你自己的真实密钥
export OPENAI_API_KEY=sk-xxxxxxxx -
3编写配置代码
在脚本中或 Rails 的 config/initializers/ruby_llm.rb 中调用 RubyLLM.configure 配置提供商密钥
require 'ruby_llm' RubyLLM.configure do |config| config.openai_api_key = ENV.fetch('OPENAI_API_KEY') end -
4生成 Rails 集成文件
仅在 Rails 项目中使用,运行生成器写入 ruby_llm 所需文件
bin/rails generate ruby_llm:install -
5执行数据库迁移
Rails 集成需要建表,运行迁移使相关数据结构生效
bin/rails db:migrate -
6加载模型清单
Rails 集成最后一步,加载 ruby_llm 内置的模型数据
bin/rails ruby_llm:load_models
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
openai_api_key | 是 | OpenAI 提供商密钥,配置后即可调用其聊天与媒体能力 | ENV.fetch('OPENAI_API_KEY') |
gemini_api_key | 否 | 需要文件相关能力时按示例配置 Gemini | ENV.fetch('GEMINI_API_KEY') |
xai_api_key | 否 | 需要视频能力时按示例配置 xAI | ENV.fetch('XAI_API_KEY') |
mistral_api_key | 否 | 需要 OCR 能力时按示例配置 Mistral | ENV.fetch('MISTRAL_API_KEY') |
cohere_api_key | 否 | 需要重排序(reranking)能力时配置 Cohere | ENV.fetch('COHERE_API_KEY') |
如何确认成功
能正常 require 'ruby_llm' 并按上述方式完成配置且不报错;Rails 下生成文件、迁移和加载模型均无报错即表示集成成功。
常见问题
Q:应该安装哪个版本?
A:README 中给出的安装命令是 2.0 候选版 2.0.0.rc2,直接使用该命令即可,属于发布候选版本。
Q:除了 OpenAI,还支持哪些提供商?
A:README 说明内置共十七个提供商,涵盖 OpenAI、xAI、Anthropic、Google、AWS、本地模型等,还可直接接入任何 OpenAI 兼容端点。
Q:Gemini、xAI、Mistral、Cohere 的密钥要怎么配?
A:按示例需要分别配置:Gemini 用于文件、xAI 用于视频、Mistral 用于 OCR、Cohere 用于重排序,官方 Getting Started 文档在每个示例旁给出了对应设置。
Q:从 1.16 升级需要额外操作吗?
A:如果你的应用使用 1.16,部署 2.0 之前需要先按官方升级指南完成升级。
注意事项
- 安装命令指定的是 2.0.0.rc2 候选版本,非正式稳定版,生产环境请谨慎评估。
- API Key 建议通过环境变量传入,不要把密钥硬编码到仓库代码中。
- 除 OpenAI 外,Gemini、xAI、Mistral、Cohere 等按需配置,不需要的可以不设。
- Rails 集成必须按顺序执行生成器、数据库迁移和模型加载三步。
核心亮点
- 统一 API 封装,切换提供商只需改配置,无需改业务代码
- 覆盖主流 AI 提供商(OpenAI、Anthropic、Gemini 等),支持本地模型(Ollama)
- 支持图像生成、嵌入、RAG 等高级功能,适合多模态场景
不足之处
- Ruby 生态 AI 库较少,社区资源不如 Python 丰富
- 文档/社区待观察
适用场景
- 快速构建多提供商支持的 AI 聊天机器人
- 在 Ruby 服务中集成 RAG 知识库问答
- 开发支持图像生成的多模态工作流
替代项目
langchain.rb、ruby-openai、anthropic-sdk-ruby
上一篇:assistant-ui
下一篇:Gemini-API
同类项目推荐
software-periodic-table
开源
给AI编程智能体一张软件元素周期表,按图索骥组合开发能力
A finite ontology of 115 recurring software elements and a composition framework for···
在 .NET 里一行代码调用 ChatGPT,告别手写 HTTP 请求
A Non-Official OpenAI RESTful API Client for DotNet
agf
开源
一个终端命令,找回所有 AI 助手的聊天记录
Find, search, and resume local AI coding-agent sessions across Muse Code, Claude Cod···
Promptify
开源
用提示词工程,让 GPT 稳定输出结构化数据
Prompt Engineering | Prompt Versioning | Use GPT or other prompt based models to get···
langchain-serve
开源
一键把 Langchain 应用部署成生产级服务,省心省力
⚡ Langchain apps in production using Jina & FastAPI
Art
开源
用 Java 技术栈,像搭积木一样快速构建 AI 应用。
Art 是一个开源的、一站式 AI 应用开发平台,其灵感来源于行业领先的 Coze 和 Dify。我们致···
modelscope-studio
开源
用 Gradio 快速搭建专业级 AI 对话界面
A third-party component library based on Gradio. Integrates Ant Design, Ant Design X···
ComfyUI-MultiGPU
开源
一键扩展显存,多卡并行跑大模型,低配也能生成高清视频。
This custom_node for ComfyUI adds one-click "Virtual VRAM" for any UNet and CLIP loa···
LangChain
开源
用 C# 直接搭 LLM 应用,不切 Python
C# implementation of LangChain. We try to be as close to the original as possible in···
