Sara - Rasa 演示机器人

:surfer: 简介

此仓库旨在展示使用开源 Rasa 框架构建的上下文感知 AI 助手。

Sara 是一个 Alpha 版本，目前集成在我们的文档中， 帮助开发者快速上手我们的开源工具。它支持以下用户目标：

• 了解 Rasa 框架
• 开始使用 Rasa
• 回答有关 Rasa 的常见问题
• 将技术问题引导至特定文档
• 订阅 Rasa 新闻通讯
• 请求与 Rasa 销售团队通话
• 处理基础闲聊

Sara 的计划增强功能可在 项目看板 中找到。

👷‍ 安装

要安装 Sara，请克隆仓库并运行：

cd rasa-demo
make install

这将安装机器人及其所有依赖项。请注意，此机器人应与 Python 3.6 或 3.7 一起使用。

🤖 运行 Sara：

使用 rasa train 训练模型（训练过程会占用大量内存， 若希望加快训练速度，可尝试使用 --augmentation 0 参数）。

然后，在一个终端窗口中启动动作服务器：

rasa run actions --actions actions.actions

其中一些自定义动作需要连接到外部服务， 特别是 SubscribeNewsletterForm 和 SalesForm。要使这些动作正常运行， 您需要拥有自己的 MailChimp 新闻通讯和 Google 表格连接。有关提供外部服务凭据的说明， 请参阅 开发 部分。

在另一个窗口中运行机器人：

docker run -p 8000:8000 rasa/duckling
rasa shell --debug

请注意，--debug 模式会产生大量输出，用于帮助您理解机器人的内部工作原理。 若只想简单地与机器人对话，可移除此标志。

如果您希望在自己的网站上运行 Sara，请按照 此处 的说明将聊天小部件部署到您的网站上。

测试 Sara：

完成 rasa train 后，运行以下命令：

rasa test nlu -u test/test_data.json --model models
rasa test core --stories test/test_stories.md

👩‍💻 文件概览

data/core/ - 包含故事文件

data/nlu - 包含 NLU 训练数据

actions - 包含自定义动作代码

domain.yml - 域文件，包括机器人响应模板

config.yml - NLU 管道和策略组合的训练配置

开发

要安装开发所需的依赖项，请运行：

make install-dev

要在本地运行自定义动作，请在本地目录根目录下创建一个名为 .env 的文件， 并填写以下环境变量的值。大多数动作无需这些变量即可运行， 但如果您正在开发连接外部 API 的动作，则需要凭据。

GDRIVE_CREDENTIALS=#Google Drive API 的 JSON 访问密钥，用于 action_submit_sales_form
MAILCHIMP_LIST=#Mailchimp 列表 ID，用于 action_submit_subscribe_newsletter_form
MAILCHIMP_API_KEY=#Mailchimp 的 API 密钥
ALGOLIA_APP_ID=#Algolia 应用程序 ID，用于 action_docs_search
ALGOLIA_SEARCH_KEY=#Algolia 搜索密钥
ALGOLIA_DOCS_INDEX=#Algolia 搜索索引
RASA_X_HOST=#Rasa X 的域名，例如 localhost:5002
RASA_X_PASSWORD=#用于认证 Rasa X 的密码
RASA_X_USERNAME=#用于认证 Rasa X 的用户名
RASA_X_HOST_SCHEMA=#Rasa X 的地址模式（http/https）

要运行自定义动作的单元测试：

make test-actions

为确保测试期间数据库清理得当， 您需要在 .env 文件中包含跟踪器存储数据库的连接 URL，例如：

TRACKER_DB_URL=postgresql:///tracker

但这对于运行动作本身并非必需。

⚫️ 代码风格

为确保代码风格统一，我们使用格式化工具 black。

如果您希望在每次提交时自动格式化代码， 可以使用 pre-commit。 只需通过 pip install pre-commit 安装，并在根目录下执行 pre-commit install。 这将在仓库中添加一个钩子，每次提交时都会重新格式化文件。

若需手动格式化文件，可执行：

make formatter

:gift: 许可证

根据 GNU 通用公共许可证 v3 许可。版权所有 © 2018 Rasa Technologies GmbH。 许可证副本。 许可证持有者可根据本许可证传播该作品。本作品不提供任何担保。

Rasa Demo Bot (Sara) 快速上手指南

本指南帮助开发者快速部署并运行基于 Rasa 开源框架的示例聊天机器人 Sara。

环境准备

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

• 操作系统：Linux, macOS 或 Windows (推荐 WSL2)
• Python 版本：3.6 或 3.7 (必须，更高版本可能不兼容)
• Docker：用于运行 Duckling 实体提取服务
• 构建工具：make 命令可用
• 依赖管理：pip

提示：国内用户建议在安装 Python 依赖时配置清华或阿里镜像源，以加速下载过程。

pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

1. 克隆仓库 将项目代码克隆到本地：

   git clone https://github.com/RasaHQ/rasa-demo.git
   cd rasa-demo
   

2. 安装依赖 执行以下命令安装机器人及其所有依赖项：

   make install
   

基本使用

完成安装后，按以下步骤启动并体验机器人：

1. 训练模型

首先训练 NLU 和 Core 模型。如果内存有限或希望加快训练速度，可添加 --augmentation 0 参数：

rasa train
# 或快速训练模式
rasa train --augmentation 0

2. 启动外部服务 (Duckling)

Sara 依赖 Duckling 进行实体提取，需通过 Docker 运行：

docker run -p 8000:8000 rasa/duckling

3. 启动动作服务器 (Action Server)

在一个终端窗口中运行自定义动作服务：

rasa run actions --actions actions.actions

注意：部分功能（如订阅通讯、销售表单）需要配置 MailChimp 或 Google Sheets 凭证。若仅测试基础对话，可跳过 .env 配置文件设置。

4. 运行机器人

在另一个终端窗口中启动对话 Shell：

# 调试模式（输出详细日志，适合开发）
rasa shell --debug

# 普通模式（仅对话）
rasa shell

现在您可以在终端中与 Sara 进行对话，尝试询问关于 Rasa 框架的问题、获取文档指引或进行闲聊。

5. (可选) 集成到网站

若需将 Sara 嵌入网页，请参考 rasa-webchat 项目 instructions 部署聊天组件。