构建。
- **Gradio 主题**：若你使用 Gradio 进行开发，可在此查看我们的主题：[kotaemon-gradio-theme](https://github.com/lone17/kotaemon-gradio-theme).
## 核心特性
- **自托管文档问答（RAG）Web UI**：支持多用户登录，在私有/公开集合中整理文件，协作并与他人分享你喜爱的对话。
- **管理 LLM 与 Embedding 模型**：支持本地 LLM 及主流 API 提供商（OpenAI、Azure、Ollama、Groq）。
- **混合 RAG 流水线**：提供合理的默认 RAG 流水线，采用混合（全文与向量）检索器并重排序，以确保最佳检索质量。
- **多模态问答支持**：对包含图表、表格的多份文档进行问答。支持多模态文档解析（可在 UI 中选择选项）。
- **高级引用与文档预览**：默认提供详细引用，以确保 LLM 回答的准确性。可在_浏览器内 PDF 查看器_中直接查看引用（含相关度分数）及高亮。当检索流水线返回相关性较低的文章时会发出警告。
- **支持复杂推理方法**：通过问题分解回答复杂/多跳问题。支持基于智能体的推理，可使用 `ReAct`、`ReWOO` 及其他智能体。
- **可配置设置 UI**：可在 UI 上调整检索与生成过程中的大多数重要环节（含提示词 prompts）。
- **可扩展**：基于 Gradio 构建，你可自由自定义或添加任意 UI 元素。此外，我们致力于支持多种文档索引与检索策略。`GraphRAG` 索引流水线作为示例提供。
## 安装
> 若你不是开发者，仅想使用本应用，请参阅我们易于上手的[用户指南](https://cinnamon.github.io/kotaemon/). 从[最新发布版](https://github.com/Cinnamon/kotaemon/releases/latest) 下载 `.zip` 文件，以获取所有最新功能与错误修复。
### 系统要求
1. [Python](https://www.python.org/downloads/) >= 3.10
2. [Docker](https://www.docker.com/): 可选，若你[使用 Docker 安装](#with-docker-recommended)
3. [Unstructured](https://docs.unstructured.io/open-source/installation/full-installation#full-installation) 若你希望处理除 `.pdf`、`.html`、`.mhtml` 和 `.xlsx` 以外的文档，则需安装。安装步骤因操作系统而异。请访问该链接并按其中说明操作。
### 使用 Docker（推荐）
1. 我们同时支持 `lite` 与 `full` 两种 Docker 镜像版本。使用 `full` 版本时，将安装 `unstructured` 的额外软件包，可支持更多文件类型（`.doc`、`.docx` 等），但镜像体积更大。对大多数用户而言，`lite` 镜像在多数情况下即可满足需求。
- 使用 `full` 版本。
```shell
docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \
-v ./ktem_app_data:/app/ktem_app_data \
-p 7860:7860 -it --rm \
ghcr.io/cinnamon/kotaemon:main-full
```
- 使用内置 **Ollama** 的 `full` 版本，用于_本地/私有 RAG_。
```shell
# change image name to
docker run <...> ghcr.io/cinnamon/kotaemon:main-ollama
```
- 使用 `lite` 版本。
```shell
# change image name to
docker run <...> ghcr.io/cinnamon/kotaemon:main-lite
```
2. 我们目前支持并测试两个平台：`linux/amd64` 与 `linux/arm64`（适用于较新的 Mac）。可在 `docker run` 命令中通过传入 `--platform` 指定平台。例如：
```shell
# To run docker with platform linux/arm64
docker run \
-e GRADIO_SERVER_NAME=0.0.0.0 \
-e GRADIO_SERVER_PORT=7860 \
-v ./ktem_app_data:/app/ktem_app_data \
-p 7860:7860 -it --rm \
--platform linux/arm64 \
ghcr.io/cinnamon/kotaemon:main-lite
```
3. 一切配置正确后，可访问 `http://localhost:7860/` 打开 WebUI。
4. 我们使用 [GHCR](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) 存储 Docker 镜像，所有镜像可在[此处](https://github.com/Cinnamon/kotaemon/pkgs/container/kotaemon) 找到。
### 不使用 Docker
1. 克隆仓库：
```shell
git clone https://github.com/Cinnamon/kotaemon
cd kotaemon
```
2. 配置环境：
- **选项 1：使用 [uv](https://docs.astral.sh/uv/getting-started/installation/)（推荐）**
```shell
uv sync --python 3.10
source .venv/bin/activate
```
- **选项 2：使用 conda**
```shell
conda create -n kotaemon python=3.10
conda activate kotaemon
pip install -e "libs/kotaemon[all]"
pip install -e "libs/ktem"
```
3. 在本项目根目录创建 `.env` 文件。以 `.env.example` 为模板。
`.env` 文件用于满足用户在启动应用前预先配置模型的场景（例如将应用部署到 HF hub）。该文件仅在首次运行时用于填充数据库一次，后续运行将不再使用。
4.（可选）要启用浏览器内 `PDF_JS` 查看器，请下载 [PDF_JS_DIST](https://github.com/mozilla/pdf.js/releases/download/v4.0.379/pdfjs-4.0.379-dist.zip)，然后解压到 `libs/ktem/ktem/assets/prebuilt`。
5. 启动 Web 服务器：
```shell
python app.py
```
- 应用会自动在浏览器中打开。
- 默认用户名和密码均为 `admin`。你可以通过 UI 直接添加更多用户。
6. 检查 `Resources` 标签页和 `LLMs and Embeddings`，确保你的 `api_key` 值已从 `.env` 文件正确设置。若未设置，可在该处进行配置。
### 配置 GraphRAG
> [!NOTE]
> 官方 MS GraphRAG 索引仅支持 OpenAI 或 Ollama API。
> 我们建议大多数用户使用 NanoGraphRAG 实现，以便与 Kotaemon 轻松集成。