获取标签列表
更新时间：2024-11-04
注意： 为提升开发者使用体验，本文内容已合并至对应API文档，请查看API鉴权及调用-Prompt工程-Prompt工程V1-获取标签列表文档；本文档已于2024年6月28日在平台文档中心下线，内容不再更新。
功能介绍
用于获取标签列表。
注意事项
调用本文API，需使用安全认证AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
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)返回示例
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：用户创建标签 |