内容
<p align="center">
<img src="docs/aryx-logo.png" alt="Aryx" width="160" />
</p>
# Aryx 精简版
**将 Aryx 指向您的數據。獲取一個去重複、關聯的知識圖譜，您可以向它提問 — 並且每個答案都有來源。**
[](https://github.com/giggsoinc/aryx/actions/workflows/ci.yml)
[](LICENSE)
[](https://github.com/FalkorDB/FalkorDB)
[](https://hub.docker.com/r/giggsodocker/aryx-lite)
[](https://hub.docker.com/r/giggsodocker/aryx-lite-web)
[安裝](docs/INSTALL.md) · [Docker Hub](docs/DOCKERHUB.md) · [用戶指南](docs/USER_GUIDE.md) · [快速入門數據](examples/quickstart/) · [貢獻](CONTRIBUTING.md) · [Raven (Claude Code)](docs/RAVEN.md) · [行為準則](CODE_OF_CONDUCT.md) · [許可證](docs/LICENSING.md)
> **公開 · 源碼可用（BSL 1.1）。** Postgres 是記錄系統；實時知識圖譜被投影到 **[FalkorDB](https://github.com/FalkorDB/FalkorDB)**。
---
## 倉庫概述
**Aryx** 將您已有的數據轉換為 **工作區範圍的知識圖譜**，您可以向它提問。您可以用自然語言陳述目標，連接數據庫或上傳文件，批准 Aryx 提出的模型，解析重複實體為黃金實體，並使用 **詢問**、**模型**、**數據**（樹 / 表 / 實體圖譜）和 **準確性實驗室** 進行探索 — 所有答案都有 **來源**。
| | |
|---|---|
| **此倉庫中的版本** | **Aryx 精简版** — 單團隊成果映射（筆記本電腦 / 小型服務器） |
| **非（尚未）** | 多租戶治理企業資產（該路徑是企業版 / Aryx-o） |
| **SoT / 圖譜** | PostgreSQL 真實來源 · FalkorDB 可重建投影 |
| **UI** | Next.js 僅限（`apps/web`）— 無 Streamlit |
| **鏡像（公開）** | [`giggsodocker/aryx-lite`](https://hub.docker.com/r/giggsodocker/aryx-lite) （API · 工作器 · MCP）· [`giggsodocker/aryx-lite-web`](https://hub.docker.com/r/giggsodocker/aryx-lite-web) （Next.js UI） |
| **標籤** | `latest` · `1.0.0` · `v1.0.0` · git 短 SHA（兩個鏡像上的相同標籤） |
| **許可證** | BSL 1.1 → GPL-3.0-or-later 於 2029-07-15 · [詳情](docs/LICENSING.md) |
| **Docker Hub 概述** | [docs/DOCKERHUB.md](docs/DOCKERHUB.md) · [aryx-lite](https://hub.docker.com/r/giggsodocker/aryx-lite) · [aryx-lite-web](https://hub.docker.com/r/giggsodocker/aryx-lite-web) |
---
## 功能
| 步驟 | 發生情況 |
|------|----------------|
| **1. 目標** | 您用自然語言描述您想要查詢的內容 |
| **2. 導入** | 連接數據庫或上傳文件（CSV, PDF, DOCX, …） |
| **3. 解析** | 重複項合併為黃金實體；弱配對等待人工審核 |
| **4. 連結** | 發現跨文件關係並投影到圖譜中 |
| **5. 探索** | 詢問、模型畫布、數據瀏覽器（樹 / 表 / **實體圖譜**）、準確性實驗室 |
適用於 **單團隊** 在筆記本電腦或小型服務器上的成果映射 — 尚未適用於多租戶治理企業資產。
---
## 快速入門
**需求：** [Docker](https://docs.docker.com/get-docker/) + Docker Compose · 約 8 GB RAM 推薦（Ollama 模型）
**鏡像（Docker Hub，公開 — 無需登錄即可拉取）：**
| 鏡像 | 角色 | 標籤 |
|-------|------|------|
| [`giggsodocker/aryx-lite`](https://hub.docker.com/r/giggsodocker/aryx-lite) | API · 工作器 · MCP | `latest` · `1.0.0` · `v1.0.0` · `<sha>` |
| [`giggsodocker/aryx-lite-web`](https://hub.docker.com/r/giggsodocker/aryx-lite-web) | Next.js UI | 相同標籤 |
```bash
git clone https://github.com/giggsoinc/aryx.git
cd aryx
cp .env.example .env # 編輯密碼 / LLM 金鑰（如果需要）
docker compose pull # 拉取公共 Hub 鏡像（無需 docker 登錄）
docker compose up -d # 從源碼構建（如果需要）
```
首次啟動會將 LLM 模型拉取到 Ollama（可能需要幾分鐘）。
| 界面 | URL |
|---------|-----|
| **Web UI** | http://localhost:3000 |
| **設置** （LLM 提供商 / API 金鑰） | http://localhost:3000/settings |
| **API 文件** | http://localhost:8088/docs |
| **MCP (SSE)** | http://localhost:8765/sse |
然後：打開 Web UI → **新建工作區** → **引導式安裝** （`/start`）→ 目標 → 添加來源 → 運行。
**示例數據：** 上傳 [`examples/quickstart/`](examples/quickstart/) 中的 CSV 文件（客戶 + 票據）以練習多文件導入和實體圖譜。
完整步驟、端口和故障排除： **[docs/INSTALL.md](docs/INSTALL.md)** · Hub 副本： **[docs/DOCKERHUB.md](docs/DOCKERHUB.md)** · UI 演練： **[docs/USER_GUIDE.md](docs/USER_GUIDE.md)**
### 煙霧測試（API）
```bash
curl -s http://localhost:8088/health
# 然後打開 http://localhost:3000
```
### 拉取固定鏡像
```bash
docker pull giggsodocker/aryx-lite:1.0.0
docker pull giggsodocker/aryx-lite-web:1.0.0
# 或 latest / v1.0.0 / git 短 SHA
```
---
## 产品界面（Next.js）
| 路由 | 用途 |
|-------|---------|
| `/start` | 引導式安裝精靈 |
| `/` | **詢問** — 有根據的問答與引用 |
| `/model` | 本體畫布（類型、關係、存活率、公理） |
| `/data` | 透明度瀏覽器 — 樹、表、**互動實體圖譜** |
| `/lab` | 準確性實驗室 — 本體開啟與關閉 + 推理器檢查 |
| `/settings` | **LLM 提供商** — Ollama, Anthropic, OpenAI 相容, Gemini, Grok (xAI) |
沒有 **Streamlit UI**。產品 UI 僅限 Next.js。
---
## 亮點
- **多源導入** — Postgres, MySQL, Oracle; 文件（CSV/JSON/PDF/DOCX/PPTX/圖片）
- **發現驅動的本體** — 提出類型，人類審批門檻，RDF/OWL 導入導出
- **實體解析** — 多鍵阻塞，四頻段評分，HITL 審核，存活率政策
- **跨文件關係** — 確定性 FK 發現後的多文件上傳
- **實體圖譜** — 平移/縮放，搜索，類型過濾，點擊探索鄰居 + 詳細面板
- **工作區隔離** — LIST-partitioned Postgres; 每個工作區一個圖譜
- **本地或雲端 LLM** — 默認 Ollama; 在設置中交換（無需重啟）
- **MCP** — SSE 外部代理工具
- **端口和適配器** — 關係型 / 圖譜 / 向量 / LLM / 推理器 / 可交換計算以適用於企業 / Aryx-o
---
## 堆棧
| 層 | 技術 |
|-------|------------|
| API | FastAPI + OpenAPI |
| Web | Next.js 15 (App Router, Tailwind) |
| 數據庫（真實來源） | PostgreSQL 16 + pgvector |
| **圖譜投影** | **[FalkorDB](https://github.com/FalkorDB/FalkorDB)** （每個工作區一個命名圖譜） |
| LLM | Ollama （默認）· Anthropic · OpenAI 相容 · Gemini · Grok |
| 代理 | MCP 超過 SSE |
| 部署 | Docker Compose · [`giggsodocker/aryx-lite`](https://hub.docker.com/r/giggsodocker/aryx-lite) |
Aryx 是 FalkorDB（和 Postgres）之上的應用程序，而不是數據庫的分支。
---
## 文檔
| 文檔 | 內容 |
|-----|----------|
| [安裝](docs/INSTALL.md) | Docker, Hub 鏡像, 環境變量, 安全, 更新, 本地開發 |
| [用戶指南](docs/USER_GUIDE.md) | 工作區, 引導式安裝, 詢問, 數據, 模型, 實驗室, 設置 |
| [快速入門數據](examples/quickstart/) | 示例 CSV 文件導入圖譜 |
| [功能](docs/FEATURES.md) | 功能矩陣 |
| [架構](docs/ARCHITECTURE.md) | 系統設計 |
| [許可證](docs/LICENSING.md) | BSL 簡體中文 |
| [導入](docs/INGESTION_GUIDE.md) | 深入導入演練 |
| [Docker Hub 概述](docs/DOCKERHUB.md) | 鏡像描述（API / 工作器 / MCP） |
| [Raven](docs/RAVEN.md) | 可選 Claude Code 工作流程（`.claude` + 清單） |
| [基準測試](docs/wiki/BENCHMARKS.md) | ER 測量 |
圖表： [業務視圖](docs/diagrams/business-view.html) · [技術流程](docs/diagrams/technical-flow.html)
---
## 社區
- [行為準則](CODE_OF_CONDUCT.md)
- [貢獻](CONTRIBUTING.md)
- [安全政策](SECURITY.md)
- [問題](https://github.com/giggsoinc/aryx/issues) · [討論](https://github.com/giggsoinc/aryx/discussions) （如果啟用）
---
## 許可證（BSL 1.1）
在 **商業源許可證 1.1** 下源碼可用。您可以在附加使用許可下將 Aryx 精簡版用於評估，研究和內部生產。競爭性多租戶託管此作品需要商業許可證，直到變更日期（**2029-07-15**），屆時此版本將成為 **GPL-3.0-or-later**。
完整文本： [`LICENSE`](LICENSE) · 摘要： [`docs/LICENSING.md`](docs/LICENSING.md) · 注意： [`NOTICE`](NOTICE)
---
## 誰構建它
由 **[Giggso](https://giggso.com)** 維護。
