Simba 项目使用教程

Simba 项目使用教程

simba Portable KMS (knowledge management system) designed to integrate seamlessly with any Retrieval-Augmented Generation (RAG) system 项目地址: https://gitcode.com/gh_mirrors/simba4/simba

1. 项目目录结构及介绍

Simba 项目是一个开源的便携式知识管理系统（KMS），旨在与检索增强生成（RAG）系统无缝集成。以下是项目的目录结构及其简要介绍：

simba/
├── assets/                # 静态资源文件
├── docker/                # Docker 配置文件和脚本
├── docs/                  # 项目文档
├── examples/              # 示例代码
│   └── notebook_rag/      # RAG 系统示例笔记本
├── frontend/              # 前端代码
├── scripts/               # 脚本文件
├── simba/                 # Simba 核心代码
├── simba_sdk/             # Simba SDK 代码
├── tests/                 # 测试代码
├── .dockerignore          # Docker 忽略文件
├── .env.example           # 环境变量示例文件
├── .flake8                # Flake8 配置文件
├── .gitchangelog.rc        # GitChangelog 配置文件
├── .gitignore             # Git 忽略文件
├── .python-version        # Python 版本要求
├── CHANGELOG.md           # 更新日志
├── LICENSE.md             # 许可证文件
├── MANIFEST.in            # 打包文件列表
├── Makefile               # Makefile 配置
├── README.md              # 项目介绍文件
├── config.yaml            # 配置文件
└── poetry.lock            # Poetry 依赖锁文件

2. 项目的启动文件介绍

Simba 项目的启动主要包括以下几个文件：

• simba server: 启动 Simba 服务端的命令，通常在项目根目录下执行。
• simba front: 启动 Simba 前端界面的命令，用于管理文档块。
• simba parsers: 启动 Simba 解析器的命令，用于处理文档解析任务。

以下是启动 Simba 项目的步骤：

1. 进入项目根目录。
2. 激活虚拟环境（如果使用 Poetry）。
3. 运行 simba server、simba front 和 simba parsers 命令。

3. 项目的配置文件介绍

Simba 项目的配置主要通过 config.yaml 和环境变量进行。

• config.yaml: 包含项目的核心配置，如项目名称、版本、API 版本、基础目录、向量存储配置、LLM（大型语言模型）配置、嵌入配置、向量存储配置、分块配置、检索方法等。

以下是一个简化的 config.yaml 配置示例：

project:
  name: "Simba"
  version: "1.0.0"
  api_version: "/api/v1"
paths:
  base_dir: null
faiss_index_dir: "vector_stores/faiss_index"
vector_store_dir: "vector_stores"
llm:
  provider: "openai"
  model_name: "gpt-4o-mini"
  temperature: 0.0
  max_tokens: null
  streaming: true
embedding:
  provider: "huggingface"
  model_name: "BAAI/bge-base-en-v1.5"
  device: "cpu"
vector_store:
  provider: "faiss"
  collection_name: "simba_collection"
chunking:
  chunk_size: 512
  chunk_overlap: 200
retrieval:
  method: "hybrid"
  k: 5

• 环境变量：通过 .env.example 文件提供的示例，可以设置环境变量，如 API 密钥、Redis 主机、Celery 配置等。

以下是一个简化的环境变量示例：

OPENAI_API_KEY=your_openai_api_key
REDIS_HOST=localhost
CELERY_BROKER_URL=redis://localhost:6379/0
CELERY_RESULT_BACKEND=redis://localhost:6379/1

确保在启动项目之前，正确配置这些文件。

simba Portable KMS (knowledge management system) designed to integrate seamlessly with any Retrieval-Augmented Generation (RAG) system 项目地址: https://gitcode.com/gh_mirrors/simba4/simba