# Yuxi-Know **Repository Path**: wellstudy0806/Yuxi-Know ## Basic Information - **Project Name**: Yuxi-Know - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: 0.1.1 - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-06-04 - **Last Updated**: 2025-06-04 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

语析 - 基于大模型的知识库与知识图谱问答系统

![](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=ffffff) ![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=flat&logo=vuedotjs&logoColor=%234FC08D) ![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=flat&logo=fastapi) ![](https://img.shields.io/github/issues/xerrors/Yuxi-Know?color=F48D73) ![](https://img.shields.io/github/license/bitcookies/winrar-keygen.svg?logo=github) ![](https://img.shields.io/github/stars/xerrors/Yuxi-Know)
## 📝 项目概述 语析是一个强大的问答平台，结合了大模型 RAG 知识库与知识图谱技术，基于 Llamaindex + VueJS + FastAPI + Neo4j 构建。 **核心特点：** - 🤖 多模型支持：适配 OpenAI、各大国内主流大模型平台，以及本地 vllm、ollama 部署 - 📚 灵活知识库：支持 PDF、TXT、MD、Docx 等多种格式文档，支持通过 URL 添加文件 - 🕸️ 知识图谱集成：基于 Neo4j 的知识图谱问答能力 - 🚀 简单配置：只需配置对应服务平台的 `API_KEY` 即可使用 - 🌐 网页检索：支持联网搜索，辅助回答最新信息 - 🤖 智能体拓展：可以编写自己的智能体代码 - ⚒️ 适合二次开发：更多的开发自定义项 V0.1 版本发布：支持多用户、智能体构建～ ![欢迎 Star](https://github.com/user-attachments/assets/a9ea624a-7b95-4bc1-a3c7-bfec6c587b5c) ![流程图](https://github.com/user-attachments/assets/75010511-4ac5-4924-8268-fea9a589839c) ## 📋 更新日志 - **2025.05.07** - 新增权限控制功能，主要角色分为 超级管理员、管理员、普通用户 [PR#173](https://github.com/xerrors/Yuxi-Know/pull/173) - **2025.03.30** - 系统中集成智能体（WIP， [PR#96](https://github.com/xerrors/Yuxi-Know/pull/96)） - **2025.02.24** - 新增网页检索以及内容展示，需配置 `TAVILY_API_KEY`，感谢 [littlewwwhite](https://github.com/littlewwwhite) - **2025.02.23** - SiliconFlow 的 Rerank 和 Embedding model 支持，现默认使用 SiliconFlow - **2025.02.20** - DeepSeek-R1 支持，需配置 `DEEPSEEK_API_KEY` 或 `SILICONFLOW_API_KEY` ## 🚀 快速开始 ### 环境配置 在启动前，您需要提供 API 服务商的 API_KEY，并放置在 `src/.env` 文件中（此文件项目中没有，需要自行参考 [src/.env.template](src/.env.template) 创建）。更多可配置项，可参考下方**对话模型**部分。 默认使用硅基流动的服务，因此**必须**配置： ``` SILICONFLOW_API_KEY=sk-270ea********8bfa97.e3XOMd****Q1Sk ``` 其他可选配置： ``` OPENAI_API_KEY= # OpenAI 服务 DEEPSEEK_API_KEY= # DeepSeek 服务 ZHIPUAI_API_KEY= # 智谱清言服务 TAVILY_API_KEY= # 联网搜索功能 ``` 需要确保账户有一点点额度供调用，或使用这个链接注册[SiliconFlow 注册（含邀请码）](https://cloud.siliconflow.cn/i/Eo5yTHGJ)获得 14 元的赠送额度。 > 本项目的基础对话服务可在不含显卡的设备上运行，大模型使用在线服务商的接口。 ### 启动服务 > 确保已经安装了 [docker](https://docs.docker.com/engine/install/ubuntu/) 以及 [nvidia-container-toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) **开发环境启动**（源代码修改会自动更新）： ```bash docker compose up --build ``` > 添加 `-d` 参数可在后台运行 成功启动后，会看到以下容器： ``` [+] Running 7/7 ✔ Network docker_app-network Created ✔ Container graph-dev Started ✔ Container milvus-etcd-dev Started ✔ Container milvus-minio-dev Started ✔ Container milvus-standalone-dev Started ✔ Container api-dev Started ✔ Container web-dev Started ``` 注：当内存不足时，可能会出现 Milvus 没有正常启动的情况。此时需要运行 `docker compose up milvus -d` 重新启动 Milvus，并重启 API 服务 `docker restart api-dev`。 访问 [http://localhost:5173/](http://localhost:5173/) 即可使用系统。 https://github.com/user-attachments/assets/15f7f315-003d-4e41-a260-739c2529f824 ### 服务管理 **关闭服务**： ```bash docker compose down ``` **查看日志**： ```bash docker logs <容器名称> # 例如：docker logs api-dev ``` ## 💻 模型支持 ### 1. 对话模型 本项目支持通过 API 调用的模型，本地模型需使用 vllm、ollama 转成 API 服务后使用。 | 模型供应商 | 默认模型 | 配置项目 | | :--------------------- | :---------------------------------- | :---------------------- | | `siliconflow` (默认) | `Qwen/Qwen2.5-7B-Instruct` (免费) | `SILICONFLOW_API_KEY` | | `openai` | `gpt-4o` | `OPENAI_API_KEY` | | `deepseek` | `deepseek-chat` | `DEEPSEEK_API_KEY` | | `arc`（豆包方舟） | `doubao-1-5-pro-32k-250115` | `ARK_API_KEY` | | `zhipu`（智谱清言） | `glm-4-flash` | `ZHIPUAI_API_KEY` | | `dashscope`（阿里） | `qwen-max-latest` | `DASHSCOPE_API_KEY` | | `together.ai` | `meta-llama/Llama-3.3-70B-Instruct-Turbo-Free` | `TOGETHER_API_KEY` | | `lingyiwanwu`（零一）| `yi-lightning` | `LINGYIWANWU_API_KEY` | | `openrouter` | `openai/gpt-4o` | `OPENROUTER_API_KEY` | #### 添加新模型供应商 如需添加供应商模型，了解 OpenAI 调用方法后，在 [src/static/models.yaml](src/static/models.yaml) 中添加对应配置： ```yaml ark: name: 豆包（Ark） url: https://console.volcengine.com/ark/region:ark+cn-beijing/model # 模型列表 default: doubao-1-5-pro-32k-250115 # 默认模型 base_url: https://ark.cn-beijing.volces.com/api/v3 env: # 需要配置的环境变量，仅限API key - ARK_API_KEY models: - doubao-1-5-pro-32k-250115 - doubao-1-5-lite-32k-250115 - deepseek-r1-250120 ``` 本地模型部署参考 [how-to.md](./docs/how-to.md) ### 2. 向量模型和重排序模型 强烈建议测试阶段先使用硅基流动部署的 bge-m3（免费且无需修改）。其他模型配置参考 [src/static/models.yaml](src/static/models.yaml)。 选择 `local` 前缀的模型会自动下载。如遇下载问题，请参考 [HF-Mirror](https://hf-mirror.com/) 配置。详细配置过程请参考 [how-to.md](./docs/how-to.md)。 ## 📚 知识库功能 本项目支持多种格式的知识库文件：PDF、TXT、Markdown、Docx。支持通过 URL 添加文件。 文件上传后，系统会对文件进行分块、索引、存储到向量数据库（Milvus）中，此过程可能需要一定时间，请耐心等待。 ## 🕸️ 知识图谱功能 本项目使用 Neo4j 作为知识图谱存储。您需要将图谱整理成 jsonl 格式，每行格式为： ``` {"h": "北京", "t": "中国", "r": "首都"} ``` 然后在网页的图谱管理中添加此文件。 > [!说明] > 现阶段项目使用的 OneKE 自动创建知识图谱效果不佳，已暂时移除，建议在项目外创建知识图谱 系统启动后会自动启动 neo4j 服务： - 访问地址：[http://localhost:7474/](http://localhost:7474/) - 默认账户：`neo4j` - 默认密码：`0123456789` 可在 `docker-compose.yml` 中修改配置（注意同时修改 `api.environment` 和 `graph.environment`）。 如已有基于 neo4j 的知识图谱，可删除 `docker-compose.yml` 中的 `graph` 配置项，并修改 `api.environment` 中的 `NEO4J_URI` 为您的 neo4j 服务地址。同时，需要确保节点的标签中包含 Entity 标签，才能正常触发索引。 ## 贡献者名单 感谢以下贡献者的支持！ 贡献者名单 ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=xerrors/Yuxi-Know)](https://star-history.com/#xerrors/Yuxi-Know)