Appearance
会话附加模块 API 文档(草稿建议 / 推荐词)
基础前缀:
/external/private/api鉴权:DEFrame-UserId、DEFrame-TenantId、DEFrame-ExtendedInfo文档版本基准:4f46278(2026-08-11) 标注:本文件全部接口基于 Controller / DTO 代码声明生成(无法以真实请求实测),字段结构以代码为准。
统一响应体结构:
json
{
"code": 0,
"message": "success",
"data": {},
"ext": null
}1. 建议会话 Agent 草稿
名称:Agent 草稿建议 作用:根据目标名称(targetName)生成 Agent 的系统提示词草稿与摘要,用于"我的 Agent"创建辅助。
- 请求方式:
POST - 路径:
/external/private/api/conversations/agent-draft-suggestion - 请求体:
json
{
"targetName": "能源负荷预测助手"
}响应体:
json
{
"code": 0,
"message": "success",
"data": {
"systemPrompt": "你是一个专注于能源负荷预测的智能助手……",
"summary": "根据用户意图生成的 Agent 草稿",
"source": "GEN"
},
"ext": null
}2. 获取推荐词列表
名称:推荐词列表 作用:按场景 / Agent / 会话返回推荐提问词(支持随机与数量控制)。
- 请求方式:
POST - 路径:
/external/private/api/recommended-words - 请求体:
json
{
"scene": "ENERGY",
"agentId": "agent-001",
"conversationId": "conv-001",
"keyword": null,
"random": false,
"limit": 10
}响应体:
json
{
"code": 0,
"message": "success",
"data": {
"items": [
{
"recommendWordId": "rw-001",
"scene": "ENERGY",
"agentId": "agent-001",
"agentName": "能源运营专家",
"content": "帮我预测明天的电力负荷",
"description": "负荷预测推荐",
"sortOrder": 1,
"enabled": true,
"metadata": {}
}
]
},
"ext": null
}