扩展库 . 文档

视频教程 · 加入我们的 Discord

描述

Hexabot 是一个开源的 AI 聊天机器人/智能体解决方案。它使您能够轻松创建和管理多渠道、多语言的聊天机器人/智能体。Hexabot 旨在提供高度灵活性和可定制性，并具备强大的文本转操作能力。最初作为闭源项目（版本 1），我们现在已将版本 2 开源，以回馈社区并使开发者能够通过 扩展 自定义和扩展该平台。

功能

• LLM 和 NLU 支持： 可与您喜爱的 LLM 模型集成，无论是 Ollama、ChatGPT、Mistral 还是 Gemini…… 管理用于检测用户意图和语言的机器学习模型训练数据集，从而提供智能响应。
• 多渠道支持： 在网页、移动端和社交媒体平台等多个渠道上打造一致的聊天机器人体验。
• 可视化编辑器： 使用直观的拖放界面设计和管理聊天机器人流程。支持文本消息、快捷回复、轮播图等多种形式。
• 插件系统： 通过开发和安装来自 扩展库 的扩展来增强 Hexabot 的功能。启用诸如文本转操作响应、第三方系统集成等功能。
• 多语言支持： 定义多种语言，使聊天机器人能够以用户偏好的语言与其互动。
• 知识库： 无缝集成和管理动态内容，如产品目录和商店列表，以提升对话的吸引力。
• 用户角色与权限： 提供细粒度的访问控制，以管理系统不同部分的用户角色和权限。
• 上下文数据： 定义变量，收集并利用关于最终用户的相关信息，以提供个性化响应。
• 订阅者与标签： 通过分配标签来组织用户，并根据定义的细分群体定制其聊天体验。
• 收件箱与交接： 提供实时聊天窗口，可在其中监控对话，并在必要时将其转交给人工客服。
• 分析仪表板： 通过洞察力强的指标和可视化图表，监控聊天机器人的交互情况和性能。

目录结构

• frontend： 基于 React/Next.js 构建的管理面板，用于管理聊天机器人的配置和流程。
• api： 基于 NestJS 构建的后端 API，连接 MongoDB 用于数据存储和管理。
• widget： 基于 React 的实时聊天小部件，可嵌入任何网站以提供实时互动。
• docker： 一组 Docker Compose 文件，用于部署整个解决方案，使 Hexabot 能够在任何环境中轻松运行。

入门指南

先决条件

• Node.js >= 20.18.1
• npm（Node 包管理器）
• 已安装 Docker

安装

全局安装 Hexabot CLI，以便轻松使用其命令：

npm install -g hexabot-cli

使用方法

1. 创建新项目：

   hexabot create my-chatbot
   

   这将创建一个名为 my-chatbot 的新文件夹，其中包含所有必要的文件以开始使用。

2. 进入您的项目文件夹：

   cd my-chatbot
   

3. 安装依赖项：

   npm install
   

4. 初始化环境：

   hexabot init
   

   此命令会将 .env.example 文件复制到 .env，您可以编辑该文件以自定义配置。

5. 以开发模式运行：

   hexabot dev --services ollama
   

   这将在开发模式下启动所需的服务。

管理后台界面可通过 http://localhost:8080 访问，默认凭据为：

• 用户名： admin@admin.admin
• 密码： adminadmin

文档

有关如何入门的详细信息，以及深入的用户和开发者指南，请参阅 docs 文件夹中的完整文档，或访问 文档。您还可以在以下位置找到项目不同组件的特定文档：

• CLI 文档
• API 文档
• UI 文档
• 实时聊天小部件文档

贡献

我们欢迎社区的贡献！无论您是想报告 bug、提出新功能建议，还是提交 pull request，您的意见对我们都非常宝贵。

请先参阅我们的贡献政策：如何为 Hexabot 做贡献

欢迎您加入我们的 Discord 社区。

1. 克隆仓库：

$ git clone https://github.com/hexastack/hexabot.git

2. 安装依赖： 安装 Node.js 依赖：

$ npm install

3. 环境配置： 为配置环境变量，在根目录下运行以下命令进行初始化：

$ hexabot init

如果 ./docker 目录下尚未存在 .env 文件，此命令会将 .env.example 文件复制到该目录并重命名为 .env。

4. 运行应用： 环境配置完成后，即可启动应用。您可以使用以下任一命令：

开发模式：

$ hexabot dev

或者，您也可以选择直接拉取 Docker 镜像而非构建镜像：

$ hexabot start 

此外，您还可以启用 Ollama 等服务（这些服务在 ./docker 文件夹中定义）：

$ hexabot dev --services ollama

注意： 首次运行应用时，Docker 需要一些时间来下载所有必要的镜像。

许可证

本软件采用 GNU Affero 通用公共许可证 v3.0 (AGPLv3) 许可证，并附加以下条款：

1. “Hexabot” 是 Hexastack 的注册商标。未经明确书面许可，您不得在衍生作品中使用该名称。
2. 所有衍生作品必须在显著位置（例如软件的“关于”页面、文档和 README 文件中）明确注明原始创建者及软件——Hexastack 和 Hexabot。

Hexabot 快速上手指南

Hexabot 是一款开源的 AI 聊天机器人/智能体解决方案，支持多渠道、多语言及“文本转行动”能力。它提供可视化编辑器、插件系统和知识库管理，帮助开发者轻松构建和定制自己的 AI 助手。

环境准备

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

• Node.js: 版本 >= 20.18.1
• 包管理器: npm (随 Node.js 安装)
• 容器引擎: Docker (用于运行数据库及依赖服务)

提示：国内用户若遇到 npm 下载缓慢，可临时切换至淘宝镜像源： npm config set registry https://registry.npmmirror.com

安装步骤

1. 安装 Hexabot CLI

全局安装命令行工具以便快速创建和管理项目：

npm install -g hexabot-cli

2. 创建新项目

使用 CLI 初始化一个名为 my-chatbot 的新项目：

hexabot create my-chatbot

3. 进入项目目录

cd my-chatbot

4. 安装依赖

安装项目所需的 Node.js 依赖包：

npm install

5. 初始化环境变量

生成 .env 配置文件（基于 .env.example）：

hexabot init

基本使用

启动开发环境

运行以下命令启动开发模式。示例中同时启用了 Ollama 服务以支持本地大模型推理（如需使用其他模型可调整参数）：

hexabot dev --services ollama

注意：首次运行时，Docker 会自动拉取所需镜像，可能需要几分钟时间，请耐心等待。

访问管理后台

服务启动成功后，即可通过浏览器访问管理面板：

• 访问地址: http://localhost:8080
• 默认账号: admin@admin.admin
• 默认密码: adminadmin

登录后，您可以使用可视化编辑器设计对话流程、配置知识库或安装扩展插件。