xinli/QUICK-START-FREE-API.md
2025-12-19 14:03:43 +08:00

155 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🚀 5分钟快速开始 - 使用免费API
## 步骤1: 获取免费API Key (2分钟)
### 方式1: 硅基流动 (推荐) ⭐
1. 访问: https://cloud.siliconflow.cn
2. 点击"免费注册"
3. 使用微信或手机号注册
4. 进入控制台 → API密钥
5. 点击"创建新密钥"
6. 复制密钥(格式: `sk-xxxxxx`
**免费额度**: 每月免费Token足够测试使用
### 方式2: DeepSeek (备选)
1. 访问: https://platform.deepseek.com
2. 注册账号
3. 充值10元可用很久
4. 获取API Key
## 步骤2: 配置API Key (1分钟)
打开文件: `ry-xinli-admin/src/main/resources/application.yml`
找到这一行:
```yaml
api-key: sk-your-api-key-here
```
替换为你的API Key
```yaml
api-key: sk-abcdefghijklmnopqrstuvwxyz123456
```
**完整配置示例**:
```yaml
rag:
mode: openai
openai:
base-url: https://api.siliconflow.cn/v1
api-key: sk-你的密钥 # ⚠️ 修改这里
embed-model: BAAI/bge-large-zh-v1.5
generate-model: deepseek-ai/DeepSeek-V3
```
## 步骤3: 启动应用 (2分钟)
```bash
cd ry-xinli-admin
mvn spring-boot:run
```
等待启动完成,看到:
```
Started XinliAdminApplication in X seconds
```
## 步骤4: 测试功能 (1分钟)
### 测试1: 健康检查
浏览器访问:
```
http://localhost:8080/psychology/rag-test/health
```
应该看到:
```json
{
"code": 200,
"data": {
"overall_status": "HEALTHY"
}
}
```
### 测试2: 向量化测试
```bash
curl -X POST "http://localhost:8080/psychology/rag-test/test-embedding" \
-d "text=测试文本"
```
### 测试3: 文本生成测试
```bash
curl -X POST "http://localhost:8080/psychology/rag-test/test-generation" \
-d "prompt=什么是心理学?"
```
## ✅ 完成!
现在你可以:
1. **上传文档**: 通过API上传心理学文档
2. **智能问答**: 基于知识库回答问题
3. **生成报告**: 生成AI增强的心理评估报告
## 📚 下一步
- 查看完整API文档: `RAG-API-EXAMPLES.md`
- 了解更多免费服务: `RAG-FREE-SERVICES-GUIDE.md`
- 开发前端页面: 参考API示例
## ❓ 遇到问题?
### 问题1: API Key无效
**错误**: `401 Unauthorized`
**解决**:
1. 检查API Key是否正确复制
2. 确认没有多余的空格
3. 确认API Key以`sk-`开头
### 问题2: 连接超时
**错误**: `Connection timeout`
**解决**:
1. 检查网络连接
2. 确认可以访问 https://api.siliconflow.cn
3. 尝试使用VPN如果在特殊网络环境
### 问题3: 免费额度用完
**解决**:
1. 等待下月刷新
2. 充值少量金额(通常几元即可)
3. 切换到其他免费服务
## 💡 省钱小技巧
1. **减少检索数量**:
```yaml
retrieval:
top-k: 3 # 默认5改为3
```
2. **使用更小的模型**:
```yaml
generate-model: Qwen/Qwen2.5-7B-Instruct # 更快更便宜
```
3. **提高相似度阈值**:
```yaml
similarity-threshold: 0.75 # 默认0.7提高到0.75
```
---
**需要帮助?** 查看详细文档: `RAG-FREE-SERVICES-GUIDE.md`