文档中心

数据智能体

提示词模版

IDA-创建提示词模板

请求说明

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

请求参数

参数	类型	必填	说明
`agentId`	int	是	智能体 ID；调用用户必须是该智能体成员
`name`	string	是	模板名称，最长 255 字符
`description`	string	是	模板描述，不可为空
`scene`	array	是	业务场景列表，如 `["PLANNING","DOCUMENT_COMPOSITION"]`
`isPublic`	int	是	公开状态：`1` 公开，`0` 私有
`data`	string	是	提示词模板正文，不可为空；变量以 `{{varId}}` 引用
`mode`	string/array	是	`knowledge_qa` 或 `deep_research`
`sceneName`	object/string/array	否	场景展示名称，如 `{"cn":["方案策划"]}`
`conversationOptions`	object	否	会话能力配置；内部字段原样保存
`templateVariables`	array	否	模板变量列表，字段约束见“模板变量说明”
`isRecommend`	int	否	是否推荐；设置为 `1` 需要智能体管理员权限

模板变量说明

字段	类型	必填	说明
`id`	int	更新已有变量时是	变量记录 ID；创建新变量时不传
`varId`	string	是	模板正文中 `{{varId}}` 对应的变量标识
`name`	string	是	变量名称，同一请求中不可重复
`description`	string	否	变量说明
`required`	int	否	`1` 必填，`0` 可选
`valueType`	string	否	`string` 或 `file`，默认 `string`
`defaultValue`	object	否	默认值对象，例如 `{"text":"今天"}` 或 `{}`

请求示例

curl -X POST \
  "https://${IDA_DOMAIN}/dataAgent/llm/openApi/v2/promptTemplates" \
  -H "Authorization: Bearer ${JWT_TOKEN}" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "agentId": 279,
  "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": [
    {
      "varId": "e7f79b80-871a-4c39-af89-1e6b06931668",
      "name": "活动策划方案",
      "description": "支持 Word、PDF、Markdown 文件",
      "required": 1,
      "valueType": "file",
      "defaultValue": {}
    }
  ]
  }' \
  --silent | jq

返回参数

字段路径	类型	说明
`code`	string	请求结果码，成功为 `llm/ok`。
`msg`	object	提示信息容器；成功时通常为空对象。
`data`	object	创建成功后的模板详情。

data 字段

字段路径	类型	说明
`data.id`	integer	模板 ID。
`data.agentId`	integer	模板所属 Agent ID。
`data.name`	string	模板名称。
`data.description`	string	模板描述。
`data.scene`	array	模板适用场景列表，例如 `PLANNING`、`DOCUMENT_COMPOSITION`。
`data.isPublic`	integer	是否公开：`1` 公开，`0` 私有/不公开。
`data.owner`	string	模板创建人邮箱前缀。
`data.updatedBy`	string	最近更新人邮箱前缀。
`data.data`	string	模板正文内容；变量以 `{{varId}}` 形式占位。
`data.conversationOptions`	object	发起对话时使用的配置项。
`data.status`	integer	模板状态，`1` 表示正常可用。
`data.mode`	string	模板适用模式，例如 `knowledge_qa`。
`data.isRecommend`	integer	是否推荐：`1` 推荐，`0` 不推荐。
`data.isPinned`	boolean	是否置顶。
`data.isOfficial`	boolean	是否官方模板。
`data.previewImageList`	array	模板预览图 URL 列表；创建时最多支持 1 张。未传预览图时返回空数组。
`data.templateAvailableSkills`	array	模板可用技能列表；创建接口通常返回空数组，除非服务层显式传入。
`data.templateVariables`	array	模板变量列表。
`data.ctime`	string	创建时间，ISO 格式。
`data.mtime`	string	更新时间，ISO 格式。

data.conversationOptions 字段

conversationOptions 在创建时会按请求体原样保存为对象，不会强制补齐不存在的 key。

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

data.templateVariables[] 字段

字段路径	类型	说明
`data.templateVariables[].id`	integer	模板变量记录 ID。
`data.templateVariables[].templateId`	integer	所属模板 ID。
`data.templateVariables[].varId`	string	变量唯一标识；模板正文中通过 `{{varId}}` 引用。
`data.templateVariables[].name`	string	变量名称，例如 `活动策划方案`。
`data.templateVariables[].description`	string	变量说明，例如支持的文件类型说明。
`data.templateVariables[].required`	integer	是否必填：`1` 必填，`0` 非必填。
`data.templateVariables[].valueType`	string	变量值类型，例如 `file`、`string`。
`data.templateVariables[].defaultValue`	object	默认值对象；无默认值时为空对象。
`data.templateVariables[].sortOrder`	integer	变量排序值，数值越小越靠前。
`data.templateVariables[].creator`	string	变量创建人邮箱前缀。
`data.templateVariables[].updatedBy`	string	变量最近更新人邮箱前缀。
`data.templateVariables[].status`	integer	变量状态，`1` 表示正常可用。
`data.templateVariables[].ctime`	string	变量创建时间，ISO 格式。
`data.templateVariables[].mtime`	string	变量更新时间，ISO 格式。

字段补充说明

字段	说明
`data.data`	模板正文为普通字符串；变量占位符中的 ID 应对应 `templateVariables[].varId`。
`data.scene`	入库时以 JSON 字符串保存，返回时解析为数组。
`data.mode`	入库时按位标记保存，返回时转换为模式名称字符串。

返回示例

{
  "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-12T13:57:21",
    "name": "活动策划",
    "owner": "admin",
    "previewImageList": [],
    "scene": [
      "PLANNING",
      "DOCUMENT_COMPOSITION"
    ],
    "status": 1,
    "templateAvailableSkills": [],
    "templateVariables": [
      {
        "creator": "admin",
        "ctime": "2026-08-12T13:57:21",
        "defaultValue": {},
        "description": "支持 Word、PDF、Markdown 文件",
        "id": 549,
        "mtime": "2026-08-12T13:57:21",
        "name": "活动策划方案",
        "required": 1,
        "sortOrder": 0,
        "status": 1,
        "templateId": 186,
        "updatedBy": "admin",
        "valueType": "file",
        "varId": "e7f79b80-871a-4c39-af89-1e6b06931668"
      }
    ],
    "updatedBy": "admin"
  },
  "msg": {}
}

最近更新时间：2026.08.17 14:31:59

这个页面对您有帮助吗？

有用

无用

数据智能体

请求说明 #

请求参数 #

模板变量说明 #

请求示例 #

返回参数 #

data 字段 #

data.conversationOptions 字段 #

data.templateVariables[] 字段 #

字段补充说明 #

返回示例 #

请求说明

请求参数

模板变量说明

请求示例

返回参数

data 字段

data.conversationOptions 字段

data.templateVariables[] 字段

字段补充说明

返回示例