# PersonalAssistant

**Repository Path**: codeyumlee/PersonalAssistant

## Basic Information

- **Project Name**: PersonalAssistant
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-27
- **Last Updated**: 2026-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PersonalAssistant

AI 个人助手（知识库 Agent），重构自 [AgentLearn/agent-lab](../AgentLearn)。
架构：**Vue 3 前端 + FastAPI 后端**，前后端分离。

功能基线见 [docs/AgentLearn功能文档.md](docs/AgentLearn功能文档.md)（原项目全部功能的逐模块整理，重构对等实现的依据）。

## 目录结构

```
PersonalAssistant/
├── README.md
├── docs/                          # 功能文档 / 设计文档
├── PersonalAssistantService/      # Python 后端（FastAPI :8765）
│   ├── app/                       # Web 应用层
│   │   ├── main.py                #   FastAPI 实例/lifespan/CORS/挂载路由
│   │   ├── core/config.py         #   配置（环境变量 > .env > 默认值）
│   │   ├── api/v1/                #   薄路由层（system/chat/knowledge/upload）
│   │   ├── schemas/               #   Pydantic 请求模型
│   │   └── services/              #   业务层（Agent 单例/SSE 桥接、分片上传存储）
│   ├── agent/                     # Agent 领域核心（零第三方依赖，顶层独立）
│   ├── tests/                     # 冒烟测试 + E2E
│   ├── server.py                  # 启动器（python server.py）
│   ├── cli.py                     # CLI 入口
│   ├── kb_docs/                   # 示例知识库文档
│   └── agent_data/                # 运行时数据（不入库）
└── PersonalAssistantVue/          # Vue 3 + Vite 前端（开发 :5173）
    └── src/
```

## 快速开始

```bash
# 后端（首次）
cd PersonalAssistantService
python -m venv .venv
PYTHONUTF8=1 .venv/Scripts/python -m pip install -r requirements.txt
cp .env.example .env         # 填入 LLM_API_KEY
PYTHONUTF8=1 .venv/Scripts/python server.py    # http://127.0.0.1:8765，Swagger: /docs

# 前端（另开终端，首次）
cd PersonalAssistantVue
npm install
npm run dev                  # http://localhost:5173（/api 已代理到 8765）
```

## 测试

```bash
cd PersonalAssistantService
PYTHONUTF8=1 .venv/Scripts/python tests/test_server.py   # 离线全量测试，exit=0 为过
```

## 工作约定

- Windows GBK 控制台：Python 命令一律加 `PYTHONUTF8=1` 前缀（pip 装 UTF-8 注释的 requirements 时同样）
- 提交 message 用中文，格式 `type: 描述`（feat/fix/docs/chore/test）