Stealth 是一个用于构建文本和语音聊天机器人的 Ruby 框架。它的设计灵感来源于 Ruby on Rails 的“约定优于配置”理念。Stealth 采用 MVC 架构，唯一的不同之处在于“视图”被恰当地命名为“回复”。

特性

• 可部署到任何地方，因为它只是一个 Rack 应用
• 通过变体支持在多个消息平台上使用同一套代码库
• 结构化的通用回复格式
• 会话基于状态机概念，并由 Redis 提供支持
• 高度可扩展。传入的 Webhook 通过 Sidekiq 队列进行处理
• 内置最佳实践：捕获所有异常（错误处理）、欢迎流程、告别流程

快速入门

开始使用 Stealth 非常简单：

> gem install stealth
> stealth new <bot>

服务集成

Stealth 具有良好的扩展性。所有的服务集成都被拆分为独立的 Ruby Gem。诸如分析和自然语言处理（NLP）等功能也可以作为 Gem 添加。

目前，已有以下集成 Gem：

消息传递

• Facebook Messenger
• Twilio SMS
• Bandwidth
• Smooch

语音

• Alexa Skill（早期 Alpha 版）

自然语言处理

• Microsoft LUIS
• AWS Comprehend

分析

• Mixpanel

文档

您可以在这里找到我们的完整文档：点击此处。如果文档中存在不清楚的地方，请提交一个问题！我们认为文档中的任何不足都属于 Bug。

版本管理

Stealth 使用 语义化版本控制 进行版本管理，但其方式更接近于 Linux 内核。主要版本和次要版本的发布都相对随意。我们致力于在任何版本变更时都不会破坏现有功能。补丁版本则对应于版本号中的“第三位小数”。

许可证

“Stealth”及 Stealth 标志的版权归 MAV Automated Ventures Inc. 所有，版权年份为 2017–2024 年。

Stealth 快速上手指南

Stealth 是一个基于 Ruby 的聊天机器人（文本与语音）开发框架。它遵循“约定优于配置”的设计理念，采用类似 Ruby on Rails 的 MVC 架构（其中视图层被称为 replies），支持多平台部署和高并发处理。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux、macOS 或 Windows (WSL)
• Ruby 环境：已安装 Ruby 2.7 或更高版本
• Redis：Stealth 的会话状态管理依赖 Redis，请确保本地已安装并运行 Redis 服务
• 包管理器：熟悉 gem 命令的使用

提示：国内开发者若遇到 gem 源连接缓慢的问题，建议切换至国内镜像源（如 Ruby China 镜像）：

gem sources --add https://gems.ruby-china.com/ --remove https://rubygems.org/
gem sources -l

安装步骤

1. 安装 Stealth 核心库 使用 gem 命令安装主程序：

   gem install stealth
   

2. 创建新项目 使用命令行工具生成一个新的机器人项目骨架（将 <bot> 替换为您的项目名称）：

   stealth new <bot>
   

3. 安装平台集成插件（可选） Stealth 的核心功能不包含具体平台接口，需根据目标平台安装对应的 Gem。例如，若要开发 Facebook Messenger 机器人：

   # 进入项目目录
   cd <bot>
   
   # 在 Gemfile 中添加对应依赖并安装，或直接安装 gem
   gem install stealth-facebook
   

   支持的平台包括：Facebook Messenger, Twilio SMS, Bandwidth, Smooch, Alexa (Alpha) 等。

基本使用

以下是构建一个简单回复流程的最小化示例。Stealth 的核心逻辑位于 replies 目录中。

1. 定义回复逻辑 在项目生成的 replies 目录下（通常默认为 main.rb 或类似入口），定义一个简单的状态和回复。Stealth 使用状态机概念管理会话。

   class MainReplies < Stealth::Reply
     def say_hello
       reply_with text: "你好！欢迎使用 Stealth 机器人。"
       run :ask_name
     end
   
     def ask_name
       reply_with text: "请问您叫什么名字？"
     end
   
     def save_name
       # 获取用户输入
       user_name = params[:message]
       session[:name] = user_name
       
       reply_with text: "很高兴认识你，#{user_name}！"
       run :say_hello
     end
   end
   

2. 配置路由 在 states.yml 或相应的状态配置文件中，将用户输入映射到上述方法（具体文件名视生成模板而定）：

   default:
     next_step: say_hello
     
   ask_name:
     next_step: save_name
   

3. 启动服务 Stealth 本质上是一个 Rack 应用，可以使用任何支持 Rack 的服务器启动（如 Puma 或 Thin）：

   bundle exec puma
   

4. 对接平台 将生成的 Webhook URL 配置到您选择的 messaging 平台（如 Facebook Developer Console 或 Twilio Console）即可开始测试。

通过以上步骤，您已成功运行了一个具备基础会话状态的 Stealth 机器人。更多高级功能（如 NLP 集成、数据分析）可通过安装额外的 Gem 扩展实现。