# 大模型 Prompt 优化工具

**Repository Path**: abu117/Prompt

## Basic Information

- **Project Name**: 大模型 Prompt 优化工具
- **Description**: 大模型 Prompt 优化工具
- **Primary Language**: Java
- **License**: Unlicense
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-03-14
- **Last Updated**: 2025-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Prompt 优化工具

## 项目概述
Prompt 优化工具是一个基于 Spring Boot 和 Vue.js 开发的 Web 应用，旨在帮助用户将简短的任务描述转换成结构完整的 Prompt。通过调用大语言模型 API，系统能够智能地优化和扩充原始 Prompt，使其更加清晰、详细和有效。

## 核心功能
- Prompt 文本优化
- 多种 AI 模型支持
- 自定义 API Key
- 实时响应
- 内容清空功能
- 优化结果展示

## 技术栈
### 后端
- Java 17
- Spring Boot 3.2.2
- Spring MVC
- Lombok
- Jackson

### 前端
- Vue.js 3
- Element Plus
- Axios

### 开发工具
- Maven
- Git
- IntelliJ IDEA（推荐）

## 安装指南
1. 系统要求
   - JDK 17 或以上
   - Maven 3.6 或以上
   - Node.js（可选，用于前端开发）

2. 获取代码
```bash
git clone [repository-url]
cd prompt-optimizer
```

3. 编译项目
```bash
mvn clean package
```

4. 运行应用
```bash
java -jar target/prompt-optimizer-0.0.1-SNAPSHOT.jar
```

## Docker 部署
### 前置条件
- Docker
- Docker Compose

### 部署步骤
1. 准备环境文件
```bash
# 复制环境变量示例文件
cp .env.example .env

# 编辑 .env 文件，设置实际的 API Key
vim .env
```

2. 使用 Docker Compose 部署
```bash
# 构建并启动容器
docker-compose up -d --build

# 查看容器状态
docker-compose ps

# 查看应用日志
docker-compose logs -f
```

3. 管理命令
```bash
# 停止服务
docker-compose down

# 重启服务
docker-compose restart
```

4. 注意事项
- 默认端口为 8080，可在 docker-compose.yml 中修改
- 日志文件会保存在 ./logs 目录下
- 容器会自动重启（restart: always）
- 请确保 .env 文件不被提交到版本控制系统
- 建议在生产环境中使用 HTTPS
- 定期更新依赖和基础镜像

## 配置说明
### 应用配置（application.yml）
```yaml
server:
  port: 8080  # 服务端口

ai:
  model:
    api-key: "your-api-key"  # API 密钥
    api-url: "https://api.bigaipro.com/v1/chat/completions"  # API 地址
    model: "gpt-4o-mini"  # 默认模型
```

### 环境变量（可选）
- `AI_MODEL_API_KEY`: API 密钥
- `AI_MODEL_API_URL`: API 地址
- `SERVER_PORT`: 服务端口

## 使用指南
1. 访问应用
   - 打开浏览器，访问 `http://localhost:8080`

2. 基本操作
   - 在左侧文本框输入原始 Prompt
   - 点击"生成 Prompt"按钮
   - 优化后的 Prompt 将显示在右侧文本框
   - 使用"清空内容"按钮可清除两个文本框的内容

3. 高级设置
   - 点击"高级设置"展开更多选项
   - 选择不同的 AI 模型
   - 输入自定义的 API Key（可选）

## 主要功能页面
### 主页面
- 页面布局采用左右分栏设计
- 左侧为输入区，右侧为结果展示区
- 底部包含操作按钮和高级设置

### 高级设置面板
- 模型选择下拉框
- API Key 输入框（可选）

## 常用操作
1. 生成优化后的 Prompt
   - 输入原始文本
   - 点击"生成 Prompt"按钮
   - 等待结果显示

2. 清空内容
   - 点击"清空内容"按钮
   - 两个文本框的内容将被清空

3. 切换模型
   - 展开"高级设置"
   - 从下拉列表中选择所需模型

## API 文档
### POST /api/prompt/optimize
优化 Prompt 的主要 API 接口

请求体：
```json
{
  "taskDescription": "必传 原始 Prompt 文本",
  "apiKey": "必传 API Key",
  "model": "必传 模型名称"
}
```

响应体：
```json
{
  "prompt": "优化后的 Prompt 文本"
}
```

### GET /api/prompt/test
用于测试 API 是否正常工作的接口

响应：
```text
API is working!
```

## 版本历史
- v0.0.1
  - 初始版本
  - 基本的 Prompt 优化功能
  - 多模型支持
  - 自定义 API Key 支持

## 扩展开发
### 添加新的模型
1. 在 `index.html` 中的模型选择器添加新选项
2. 在后端配置中添加相应的模型支持

### 自定义优化规则
修改 `PromptService.java` 中的 `cleanupResponse` 方法：
```java
private String cleanupResponse(String content) {
    // 添加自定义的文本处理规则
}
```

## 注意事项
1. 安全性
   - 请勿在代码中硬编码 API Key
   - 建议使用环境变量或配置文件管理敏感信息
   - 生产环境建议启用 HTTPS

2. 性能优化
   - 适当设置连接超时时间
   - 考虑添加请求频率限制
   - 添加适当的错误重试机制

3. 错误处理
   - API 调用失败时会返回友好的错误提示
   - 网络超时时会自动重试
   - 无效的 API Key 会提示认证失败

## 联系与支持
- 项目维护者：[abu]
- 邮箱：[87448221@qq.com]
- 问题反馈：请在 GitHub Issues 中提交
- 贡献代码：欢迎提交 Pull Request

## 许可证
[许可证类型] - 查看 [LICENSE](LICENSE) 文件了解更多信息。