高效客户服务助手

看看将 Simba 集成到您的网站是多么简单

Simba 是什么？

Simba 是一款开源的客户服务助手，专为需要对 AI 实现完全控制的团队而设计。与黑盒解决方案不同，Simba 从一开始就围绕评估和定制化构建，因此您可以衡量性能、快速迭代，并根据您的具体需求量身定制助手。

为什么选择 Simba？

问题	Simba 的解决方案
无法衡量 AI 质量	内置评估框架，包含检索和生成指标
回答过于通用	完全可定制的 RAG 流程，使用您自己的数据
难以集成	即插即用的 npm 包，可立即集成到网站中
供应商锁定	开源、自托管，可更换任何组件

核心功能

• 以评估为先的设计 - 开箱即用即可跟踪检索准确率、生成质量和延迟。清楚了解助手的表现。
• 完全可定制 - 可更换嵌入模型、LLM、向量存储、分块策略和重排序器。您的流程，您来定义规则。
• 易于集成的 npm 包 - 通过一次 npm 安装，即可将客户服务聊天小部件添加到您的网站。
• 现代化仪表盘 - 从简洁的 UI 中管理文档、监控对话并分析性能。
• 生产就绪 - 流式响应、异步处理和可扩展架构。

快速入门

Docker（推荐）

运行 Simba 的最快方式：

git clone https://github.com/GitHamza0206/simba.git
cd simba

创建一个 .env 文件：

OPENAI_API_KEY=your_openai_api_key

使用 Docker 运行：

# CPU
DEVICE=cpu make build && make up

# NVIDIA GPU
DEVICE=cuda make build && make up

访问 http://localhost:3000 即可进入仪表盘。

手动安装

如果您更倾向于不使用 Docker 进行安装：

pip install simba-core

simba server
simba front

使用 Claude Code 的开发环境

如果您正在使用 Claude Code，只需一条命令即可设置项目：

/setup --all

这将自动安装所有依赖项（Python、前端、npm 包）并启动基础设施服务。其他选项：

/setup --backend    # 仅安装 Python 依赖项
/setup --frontend   # 仅安装 Next.js 和 simba-chat
/setup --services   # 仅启动 Docker 基础设施

网站集成

通过 npm 包将 Simba 添加到您的网站：

npm install simba-chat-widget

import { SimbaChat } from 'simba-chat-widget';

function App() {
  return (
    <SimbaChat
      apiUrl="https://your-simba-instance.com"
      theme="light"
    />
  );
}

就这么简单。您的客户现在拥有了由您知识库驱动的 AI 助手。

评估与指标

Simba 会跟踪关键指标：

• 检索指标 - 精确率、召回率、相关性得分
• 生成指标 - 忠实度、答案相关性、延迟
• 对话分析 - 用户满意度、解决率

利用这些指标持续提升助手的性能。

架构

┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
│   您的网站    │────▶│   Simba API     │────▶│  向量存储     │
│  (npm 包)      │     │   (FastAPI)     │     │  (Qdrant/FAISS) │
└─────────────────┘     └─────────────────┘     └─────────────────┘
                               │                        ▲
                               │                        │
                               ▼                        │
                        ┌─────────────────┐     ┌───────┴─────────┐
                        │      LLM        │     │     Celery      │
                        │ (OpenAI/本地)  │     │   (摄取)       │
                        └─────────────────┘     └─────────────────┘
                                                        │
                                                        ▼
                                                ┌─────────────────┐
                                                │      Redis      │
                                                │  (任务队列)     │
                                                └─────────────────┘

Docker 部署

# CPU
DEVICE=cpu make build && make up

# NVIDIA GPU
DEVICE=cuda make build && make up

自定义选项

组件	选项
向量存储	Qdrant, FAISS, Chroma
嵌入	OpenAI, HuggingFace, Cohere
LLM	OpenAI, Anthropic, 本地模型
重排序器	Cohere, ColBERT, 交叉编码器
解析器	Docling, Unstructured, PyMuPDF

路线图

• 核心评估框架
• npm 聊天小部件
• 流式响应
• 多租户支持
• 高级分析仪表盘
• Webhook 集成
• 微调流水线

