Boxcars 项目介绍
Boxcars 是一个强大的 Ruby gem,旨在构建具有人工智能可组合性的系统。通过 Boxcars,开发者可以使用各种概念和技术,如大语言模型(LLMs),搜索引擎,SQL 查询(支持 Sequel 和 Active Record),Rails Active Record,向量搜索等,甚至还可以扩展自己定义的概念。
开发 Boxcars 的灵感来源于流行的 Python 库 Langchain,但开发团队想要在 Ruby 语言中做出改进,使其更适合初学者使用。因此,Boxcars 特别便捷和用户友好。
核心概念
在 Boxcars 模块中定义了几个核心概念:
-
Boxcar:一个封装在一起的功能模块,能够执行特定的任务(如搜索、数学计算、SQL 查询、API 调用等)。Boxcar 可以使用指定的 Engine 完成工作。如果没有指定,将使用默认的
Boxcars.engine
。 -
Train:由一组 Boxcars 组成,能够分解问题,让各个 Boxcar 单独解决问题,最终将结果汇总得出解决方案。目前,ZeroShot 是唯一实现的 Train,但很快会添加更多选项。用户可以直接创建 Train 或使用
Boxcars::train
简化流程。 -
Prompt:用于引擎生成文本结果的提示词。Boxcars 提供内置提示词,用户可以根据需要更改或扩展。
-
Engine:处理提示词并生成文本的实体。如果未指定,OpenAI 的大语言模型引擎将用作默认引擎。用户可以通过
Boxcar.configuration.default_engine
更改默认引擎。Boxcars 还支持 Anthropic 的 Claude API(Boxcars::Anthropic
)和 GPT 引擎(Boxcars::Gpt4allEng
)。 -
VectorStore:用于存储和查询向量的地方。
安全性
目前,Boxcars 系统专为拥有管理权限的用户设计。虽然技术上有可能利用代码进行不当操作,但有管理权限的用户无需借助 Boxcars 来完成此类操作。开发团队正在努力提高系统对潜在威胁和恶意行为的识别和防范能力,并欢迎用户提供建议。
安装指南
要在项目中使用 Boxcars,请在应用的 Gemfile 中添加以下内容:
gem 'boxcars'
然后执行命令:
$ bundle install
或者使用以下命令单独安装:
$ gem install boxcars
使用指南
Boxcars 的使用非常简单。用户需要设置环境变量来支持如 OpenAI、Anthropic 和 Google SERP 等服务的 API 访问,如 OPENAI_ACCESS_TOKEN、ANTHROPIC_API_KEY、SERPAPI_API_KEY 等。也可以将这些变量直接传递给 API。
直接使用 Boxcar
下面是一个使用 Boxcar 的简单示例,使用 Ruby 的 irb
环境即可开始:
# 运行计算器
require "boxcars"
calc = Boxcars::Calculator.new # 使用默认引擎
puts calc.run "what is pi to the fourth power divided by 22.1?"
Boxcars 提供了多种功能性的 Boxcars,例如:Google 搜索、Wikipedia 搜索、Calculator(计算器)用于数学计算、SQL 查询、Active Record 查询以及 Swagger 用于 API 操作等。
组合使用 Boxcars
可以将多个 Boxcars 组合在一个 Train 中,以帮助解决复杂问题:
# 使用默认引擎运行计算器和搜索
boxcars = [Boxcars::Calculator.new, Boxcars::GoogleSearch.new]
train = Boxcars.train.new(boxcars: boxcars)
train.run "What is pi times the square root of the average temperature in Austin TX in January?"
更多示例
可以查阅 Jupyter Notebook 中的更多示例,包括 Swagger boxcar 和向量搜索的使用示例。
日志功能
若在 Rails 应用中使用 Boxcars,可以将日志记录到日志文件。通过设置 Boxcars.configuration.log_prompts = true
,可以记录传递给连接引擎的所有提示词,使调试更方便。
贡献
Boxcars 项目鼓励社区贡献,无论是问题报告还是功能请求,都可以在 GitHub 上进行,该项目欢迎所有人参与并遵循项目的行为准则。
Boxcars 以 MIT 许可证开源,大家都可以使用和贡献。