获取标签列表

更新时间：2024-12-26

注意：

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

功能介绍

本接口用于获取标签列表。

在线调试

平台提供了 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.list_labels(
    offset=0, # 偏移量，可选，默认 0
    page_size=10, # 页大小，可选，默认 10
)
print(resp)

返回示例

Python

QfResponse(
    code=200,
    headers={...},
    body={
        "log_id": "q1pbm3kufhhv1t6s",
        "result": {
            "items": [
                {
                    "labelId": 111,
                    "createTime": "2023-11-21 18:45:10",
                    "updateTime": "2023-11-21 18:45:10",
                    "labelName": "asas",
                    "creatorName": "xxx",
                    "type": 2,
                },
                {
                    "labelId": 222,
                    "createTime": "2023-11-06 14:15:35",
                    "updateTime": "2023-11-06 14:15:35",
                    "labelName": "person",
                    "creatorName": "xxx",
                    "type": 2,
                },
            ],
            "total": 2,
        },
        "status": 200,
        "success": True,
    },
)

请求参数

名称	类型	必填	描述
offset	int	否	偏移量，不传默认取0
page_size	int	否	一页大小，不传默认取10

返回参数

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

result说明

名称	类型	描述
items	dict[]	标签数组
total	int	标签数

items说明

名称	类型	描述
labelId	int	标签Id
createTime	string	创建时间
updateTime	string	更新时间
labelName	string	标签名称
creatorName	string	创建者用户名
type	int	标签类型，说明： · 1：内置标签 · 2：用户创建标签

HTTP调用

鉴权说明

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

请求说明

基本信息

请求地址：https://qianfan.baidubce.com/wenxinworkshop/prompt/label/list

请求方式：POST

Header参数

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

Body参数

名称	类型	必填	描述
offset	int	否	偏移量，不传默认取0
pageSize	int	否	一页大小，不传默认取10

响应说明

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