获取Prompt模板标签列表
更新时间:2025-05-16
功能介绍
本接口用于获取标签列表信息,如标签ID、标签名称、标签类型等。
使用说明
本文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/promptLabels",
14 # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
15 "DescribePromptLabels",
16 # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
17 {
18 "marker": "",
19 "maxKeys":3
20 }
21)
22
23print(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/promptLabels",
18 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
19 "DescribePromptLabels",
20 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
21 map[string]interface{}{
22 "marker": "",
23 "maxKeys":3,
24 })
25 if err != nil {
26 panic(err)
27 }
28 fmt.Println(string(res.Body))
29
30}
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/promptLabels")
15 // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action
16 .action("DescribePromptLabels")
17 // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
18 // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
19 // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
20 .body(CollUtils.mapOf(
21 "marker", "",
22 "maxKeys",3
23 ))
24 .execute();
25
26 System.out.println(Json.serialize(response));
27 }
28}
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/promptLabels', action: 'DescribePromptLabels', data: {
12 "marker": "",
13 "maxKeys":3
14 }
15 });
16
17 console.log(res);
18}
19
20main();
返回示例
1{
2 'requestId': 'da3e8351-ffca-4d3b-95f8-52b03ec414fb',
3 'result': {
4 'pageInfo': {
5 'marker': '',
6 'isTruncated': True,
7 'nextMarker': 'pl-1ecde441b37b2724',
8 'maxKeys': 1
9 },
10 'items': [{
11 'labelId': 'pl-81cd3783f18ff237',
12 'labelName': 'tag_xs_1',
13 'createTime': '2023-06-15 14:32:07',
14 'updateTime': '2024-01-11 19:23:36',
15 'type': 'Custom'
16 }]
17 }
18}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "pageInfo":{
5 "marker":"pl-jseqvd194abe3umb",
6 "isTruncated":true,
7 "nextMarker":"pl-sdsfds516ca2f4d02",
8 "maxKeys": 3
9 },
10 "items": [
11 {
12 "labelId":"pl-jseqvd194abe3umb",
13 "createTime": "2023-10-08T11:02:51+08:00",
14 "updateTime": "2023-10-08T11:02:51+08:00",
15 "labelName": "sxz2",
16 "type":"User"
17 },
18 {
19 "labelId":"pl-219b7d3dec2b7fb7",
20 "createTime": "2023-10-08T11:02:25+08:00",
21 "updateTime": "2023-10-08T11:02:25+08:00",
22 "labelName": "sxz1",
23 "type":"User"
24 },
25 {
26 "labelId": "pl-8ab11516ca2f4d02",
27 "createTime": "2023-05-29T18:42:44+08:00",
28 "updateTime": "2023-05-29T18:42:44+08:00",
29 "labelName": "label2",
30 "type":"User"
31 }
32 ],
33 }
34}
1{
2 "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
3 "result": {
4 "pageInfo":{
5 "marker":"pl-jseqvd194abe3umb",
6 "isTruncated":true,
7 "nextMarker":"pl-sdsfds516ca2f4d02",
8 "maxKeys": 3
9 },
10 "items": [
11 {
12 "labelId":"pl-jseqvd194abe3umb",
13 "createTime": "2023-10-08T11:02:51+08:00",
14 "updateTime": "2023-10-08T11:02:51+08:00",
15 "labelName": "sxz2",
16 "type":"User"
17 },
18 {
19 "labelId":"pl-219b7d3dec2b7fb7",
20 "createTime": "2023-10-08T11:02:25+08:00",
21 "updateTime": "2023-10-08T11:02:25+08:00",
22 "labelName": "sxz1",
23 "type":"User"
24 },
25 {
26 "labelId": "pl-8ab11516ca2f4d02",
27 "createTime": "2023-05-29T18:42:44+08:00",
28 "updateTime": "2023-05-29T18:42:44+08:00",
29 "labelName": "label2",
30 "type":"User"
31 }
32 ],
33 }
34}
1{
2 requestId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
3 result: {
4 pageInfo:{
5 marker:'pl-jseqvd194abe3umb',
6 isTruncated:true,
7 nextMarker:'pl-sdsfds516ca2f4d02',
8 maxKeys: 3
9 },
10 items: [
11 {
12 labelId:'pl-jseqvd194abe3umb',
13 createTime: '2023-10-08T11:02:51+08:00'
14 updateTime: '2023-10-08T11:02:51+08:00'
15 labelName: 'sxz2',
16 type:'User'
17 },
18 {
19 labelId:'pl-219b7d3dec2b7fb7',
20 createTime: '2023-10-08T11:02:25+08:00'
21 updateTime: '2023-10-08T11:02:25+08:00'
22 labelName: 'sxz1',
23 type:'User'
24 },
25 {
26 labelId: 'pl-8ab11516ca2f4d02',
27 createTime: '2023-05-29T18:42:44+08:00'
28 updateTime: '2023-05-29T18:42:44+08:00'
29 labelName: 'label2',
30 type:'User'
31 }
32 ],
33 }
34}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 标记本次查询的起始位置。首次或首页查询可不传或传空字符串,往后翻页时请传上一次查询响应体中的nextMarker |
maxKeys | int | 否 | 本次查询包含的最大结果集数量,默认10,建议最大值不超过100 |
pageReverse | bool | 否 | 是否倒序查询,默认为false |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 描述 |
---|---|---|
items | List<object> | 标签数组 |
pageInfo | object | 分页信息 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置标识 |
isTruncated | bool | 后面是否还有数据,说明: · true:表示后面还有数据 · false:表示已经是最后一页 |
nextMarker | string | 下次查询的起始位置标记,示例:"pl-dnqpsnv1sahwj604" |
maxKeys | int | 本次查询的页大小 |
items说明
名称 | 类型 | 描述 |
---|---|---|
labelId | string | 标签ID |
createTime | string | 创建时间 |
updateTime | string | 更新时间 |
labelName | string | 标签名称 |
type | string | 标签类型,说明: · System:系统预置 · Custom:用户创建 |