LabelList-查看知识标签列表
更新时间：2026-01-22
查看知识标签列表
| 请求方式 | POST |
|---|---|
| base url | https://keyue.cloud.baidu.com |
| 后缀接口 | open/v1/api/knowledge/label/common/list |
| Authentication | token为API Key |
说明
该接口用于查看知识标签
请求参数
Header参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| Content-Type | string | 是 | 内容类型 | 固定值：application/json |
| AgentId | string | 是 | 机器人id | 进入机器人后可在URL中查看和获取 |
| tenantId | string | 是 | 租户id | 进入机器人后可在URL中查看和获取 |
| token | string | 是 | API KEY | 机器人API KEY。 详细获取方式参考：准备工作 |
| uid | string | 是 | 用户ID | 详细获取方式参考：准备工作 |
| username | string | 是 | 用户名 | 详细获取方式参考：准备工作 |
Param参数
| 名称 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|
| pn | int | 否 | 当前页码 | 默认为1 |
| ps | int | 否 | 每页展示的记录数量 | 默认为10 |
| keyword | string | 否 | 关键字 | 搜索标签时，输入的关键字 |
| orderBy | string | 否 | 排序字段 | 根据什么字段排序，默认为updated。 可选值：created；updated |
| order | string | 否 | 排序方式 | 升降序，默认desc。 可选值：desc；asc |
Body参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| labelValueIds | list | 否 | 知识标签ID | |
| labelIds | list | 否 |
响应参数
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| time | integer | 是 | 时间 | 1717036810964 |
| data | object | 是 | 数据 | 数据对象，详见 data 子数据 |
| code | integer | 是 | 状态码 | 200 |
| msg | string | 是 | 状态信息 | OK |
data 子数据
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| list | list[list] | 是 | 知识标签列表 | 知识标签列表，详见 list 子数据 |
| pn | int | 否 | 当前页码 | 默认值为0 |
| ps | int | 否 | 每页展示的记录数量 | 默认值为0 |
| total | int | 否 | 总数 | 默认值为0 |
| refresh | boolean | 否 | 是否需要刷新 | 默认为false |
list 子数据
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| id | string | 是 | 标签id | |
| name | string | 是 | 标签名称 | |
| nameEn | string | 是 | 英文名称 | |
| tenantId | string | 是 | 租户id | |
| lastEditUserId | string | 是 | 最近编辑用户id | |
| lastEditUserName | string | 是 | 最近编辑用户名称 | |
| created | string | 是 | 创建时间 | |
| updated | string | 是 | 最近一次更新时间 | |
| valueList | list[valueList] | 是 | 标签值列表 | 详见 valueList 子数据 |
valueList 子数据
| 名称 | 类型 | 必填 | 中文名 | 说明 |
|---|---|---|---|---|
| id | string | 是 | 标签值id | |
| name | string | 是 | 标签值名称 | |
| tenantId | string | 是 | 租户id | |
| knowledgeLabelId | string | 是 | 标签id | |
| created | string | 是 | 创建时间 | |
| updated | string | 是 | 最近一次更新时间 |
请求示例
Bash
1 curl -X POST "https://keyue.cloud.baidu.com/open/v1/api/knowledge/label/common/list?pn=1&ps=20&keyword=类别&orderBy=updated&order=desc" \
2 -H "Content-Type: application/json" \
3 -H "Authorization: xxxx" \
4 -d '{
5 "labelValueIds": ["value_id_1", "value_id_2"],
6 "labelIds": ["label_id_1", "label_id_2"]
7 }'响应示例
1{
2 "time": 1731911333429,
3 "data": {
4 "list": [
5 {
6 "id": "74cfcbed-4a8f-4540-a1f9-499d3a51c586",
7 "name": "wddwdwwdwd",
8 "nameEn": "l",
9 "tenantId": "3156952326602753",
10 "lastEditUserId": "cf7d9692703d45d1b5517a30ab3efa53",
11 "lastEditUserName": "pnstest5",
12 "created": "2024-10-22 11:32:37",
13 "updated": "2024-10-22 11:55:17",
14 "valueList": [
15 {
16 "id": "15d997b4-b270-415a-9f46-252d99c472f0",
17 "name": "dwdwdwdwdwdw",
18 "tenantId": "3156952326602753",
19 "knowledgeLabelId": "74cfcbed-4a8f-4540-a1f9-499d3a51c586",
20 "updated": "2024-10-22 11:55:17",
21 "created": "2024-10-22 11:32:37"
22 }
23 ]
24 }
25 ],
26 "ps": 0,
27 "pn": 0,
28 "total": 0,
29 "refresh": false
30 },
31 "code": 200,
32 "msg": "OK"
33}1