删除Prompt模板

更新时间：2024-09-23

注意：

为提升开发者使用体验，推荐使用Prompt工程V2版本接口，功能更全面、且接口更规范，详见Prompt工程API列表。
Prompt工程V1版本接口功能不再升级，本文档于2024年8月5日下线；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入Prompt工程V2版本接口。

功能介绍

本接口用于删除Prompt模板，只能删除自制模板。

在线调试

平台提供了 API在线调试平台-示例代码，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用，更多内容请查看API在线调试介绍。

SDK调用

使用说明

调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

调用示例

Python

import os
from qianfan.resources import Prompt

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

resp = Prompt.delete(id="pt-a1xxxx71fe925d")
print(resp)

返回示例

Python

QfResponse(code=200,
           headers={...},
           body={
               'log_id': '3pfx4xrq903j4kt4',
               'result': True,
               'status': 200,
               'success': True
           })

请求参数

名称	类型	必填	描述
id	int 或string	是	Prompt模板ID，通过以下任一方式获取该字段值： · 方式一，通过调用创建Prompt模板接口，返回的字段templateId 或 templatePK获取 · 方式二，通过调用获取Prompt模板列表接口，返回的字段templateId 或 templatePK获取 · 方式三，在控制台-Prompt模板-点击自制模板页面，选择模板，在模板详情查看模板ID，如下图所示：

返回参数

名称	类型	描述
log_id	string	操作记录id
result	bool	返回结果
status	int	状态码
success	bool	是否操作成功，说明： · True：成功 · False：失败

HTTP调用

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求说明

基本信息

请求地址：https://qianfan.baidubce.com/wenxinworkshop/prompt/template/delete

请求方式：POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如`2016-04-06T08:23:49Z`
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body参数

名称	类型	必填	说明
templateId	int 或 string	是	Prompt模板ID，通过以下任一方式获取该字段值： · 方式一，通过调用创建Prompt模板接口，返回的字段templateId 或 templatePK获取 · 方式二，通过调用获取Prompt模板列表接口，返回的字段templateId 或 templatePK获取 · 方式三，在控制台-Prompt模板-点击自制模板页面，选择模板，在模板详情查看模板ID，如下图所示：

响应说明

名称	类型	说明
log_id	string	操作记录id
result	bool	返回结果
status	int	状态码
success	bool	是否操作成功，说明： · true：成功 · false：失败

请求示例

bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/prompt/template/delete' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "templateId":"pt-a1xxxx71fe925d"
}'

响应示例

JSON

{
	"log_id": "pws9pkrncvjesmmn",
	"result": true,
	"status": 200,
	"success": true
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

更多相关错误码，请查看错误码说明。

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder