# nas-kb

**Repository Path**: bsxbl/nas-kb

## Basic Information

- **Project Name**: nas-kb
- **Description**: 基于 RAG（检索增强生成）的智能内容创作平台，支持文档解析、知识库管理、AI 对话和卡片图片生成。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-12-04
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 奈斯KB (nas-kb)

基于 RAG（检索增强生成）的智能内容创作平台，支持文档解析、知识库管理、AI 对话和卡片图片生成。

[![Gitee](https://img.shields.io/badge/Gitee-nas--kb-red?logo=gitee)](https://gitee.com/bsxbl/nas-kb.git)

## ✨ 功能特性

- **文档解析**：支持 PDF、DOCX、Markdown、TXT 等多种格式
- **知识库管理**：文档向量化存储，支持语义检索
- **RAG 对话**：基于知识库的智能问答
- **卡片生成**：自动生成精美的内容卡片图片
- **多模型支持**：兼容 Ollama、DeepSeek 等主流大模型
- **网页抓取**：内置 Playwright 支持网页内容提取

## 🛠 技术栈

| 后端 | 前端 |
|------|------|
| FastAPI | Vue 3 + TypeScript |
| SQLAlchemy | Tailwind CSS |
| Playwright | Axios |
| uv (包管理) | Vite |

## 📁 项目结构

```
nas-kb/
├── backend/
│   └── app/
│       ├── api/routers/     # API 路由
│       ├── services/        # 业务逻辑
│       ├── models/          # 数据模型
│       ├── parsers/         # 文件解析器
│       └── utils/           # 工具函数
├── frontend/
│   └── src/
│       ├── views/           # 页面组件
│       ├── api/             # API 客户端
│       └── components/      # 通用组件
└── docker-compose.yml
```

## 🚀 快速开始

### 环境要求

- Python 3.10+
- Node.js 16+
- [uv](https://github.com/astral-sh/uv) (Python 包管理)

### 一键启动

```bash
# macOS/Linux
./start-all.sh

# Windows
start-all.bat
```

### 分别启动

**后端**
```bash
cd backend
uv sync
uv run uvicorn app.main:app --reload --port 8000
```

**前端**
```bash
cd frontend
npm install
npm run dev
```

### Docker 部署

```bash
docker-compose up -d
```

访问 http://localhost 即可使用。

## 📖 使用指南

1. **配置大模型** - 在"大模型配置"页面添加 Ollama 或 DeepSeek 模型
2. **上传文档** - 在"文件管理"页面上传文档，系统自动解析并向量化
3. **知识库对话** - 基于上传的文档进行智能问答
4. **生成卡片** - 将内容生成为精美的卡片图片

## 🔗 服务地址

| 服务 | 地址 |
|------|------|
| 前端 | http://localhost:5173 |
| 后端 API | http://localhost:8000 |
| API 文档 | http://localhost:8000/docs |

## 📄 License

MIT