获取标签列表

更新时间：2025-04-01

接口描述

获取标签列表

权限说明

调用本API，需使用API Key鉴权方式。Authorization的值为Bearer <AppBuilder API Key>。获取API Key流程，请查看授权

接口定义

URL	/v2/tag?Action=DescribeTags
Method	POST
Content-Type	application/json
Authorization	请求签名(此签名为应用工作台密钥)

请求结构

POST /v2/tag?Action=DescribeTags HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
    "keyWords":"test",
    "pageNo":1,
    "pageSize":3
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

字段	类型	是否必须	说明
keyWords	string	否	关键字搜索，模糊匹配key和value
pageNo	int	否	页数，默认1
pageSize	int	否	默认20

响应头域

除公共头域外，无其它特殊头域。

响应参数

字段	类型	必然存在	说明
requestId	string	是	请求ID
pageSize	int	是	每页的数量
pageNo	int	是	第几页
hasMore	bool	是	是否还有后续页
total	int	是	总的数量
data	list[Tag]	是	标签数据

Tag

字段	类型	必然存在	说明
key	string	是	标签key
values	list[String]	是	标签values

请求curl 示例

curl --location 'https://qianfan.baidubce.com/v2/tag?Action=ListTags' \
--header 'Authorization: Bearer authorization string' \
--header 'Content-Type: application/json' \
--data '{}'

正确响应示例

HTTP/1.1 200 OK
{
    "data": [
        {
            "key": "娱乐",
            "values": [
                "电影"
            ]
        },
        {
            "key": "动物",
            "values": [
                "爬行动物",
                "哺乳动物"
            ]
        },
        {
            "key": "建筑",
            "values": [
                "欧式建筑",
                "中式建筑"
            ]
        }
    ],
    "pageSize": 10,
    "pageNo": 1,
    "hasMore": false,
    "total": 3,
    "request_id": "8dde7baa-8ba4-4f83-8b54-52a31d6c4777"
}

错误响应示例

HTTP/1.1 401
{
  "requestId": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
  "code": "PermissionDeniedError",
  "message": "没有权限"
}

删除标签

旧版RAG API