# WordGenAI

**Repository Path**: StandFast/word-gen-ai

## Basic Information

- **Project Name**: WordGenAI
- **Description**: Word模板与AI相结合，解放我们的双手。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-06
- **Last Updated**: 2025-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Word-Gen-AI

基于 AI 的文档生成系统，提供智能化文档生成、下载及管理功能。

## 简介

Word-Gen-AI 是一个前后端分离的项目，前端使用 Vue.js 框架，后端采用 Spring Boot 框架。系统主要功能包括文档结构解析、变量提取、AI 生成文档、文档下载等。适用于需要自动化生成 Word 文档的业务场景。

## 技术架构

- **前端**：Vue.js + Element UI
- **后端**：Spring Boot + MyBatis + Spring MVC
- **文档处理**：使用 DocxExecutor 和 VisioExecutor 处理文档生成与 Visio 图生成
- **AI 支持**：集成 ChatBotClient 实现 AI 内容生成

## 主要功能

- 获取文档结构
- 提取文档变量
- AI 自动生成文档内容
- 文档下载与 Visio 图生成
- 缓存管理与结构化构建

## 后端模块说明

### `ProjectDocumentService`

核心文档处理服务类，提供如下功能：

- 获取文档结构
- 生成文档内容
- 下载文档
- 清除缓存
- 构建功能模块结构

### `ProjectDocumentClient`

对外暴露的 REST API 接口，支持如下请求：

- 获取变量列表
- 获取文档路径
- 生成文档
- 下载文档
- 构建功能结构

## 启动方式

### 后端启动

确保已安装 Java 11+ 和 Maven，执行以下命令启动后端服务：

```bash
mvn spring-boot:run
```

### 前端启动

进入 `tworice-admin-web` 目录，安装依赖并启动开发服务器：

```bash
npm install
npm run serve
```

## 接口调用示例

### 生成文档

**请求方式**：POST  
**路径**：`/client/projectDocument/generate`  
**请求体**：

```json
{
  "subject": "项目报告",
  "target": "D:/reports/",
  "variables": ["变量1", "变量2"]
}
```

### 下载文档

**请求方式**：POST  
**路径**：`/client/projectDocument/download`  
**请求体**：

```json
{
  "path": "D:/reports/项目报告.docx"
}
```

## 依赖组件

- Spring Boot 2.x
- MyBatis
- Vue.js 2.x
- Element UI
- ChatBotClient（AI 生成模块）

## 开发者

StandFast

## 协议

本项目采用 MIT 协议，请参阅 [LICENSE](LICENSE) 文件获取详细信息。