Back to Daily Stock Analysis

openclaw Skill 集成指南

docs/openclaw-skill-integration.md

3.15.06.9 KB
Original Source

openclaw Skill 集成指南

本文档说明如何通过 openclaw Skill 调用 daily_stock_analysis 的 REST API,实现在 openclaw 对话中触发股票分析的能力。

概述

  • 集成方式:openclaw Skill 通过 HTTP 调用 daily_stock_analysis(DSA)REST API
  • 适用场景:已部署 DSA API 服务,希望在 openclaw 对话中触发分析(如「帮我分析茅台」「analyze AAPL」)

前置条件

  1. daily_stock_analysis 必须已运行:执行 python main.py --serve-only 或通过 Docker 部署,使 API 长期可用
  2. openclaw 需具备 HTTP 调用能力:如 system.run 执行 curl,或内置 HTTP 工具(如 api-tester 等)
  3. 说明:GitHub Actions 仅做定时任务,不长期暴露 API,需本地或 Docker 运行 DSA

核心 API 参考

接口方法用途
/api/v1/analysis/analyzePOST触发分析(主入口)
/api/v1/analysis/status/{task_id}GET异步任务状态
/api/v1/agent/chatPOSTAgent 策略问股(需 AGENT_MODE=true
/api/healthGET健康检查

触发分析请求体

json
{
  "stock_code": "600519",
  "report_type": "detailed",
  "force_refresh": true,
  "async_mode": false
}
  • stock_code:股票代码(必填)
  • report_typesimple | detailed | brief
  • force_refresh:布尔值,是否强制刷新(忽略缓存)
  • async_mode:布尔值,false 时同步返回,true 时返回 202 + task_id 需轮询

注意force_refreshasync_mode 为布尔类型,非字符串。

响应示例(同步模式)

json
{
  "query_id": "abc123def456",
  "stock_code": "600519",
  "stock_name": "贵州茅台",
  "report": {
    "summary": {
      "analysis_summary": "...",
      "operation_advice": "持有",
      "trend_prediction": "看多",
      "sentiment_score": 75
    },
    "strategy": {
      "ideal_buy": "1850",
      "stop_loss": "1780",
      "take_profit": "1950"
    }
  },
  "created_at": "2026-03-13T10:00:00"
}

重要限制与说明

  • 仅支持股票代码:API 不接受中文名称(如「茅台」),需在 Skill 侧解析或提示用户提供代码(如 600519、AAPL)
  • 同步模式耗时async_mode: false 时,单次分析约 2–5 分钟,需确保 openclaw 或 HTTP 客户端超时足够
  • 异步模式async_mode: true 返回 202 + task_id,需轮询 GET /api/v1/analysis/status/{task_id} 直至 status: completed

股票代码格式

类型格式示例
A股6位数字600519000001300750
北交所8/4/92 开头 6 位920748838163430047
港股hk + 5位数字hk00700hk09988
美股1-5 字母(可选 .X 后缀)AAPLTSLABRK.B
美股指数SPX/DJI/IXIC 等SPXDJINASDAQVIX

配置方式

~/.openclaw/openclaw.json 中配置:

json
{
  "skills": {
    "entries": {
      "daily-stock-analysis": {
        "enabled": true,
        "env": {
          "DSA_BASE_URL": "http://localhost:8000"
        }
      }
    }
  }
}
  • 本地部署:http://localhost:8000http://127.0.0.1:8000
  • 远程部署:替换为实际 URL
  • 建议DSA_BASE_URL 勿以 / 结尾

错误响应格式

状态码error 字段说明
400validation_error参数错误(如缺少 stock_code)
409duplicate_task该股票正在分析中,拒绝重复提交
500internal_error / analysis_failed分析过程发生错误

完整 SKILL.md 示例

将以下内容保存到 ~/.openclaw/skills/daily-stock-analysis/SKILL.md

markdown
---
name: daily-stock-analysis
description: 调用 daily_stock_analysis API 进行股票智能分析。当用户询问「分析茅台」「analyze AAPL」「帮我看看 600519」等时使用。仅支持股票代码,不支持中文名称。
metadata:
  {"openclaw": {"requires": {"env": ["DSA_BASE_URL"]}, "primaryEnv": "DSA_BASE_URL"}}
---

## 触发条件

当用户请求分析某只股票时(如「分析茅台」「analyze AAPL」「帮我看看 600519」),使用本 Skill。

## 工作流程

1. **提取股票代码**:从用户消息中识别股票代码(如 600519、AAPL、hk00700)。若用户仅提供中文名称(如「茅台」),需提示用户提供股票代码,或使用常见映射(茅台→600519)。
2. **调用 API**:向 `{DSA_BASE_URL}/api/v1/analysis/analyze` 发送 POST 请求,请求体:
   ```json
   {"stock_code": "<提取的代码>", "report_type": "detailed", "force_refresh": true, "async_mode": false}
  1. 等待响应:同步模式下分析约需 2–5 分钟,请确保 HTTP 客户端超时足够(建议 ≥300 秒)。
  2. 解析结果:从响应的 report.summary 中提取 operation_advicetrend_predictionanalysis_summary,从 report.strategy 中提取 ideal_buystop_losstake_profit,以简洁格式呈现给用户。
  3. 错误处理
    • 连接失败:提示检查 DSA 是否运行、DSA_BASE_URL 是否正确
    • 400:检查 stock_code 格式
    • 409:该股票正在分析中,可稍后重试或查询任务状态
    • 500:提示查看 DSA 日志排查

股票代码格式

  • A股:6位数字(600519、000001)
  • 港股:hk + 5位数字(hk00700)
  • 美股:1–5 字母(AAPL、TSLA、BRK.B)
  • 美股指数:SPX、DJI、IXIC 等

## Agent 策略问股(可选)

若 daily_stock_analysis 已启用 `AGENT_MODE=true`,可调用 Agent 策略问股接口,支持多轮对话与多种策略(缠论、均线金叉等):

```bash
# 将 {DSA_BASE_URL} 替换为实际配置的 API 地址(如 http://localhost:8000)
curl -X POST {DSA_BASE_URL}/api/v1/agent/chat \
  -H 'Content-Type: application/json' \
  -d '{"message": "用缠论分析 600519", "session_id": "optional-session-id"}'

响应包含 content(分析结论)和 session_id(用于多轮对话)。

故障排查

现象可能原因处理建议
连接失败DSA 未运行、端口错误、防火墙确认 python main.py --serve-only 已启动,检查 DSA_BASE_URL
400 错误stock_code 格式错误或缺失检查代码格式(见上文表格),确保请求体包含 stock_code
500 错误AI 配置、数据源、网络问题查看 DSA 日志,确认 GEMINI_API_KEY 等已配置
Agent 400Agent 模式未启用在 DSA 的 .env 中设置 AGENT_MODE=true
分析超时同步模式等待时间过长增加 HTTP 客户端超时,或改用 async_mode: true 轮询状态

认证说明

默认情况下 DSA API 无需认证。若在 .env 中启用了 ADMIN_AUTH_ENABLED=true,则需在 Skill 调用时携带登录后获得的 Cookie,具体方式取决于 openclaw 的 HTTP 工具能力(当前 API 仅支持 Cookie 认证,不支持 Bearer Token)。