贡献

我们欢迎您的贡献！请 fork 仓库，创建分支并提交 PR。

支持

• 在 GitHub 上提交 issue
• 联系方式：zeroualihamza0206@gmail.com

Simba 快速上手指南

Simba 是一款开源的高效率客户服务助手，专为需要完全掌控 AI 模型的团队设计。它内置评估框架，支持高度自定义的 RAG（检索增强生成）流程，并提供便捷的 npm 组件用于网站集成。

环境准备

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

• 操作系统：Linux, macOS 或 Windows (推荐 WSL2)
• 容器化部署（推荐）：
  • Docker & Docker Compose
  • Make 工具
  • NVIDIA GPU 驱动（如需使用 CUDA 加速，可选）
• 手动部署：
  • Python 3.9+
  • Node.js 18+ & npm
  • Git

注意：本项目目前主要依赖官方源。国内开发者若遇到网络延迟，建议配置 Docker 镜像加速器或在 pip/npm 安装时指定国内镜像源（如阿里云、清华大学源）。

安装步骤

方式一：Docker 部署（推荐）

这是最快捷的启动方式，自动包含所有依赖服务。

1. 克隆项目

   git clone https://github.com/GitHamza0206/simba.git
   cd simba
   

2. 配置环境变量 创建 .env 文件并填入您的 OpenAI API Key：

   echo "OPENAI_API_KEY=your_openai_api_key" > .env
   

3. 构建并启动 根据硬件环境选择以下命令之一：

   • CPU 版本：

     DEVICE=cpu make build && make up
     

   • NVIDIA GPU 版本：

     DEVICE=cuda make build && make up
     

4. 访问控制台 启动完成后，在浏览器访问 http://localhost:3000 即可看到管理仪表盘。

方式二：手动安装

如果您不希望使用 Docker，可以分步安装核心服务和前端。

1. 安装后端核心

   pip install simba-core
   # 启动后端服务
   simba server
   

2. 安装并启动前端 （需进入前端目录或使用相应命令，参考原文逻辑）

   simba front
   

开发环境一键设置（可选）

如果您使用 Claude Code，可运行以下命令自动完成所有依赖安装和服务启动：

/setup --all

其他选项：

• /setup --backend：仅安装 Python 依赖
• /setup --frontend：仅安装 Next.js 和聊天组件
• /setup --services：仅启动 Docker 基础设施

基本使用

1. 网站集成

Simba 提供了轻量级的 npm 包，只需几行代码即可将客服聊天窗口嵌入您的网站。

安装组件：

npm install simba-chat-widget

在 React/Next.js 项目中引入：

import { SimbaChat } from 'simba-chat-widget';

function App() {
  return (
    <SimbaChat
      apiUrl="https://your-simba-instance.com"
      theme="light"
    />
  );
}

将 apiUrl 替换为您实际部署的 Simba 服务地址。

2. 核心功能工作流

集成后，Simba 将按照以下架构运行：

1. 数据摄入：通过仪表盘上传文档，系统利用 Celery + Redis 异步处理文档解析、分块和向量化（支持 Qdrant/FAISS）。
2. 用户提问：用户在网站插件中输入问题。
3. 检索与生成：
   • Simba API (FastAPI) 接收请求。
   • 从向量库检索相关片段。
   • 调用 LLM (OpenAI/本地模型) 生成回答。
   • 实时流式返回结果给用户。
4. 评估监控：系统自动记录检索准确率、生成忠实度及延迟等指标，可在仪表盘中查看。

3. 自定义配置

Simba 支持灵活替换各个组件，您可以根据需求在配置文件中调整：

组件类型	支持选项
向量数据库	Qdrant, FAISS, Chroma
Embedding 模型	OpenAI, HuggingFace, Cohere
大语言模型 (LLM)	OpenAI, Anthropic, 本地部署模型
重排序 (Reranker)	Cohere, ColBERT, Cross-encoder
文档解析器	Docling, Unstructured, PyMuPDF

现在，您已经成功部署并集成了 Simba，可以开始构建属于您自己的高性能 AI 客服系统了。