更新提示词模板

用于更新指定 templateId 的提示词模板。调用用户必须是模板所有者或该智能体管理员。

请求说明

项目	内容
请求方式	`PUT`
请求地址	`https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/promptTemplates/{templateId}`
默认鉴权	`Authorization: Bearer ${JWT_TOKEN}`

**更新规则：**除路径参数 templateId 外，其余字段均按需传入；未传字段保持不变。

路径参数

参数	类型	必填	说明
`templateId`	int / string	是	提示词模板 ID

请求参数（Body，`application/json`）

参数	类型	必填	说明
`name`	string	否	模板名称，最长 255 个字符
`description`	string	否	模板描述
`scene`	array	否	业务场景列表
`sceneName`	object / string / array	否	场景展示名称
`isPublic`	int	否	`1` 公开，`0` 私有
`data`	string	否	提示词模板正文
`mode`	string / array	否	模板模式：`knowledge_qa` 或 `deep_research`
`conversationOptions`	object	否	会话能力配置
`templateVariables`	array	否	模板变量列表（全量同步语义，见下方注意事项）
`isRecommend`	int	否	修改推荐状态需要智能体管理员权限

请求示例

标准 Curl 示例：

curl -X PUT \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/promptTemplates/186" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data-raw '{"name":"活动策划","description":"更新后的模板描述","isPublic":1}' \
  --silent | jq

补充示例（包含业务鉴权头与变量更新）：

curl -X PUT \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/promptTemplates/74" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "name": "活动策划",
    "description": "对活动策划方案进行全面评估和优化",
    "scene": ["PLANNING", "DOCUMENT_COMPOSITION"],
    "isPublic": 1,
    "data": "请评估活动策划方案：{{e7f79b80-871a-4c39-af89-1e6b06931668}}",
    "mode": "knowledge_qa",
    "conversationOptions": {
      "enableLarkQA": false,
      "enableWebSearch": true,
      "enableAeolusAssetSearch": false,
      "enableHiveDataSearch": false,
      "enabledMcpServers": [],
      "templateSkills": []
    },
    "templateVariables": [
      {
        "id": 133,
        "varId": "e7f79b80-871a-4c39-af89-1e6b06931668",
        "name": "活动策划方案",
        "description": "支持 Word、PDF、Markdown 文件",
        "required": 1,
        "valueType": "file",
        "defaultValue": {}
      }
    ]
  }' \
  --silent | jq

注意事项（重要）

不要将页面 GET 返回的整条模板对象直接作为更新 Body。

例如 collectedCnt、likeCnt、shareCnt、usedCnt、me、owner、status、ctime、mtime 等为响应或系统字段，应从请求中移除，否则可能导致校验失败或更新异常。

不修改变量时：请完全省略 templateVariables 字段。

省略后数据库中的变量保持不变。

传入 templateVariables 时为“全量同步”语义：
- 携带 id 的变量：按 id 原位更新。
- 未携带 id 的变量：新增。
- 原有但本次未包含的变量：会被停用（不再作为当前模板启用变量）。
templateVariables[*].varId 与 templateVariables[*].name 必填。
templateVariables[*].defaultValue 必须是对象（例如 {}），不可为字符串/数组/null。
同一次请求中，变量名称（templateVariables[*].name）不可重复。

返回参数

字段路径	类型	说明
`code`	string	请求结果码，“llm/ok”表示更新成功。
`msg`	object	提示信息对象；为空表示无额外提示。
`data`	object	更新后的模板详情对象。
`data.id`	integer	模板 ID（来自 URL 路径 `/promptTemplates/186`）。
`data.agentId`	integer	模板所属 Agent ID。
`data.name`	string	模板名称（本次更新入参 `name`）。
`data.description`	string	模板描述（本次更新入参 `description`）。
`data.scene`	array	模板适用场景列表。
`data.isPublic`	integer	是否公开：`1` 公开，`0` 非公开（本次更新入参 `isPublic`）。
`data.owner`	string	模板创建人。
`data.updatedBy`	string	最近更新人，通常为当前调用方对应账号。
`data.data`	string	模板正文内容（本次请求未更新该字段，返回为当前存量值）。
`data.conversationOptions`	object	发起对话时使用的配置项集合。
`data.status`	integer	模板状态：`1` 正常（其他取值以服务端定义为准）。
`data.mode`	string	模板适用模式。
`data.isRecommend`	integer	是否推荐：`0` 不推荐。
`data.isPinned`	boolean	是否置顶。
`data.isOfficial`	boolean	是否官方模板。
`data.previewImageList`	array	模板预览图列表。
`data.templateAvailableSkills`	array	模板可用技能列表。
`data.templateVariables`	array	模板变量列表。
`data.ctime`	string	模板创建时间。
`data.mtime`	string	模板更新时间（本次更新后的时间）。

data.conversationOptions

字段路径	类型	当前值	说明
`data.conversationOptions.enableAeolusAssetSearch`	boolean	`false`	是否启用 Aeolus 资产搜索。
`data.conversationOptions.enableHiveDataSearch`	boolean	`false`	是否启用 Hive 数据搜索。
`data.conversationOptions.enableLarkQA`	boolean	`false`	是否启用飞书问答。
`data.conversationOptions.enableWebSearch`	boolean	`true`	是否启用 Web 搜索。
`data.conversationOptions.enabledMcpServers`	array	`[]`	启用的 MCP Server 列表。
`data.conversationOptions.templateSkills`	array	`[]`	模板绑定技能列表。

返回示例

{
  "JSONIFY_PRETTYPRINT_REGULAR": false,
  "code": "llm/ok",
  "data": {
    "agentId": 279,
    "conversationOptions": {
      "enableAeolusAssetSearch": false,
      "enableHiveDataSearch": false,
      "enableLarkQA": false,
      "enableWebSearch": true,
      "enabledMcpServers": [],
      "templateSkills": []
    },
    "ctime": "2026-08-12T13:57:21",
    "data": "请评估活动策划方案：{{e7f79b80-871a-4c39-af89-1e6b06931668}}",
    "description": "更新后的模板描述",
    "id": 186,
    "isOfficial": false,
    "isPinned": false,
    "isPublic": 1,
    "isRecommend": 0,
    "mode": "knowledge_qa",
    "mtime": "2026-08-12T14:31:57",
    "name": "活动策划",
    "owner": "admin",
    "previewImageList": [],
    "scene": [
      "PLANNING",
      "DOCUMENT_COMPOSITION"
    ],
    "status": 1,
    "templateAvailableSkills": [],
    "templateVariables": [],
    "updatedBy": "admin"
  },
  "msg": {}
}

最近更新时间：2026.08.17 14:12:00

这个页面对您有帮助吗？

有用

无用

数据智能体 DataAgent（私有化）

更新提示词模板 #

请求说明 #

路径参数 #

请求参数（Body，application/json） #

#

请求示例 #

#

注意事项（重要） #

#

返回参数 #

data.conversationOptions #

返回示例 #