获取Prompt模板标签列表
更新时间：2024-12-23
功能介绍
本接口用于获取标签列表信息，如标签ID、标签名称、标签类型等。
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。
SDK调用
调用示例
import os
from qianfan import resources
# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = resources.console.utils.call_action(
# 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
"/v2/promptLabels",
# 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
"DescribePromptLabels",
# 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
{
"marker": "",
"maxKeys":3
}
)
print(resp.body)package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
ca := qianfan.NewConsoleAction()
res, err := ca.Call(context.TODO(),
// 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
"/v2/promptLabels",
// 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
"DescribePromptLabels",
// 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
map[string]interface{}{
"marker": "",
"maxKeys":3,
})
if err != nil {
panic(err)
}
fmt.Println(string(res.Body))
}import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;
public class Dome {
public static void main(String args[]){
// 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
ConsoleResponse<Map<String, Object>> response = qianfan.console()
// 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
.route("/v2/promptLabels")
// 调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
.action("DescribePromptLabels")
// 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
.body(CollUtils.mapOf(
"marker", "",
"maxKeys",3
))
.execute();
System.out.println(Json.serialize(response));
}
}import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
async function main() {
//base_api_route:调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求地址的后缀
//action:调用本文API，该参数值为固定值，无需修改；对应HTTP调用文档-请求说明-请求参数-Query参数的Action
//data:对应HTTP调用文档-请求说明-请求参数-Body参数，具体使用请查看Body参数说明，根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/promptLabels', action: 'DescribePromptLabels', data: {
"marker": "",
"maxKeys":3
}
});
console.log(res);
}
main();返回示例
{
'requestId': 'da3e8351-ffca-4d3b-95f8-52b03ec414fb',
'result': {
'pageInfo': {
'marker': '',
'isTruncated': True,
'nextMarker': 'pl-1ecde441b37b2724',
'maxKeys': 1
},
'items': [{
'labelId': 'pl-81cd3783f18ff237',
'labelName': 'tag_xs_1',
'createTime': '2023-06-15 14:32:07',
'updateTime': '2024-01-11 19:23:36',
'type': 'Custom'
}]
}
}{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo":{
"marker":"pl-jseqvd194abe3umb",
"isTruncated":true,
"nextMarker":"pl-sdsfds516ca2f4d02",
"maxKeys": 3
},
"items": [
{
"labelId":"pl-jseqvd194abe3umb",
"createTime": "2023-10-08T11:02:51+08:00",
"updateTime": "2023-10-08T11:02:51+08:00",
"labelName": "sxz2",
"type":"User"
},
{
"labelId":"pl-219b7d3dec2b7fb7",
"createTime": "2023-10-08T11:02:25+08:00",
"updateTime": "2023-10-08T11:02:25+08:00",
"labelName": "sxz1",
"type":"User"
},
{
"labelId": "pl-8ab11516ca2f4d02",
"createTime": "2023-05-29T18:42:44+08:00",
"updateTime": "2023-05-29T18:42:44+08:00",
"labelName": "label2",
"type":"User"
}
],
}
}{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo":{
"marker":"pl-jseqvd194abe3umb",
"isTruncated":true,
"nextMarker":"pl-sdsfds516ca2f4d02",
"maxKeys": 3
},
"items": [
{
"labelId":"pl-jseqvd194abe3umb",
"createTime": "2023-10-08T11:02:51+08:00",
"updateTime": "2023-10-08T11:02:51+08:00",
"labelName": "sxz2",
"type":"User"
},
{
"labelId":"pl-219b7d3dec2b7fb7",
"createTime": "2023-10-08T11:02:25+08:00",
"updateTime": "2023-10-08T11:02:25+08:00",
"labelName": "sxz1",
"type":"User"
},
{
"labelId": "pl-8ab11516ca2f4d02",
"createTime": "2023-05-29T18:42:44+08:00",
"updateTime": "2023-05-29T18:42:44+08:00",
"labelName": "label2",
"type":"User"
}
],
}
}{
requestId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
result: {
pageInfo:{
marker:'pl-jseqvd194abe3umb',
isTruncated:true,
nextMarker:'pl-sdsfds516ca2f4d02',
maxKeys: 3
},
items: [
{
labelId:'pl-jseqvd194abe3umb',
createTime: '2023-10-08T11:02:51+08:00'
updateTime: '2023-10-08T11:02:51+08:00'
labelName: 'sxz2',
type:'User'
},
{
labelId:'pl-219b7d3dec2b7fb7',
createTime: '2023-10-08T11:02:25+08:00'
updateTime: '2023-10-08T11:02:25+08:00'
labelName: 'sxz1',
type:'User'
},
{
labelId: 'pl-8ab11516ca2f4d02',
createTime: '2023-05-29T18:42:44+08:00'
updateTime: '2023-05-29T18:42:44+08:00'
labelName: 'label2',
type:'User'
}
],
}
}请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| marker | string | 否 | 标记本次查询的起始位置。首次或首页查询可不传或传空字符串，往后翻页时请传上一次查询响应体中的nextMarker |
| maxKeys | int | 否 | 本次查询包含的最大结果集数量，默认10，建议最大值不超过100 |
| pageReverse | bool | 否 | 是否倒序查询，默认为false |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| code | string | 错误码，错误时返回 |
| message | string | 错误信息，请求失败时返回 |
| result | object | 请求结果，请求成功时返回 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| items | array[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：用户创建 |