删除Prompt模板
更新时间:2025-01-20
功能介绍
本接口用于根据Prompt模版ID删除Prompt模板。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
1import os
2from qianfan import resources
3
4# 通过环境变量初始化认证信息
5# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9
10
11resp = resources.console.utils.call_action(
12 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
13 "/v2/promptTemplates",
14 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
15 "DeletePromptTemplate",
16 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
17 {
18 "templateId": "pt-0cb7a308287469f1"
19 }
20)
21
22print(resp.body)
1package main
2import (
3 "context"
4 "fmt"
5 "os"
6 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
7)
8func main() {
9 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
11 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
12
13 ca := qianfan.NewConsoleAction()
14
15 res, err := ca.Call(context.TODO(),
16 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
17 "/v2/promptTemplates",
18 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
19 "DeletePromptTemplate",
20 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
21 map[string]interface{}{
22 "templateId":"pt-0cb7a308287469f1",
23 })
24 if err != nil {
25 panic(err)
26 }
27 fmt.Println(string(res.Body))
28
29}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.console.ConsoleResponse;
3import com.baidubce.qianfan.util.CollUtils;
4import com.baidubce.qianfan.util.Json;
5import java.util.Map;
6
7public class Dome {
8 public static void main(String args[]){
9 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
10 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
11
12 ConsoleResponse<Map<String, Object>> response = qianfan.console()
13 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
14 .route("/v2/promptTemplates")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DeletePromptTemplate")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "templateId","pt-0cb7a308287469f1"
22 ))
23 .execute();
24
25 System.out.println(Json.serialize(response));
26 }
27}
1import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7async function main() {
8 //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
9 //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
10 //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
11 const res = await consoleAction({base_api_route: '/v2/promptTemplates', action: 'DeletePromptTemplate', data: {
12 "templateId":"pt-0cb7a308287469f1"
13 }
14 });
15
16 console.log(res);
17}
18
19main();
返回示例
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": True
4}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": true
4}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": true
4}
1{
2 requestId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
3 result: true
4}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
templateId | string | 是 | Prompt模板ID,过以下任一方式获取该字段值: · 方式一,通过调用创建Prompt模板接口,返回的字段templateId获取 · 方式二,通过调用获取Prompt模板列表接口,返回的字段templateId获取 · 方式三,在控制台-Prompt模板-点击自制模板页面,选择模板,在模板详情查看模板ID,如下图所示: ![]() |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,仅请求失败时返回 |
result | bool | 请求结果,仅请求成功时返回true |