删除Prompt模板
更新时间:2024-12-23
接口描述
本接口用于根据Prompt模版ID删除Prompt模板。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/promptTemplates?Action=DeletePromptTemplate HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"templateId":"pt-0cb7a3***469f1"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,本接口该字段值为DeletePromptTemplate |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
templateId | string | 是 | Prompt模板ID,过以下任一方式获取该字段值: · 方式一,通过调用创建Prompt模板接口,返回的字段templateId获取 · 方式二,通过调用获取Prompt模板列表接口,返回的字段templateId获取 · 方式三,在控制台-Prompt模板-点击自制模板页面,选择模板,在模板详情查看模板ID,如下图所示: |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,仅请求失败时返回 |
result | bool | 请求结果,仅请求成功时返回true |
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl -i --location 'https://qianfan.baidubce.com/v2/promptTemplates?Action=DeletePromptTemplate'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a526400xxxx525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"templateId":"pt-0cb7a308287469f1"
}'
响应示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。