SSE使用说明.md4.47 kB
# 股票分析SSE工具使用说明
## 🎉 服务器已启动成功！
✅ **服务器地址**: http://localhost:8001/sse
✅ **API文档**: http://localhost:8001/sse/api/tools
✅ **支持协议**: HTTP API + SSE (Server-Sent Events)
## 🚀 在CherryStudio中使用
### 1. 配置方式
- 使用配置文件：`cherry_studio_sse_config.json`
- 基础URL：`http://localhost:8001/sse`
- 支持6个核心工具和2个SSE实时数据流
### 2. 可用工具
#### 📊 实时行情
- **端点**: `/api/stock/realtime`
- **SSE流**: `/sse/stock/realtime`
- **参数**: `symbol` (股票代码)
- **示例**: `http://localhost:8080/api/stock/realtime?symbol=000001`
#### 📈 历史数据
- **端点**: `/api/stock/history`
- **参数**: `symbol`, `period`, `start_date`, `end_date`
- **示例**: `http://localhost:8080/api/stock/history?symbol=000001&period=daily`
#### 🔧 技术指标
- **端点**: `/api/stock/indicators`
- **参数**: `symbol`, `indicators`
- **示例**: `http://localhost:8080/api/stock/indicators?symbol=000001&indicators=ma,rsi`
#### 💭 市场情绪
- **端点**: `/api/market/sentiment`
- **SSE流**: `/sse/market/sentiment`
- **参数**: `symbol` (可选)
- **示例**: `http://localhost:8080/api/market/sentiment`
#### 🔍 股票搜索
- **端点**: `/api/stock/search`
- **参数**: `keyword`
- **示例**: `http://localhost:8080/api/stock/search?keyword=银行`
#### 📰 股票新闻
- **端点**: `/api/stock/news`
- **参数**: `symbol`, `limit`
- **示例**: `http://localhost:8080/api/stock/news?symbol=000001&limit=5`
## 🔄 SSE实时数据流
### 实时行情流
```javascript
const eventSource = new EventSource('http://localhost:8080/sse/stock/realtime?symbol=000001');
eventSource.onmessage = function(event) {
const data = JSON.parse(event.data);
console.log('实时数据:', data);
};
```
### 市场情绪流
```javascript
const eventSource = new EventSource('http://localhost:8080/sse/market/sentiment');
eventSource.onmessage = function(event) {
const data = JSON.parse(event.data);
console.log('市场情绪:', data);
};
```
## 🛠️ 在CherryStudio中配置步骤
1. **打开CherryStudio**
2. **进入设置/工具配置**
3. **添加自定义工具**
4. **配置基础URL**: `http://localhost:8080`
5. **导入工具配置**或手动添加以下工具：
### 工具配置示例
```json
{
"name": "获取股票实时行情",
"endpoint": "http://localhost:8080/api/stock/realtime",
"method": "GET",
"parameters": {
"symbol": {
"type": "string",
"description": "股票代码，如000001",
"required": true
}
}
}
```
## 📝 使用示例
### 在CherryStudio中的对话示例：
**用户**: "帮我查看平安银行(000001)的实时行情"
**系统调用**: `GET http://localhost:8080/api/stock/realtime?symbol=000001`
**返回结果**:
```json
{
"股票代码": "000001",
"股票名称": "平安银行",
"最新价": 12.34,
"涨跌幅": 2.15,
"成交量": 1234567,
"更新时间": "2025-01-06 17:30:00"
}
```
**用户**: "分析一下技术指标"
**系统调用**: `GET http://localhost:8080/api/stock/indicators?symbol=000001&indicators=ma,macd,rsi`
## 🔧 高级功能
### 1. 缓存机制
- 自动缓存5分钟，减少API调用
- 提高响应速度
### 2. 错误处理
- 完善的错误信息返回
- 网络异常自动重试
### 3. 数据验证
- 参数格式验证
- 数据完整性检查
## 🚨 注意事项
1. **服务器状态**: 确保 `python sse_server.py` 正在运行
2. **网络连接**: 需要稳定的网络访问AKShare API
3. **端口占用**: 默认使用8080端口，如有冲突可修改
4. **数据来源**: 基于AKShare API，请遵守使用条款
## 🔍 故障排除
### 服务器无法启动
```bash
# 检查端口占用
lsof -i :8080
# 更换端口启动
python sse_server.py # 修改代码中的端口号
```
### API调用失败
```bash
# 测试服务器连接
curl http://localhost:8080/
# 测试具体接口
curl "http://localhost:8080/api/stock/realtime?symbol=000001"
```
### CherryStudio连接问题
1. 检查基础URL是否正确
2. 确认服务器正在运行
3. 检查防火墙设置
4. 验证工具配置格式
## 📞 技术支持
如遇问题，请检查：
1. 服务器日志输出
2. 网络连接状态
3. AKShare API可用性
4. CherryStudio配置正确性
---
🎉 **恭喜！您的股票分析SSE工具已经准备就绪，可以在CherryStudio中愉快使用了！**