langchainrb

环境要求

• 已安装 Ruby 环境（可运行 ruby 与 gem 命令）
• 使用 Bundler 管理依赖（推荐）或已安装 RubyGems
• OpenAI 等 LLM 供应商的 API Key
• 如使用工具类（如 NewsRetriever），需对应的第三方 API Key（如 NEWS_API_KEY）

安装与启动步骤

1. 1用 Bundler 安装 gem

   在项目目录下执行，会自动把 langchainrb 写入 Gemfile 并安装。适合已有 Rails/Ruby 项目。

   bundle add langchainrb

   复制

2. 2或直接安装 gem

   不使用 Bundler 管理依赖时，直接用 gem 命令全局安装。二选一即可。

   gem install langchainrb

   复制

3. 3按需补充额外 gem

   README 说明部分功能依赖的额外 gem 不默认包含，请只添加自己需要的那部分。

4. 4在代码中引入

   在 Ruby 文件顶部引入 langchain，之后才能使用 LLM、Assistant 等类。

   require "langchain"

   复制

5. 5初始化 LLM 实例

   所有 LLM 类继承自 Langchain::LLM::Base，接口一致，切换后端无需改业务代码。key 从环境变量读取。

   llm = Langchain::LLM::OpenAI.new(api_key: ENV["OPENAI_API_KEY"])

   复制

6. 6创建并运行 Assistant

   传入 llm、instructions 和 tools 创建助手，添加用户消息并运行，可开启自动工具执行。

   assistant = Langchain::Assistant.new(
     llm: llm,
     instructions: "You're a helpful AI assistant",
     tools: [Langchain::Tool::NewsRetriever.new(api_key: ENV["NEWS_API_KEY"])]
   )
   assistant.add_message_and_run!(content: "What's the latest news about AI?")
   assistant.run(auto_tool_execution: true)

   复制

关键配置

如何确认成功

运行 Ruby 脚本后能正常输出助手回复（如返回 AI 相关最新新闻），说明 gem 安装与 LLM 配置成功。

常见问题

注意事项

• 额外依赖 gem 默认不安装，只添加实际用到的，避免体积膨胀。
• 工具类通常需要自己的 API Key，如 NewsRetriever 需要 NEWS_API_KEY。
• 完整 API 文档见官网 rubydoc.info/gems/langchainrb。