腾讯云智能体对话接口 (HTTP SSE)

本技能提供腾讯云智能体开发平台的HTTP SSE对话接口调用指导。

接口概览

• 请求地址: https://wss.lke.cloud.tencent.com/v1/qbot/chat/sse
• 请求方式: POST
• 协议: HTTP SSE (Server-Sent Events)

快速开始

1. 获取 AppKey

在腾讯云控制台 > 智能体开发平台 > 应用管理 > 发布管理中获取应用的 AppKey。

2. 基本调用示例

curl --location 'https://wss.lke.cloud.tencent.com/v1/qbot/chat/sse' \
--header 'Content-Type: application/json' \
--data '{
  "session_id": "a29bae68-cb1c-489d-8097-6be78f136acf",
  "bot_app_key": "YourAppKey",
  "visitor_biz_id": "a29bae68-cb1c-489d-8097-6be78f136acf",
  "content": "你好",
  "incremental": true,
  "streaming_throttle": 10
}'

请求参数

file_infos 数据结构

{
  "file_name": "文档.pdf",
  "file_size": "1024000",
  "file_url": "https://cos.url/xxx",
  "file_type": "pdf",
  "doc_id": "doc_xxx"
}

响应事件类型

SSE流会返回以下事件类型：

1. reply - 回复事件

{
  "type": "reply",
  "payload": {
    "content": "回复内容",
    "is_final": false,
    "is_evil": false,
    "is_from_self": false,
    "is_llm_generated": true,
    "record_id": "msg_xxx",
    "session_id": "session_xxx",
    "timestamp": 1701330805,
    "reply_method": 1,
    "knowledge": [...],
    "quote_infos": [...]
  }
}

关键字段:

• is_final: true表示消息输出完毕
• is_evil: true表示命中敏感内容
• reply_method: 回复方式（1=大模型回复, 16=工作流回复, 18=智能体回复等）
• quote_infos: 引用信息，用于标注参考来源

2. token_stat - Token统计事件

{
  "type": "token_stat",
  "payload": {
    "elapsed": 1616,
    "token_count": 323,
    "status_summary": "success",
    "procedures": [
      {
        "name": "knowledge",
        "title": "调用知识库",
        "status": "success",
        "input_count": 308,
        "output_count": 15
      }
    ]
  }
}

3. reference - 参考来源事件

{
  "type": "reference",
  "payload": {
    "record_id": "msg_xxx",
    "references": [
      {
        "id": "ref_xxx",
        "type": 2,
        "name": "文档名称",
        "doc_name": "xxx.docx",
        "url": "https://..."
      }
    ]
  }
}

参考来源类型:

• 1: 问答
• 2: 文档片段
• 4: 联网检索内容

4. thought - 思考事件 (DeepSeek-R1)

{
  "type": "thought",
  "payload": {
    "procedures": [
      {
        "name": "thought",
        "title": "思考",
        "debugging": {
          "content": "思考过程..."
        }
      }
    ]
  }
}

5. error - 错误事件

{
  "type": "error",
  "error": {
    "code": 460004,
    "message": "应用不存在"
  }
}

错误码

进阶用法

使用自定义模型

{
  "model_name": "lke-deepseek-r1",
  "content": "你好"
}

支持的模型:

• hunyuan: 混元高级版
• hunyuan-turbo: 混元Turbo版
• lke-deepseek-r1: DeepSeek-R1
• lke-deepseek-v3: DeepSeek-V3
• lke-deepseek-r1-0528: DeepSeek-R1-0528
• lke-deepseek-v3-0324: DeepSeek-V3-0324

工作流参数传递

{
  "custom_variables": {
    "UserID": "10220022",
    "Data": "{\"Score\":{\"Chinese\":89}}"
  }
}

知识库检索范围设置

{
  "custom_variables": {
    "tag_field": "user1|user2"
  }
}

前端渲染组件

如需前端渲染消息，可使用官方组件:

# Vue 2 或 React
npm install lke-component

# Vue 3
npm install lke-component-vue3

参考资料

• 完整接口文档: references/api_reference.md
• 示例脚本: scripts/