更新时间:2025-07-22 GMT+08:00
分享

查询知识库下的所有标签

功能介绍

查询知识库下的所有标签。

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/labels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方法请参见获取项目ID

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

application_id

String

参数解释:

应用ID,获取方法请参见获取应用ID

约束限制:

字符串

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。

默认取值:

不涉及

repo_id

String

参数解释:

知识库ID。

获取方式:

账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。

约束限制:

不涉及

取值范围:

1~64个字符,只能包含数字、字母、中划线和下划线。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

page_num

Integer

参数解释:

当前请求的页码,表示从第几页开始获取数据。默认值为1,表示第一页。

约束限制:

不涉及

取值范围:

1~65535

默认取值:

1

page_size

Integer

参数解释:

每页显示的记录数,表示一次请求返回的数据条数。默认值为10,表示一页展示10条数据。

约束限制:

不涉及

取值范围:

1-65535

默认取值:

10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

label_list

Array of LabelInfo objects

参数解释:

标签列表。

取值范围:

不涉及

total

Integer

参数解释:

知识库下的标签总数。

取值范围:

不涉及

表5 LabelInfo

参数

参数类型

描述

id

String

参数解释:

标签id。

取值范围:

不涉及

name

String

参数解释:

标签名称。

只能包含1到255位英文字母、中文、数字以及URL特殊字符( : - _ / . ? & = @ # / %+ ~ ! $ ' ( ) , ; [] );并且以字母、数字或者中文开头。 25.2.T1版本在原有基础上增加URL常用特殊字符::/.?&=@#%+~!$'(),;[] 等特殊字符。

取值范围:

不涉及

color

String

参数解释:

标签颜色。

取值范围:

  • red:红色

  • yellow:黄色

  • green:绿色

  • blue:蓝色

  • purple:紫色

  • grey:灰色

create_time

String

参数解释:

创建时间,时间轴。

取值范围:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

-

String

请求示例

响应示例

状态码:200

查询知识库下的所有标签响应成功。

{
  "label_list" : [ {
    "id" : "3296",
    "name" : "test1",
    "color" : "RED",
    "create_time" : "1732797189009"
  }, {
    "id" : "6",
    "name" : "白色",
    "color" : "BLUE",
    "create_time" : "1732871764233"
  }, {
    "id" : "6ad48f65-99dc-406b-9ea6-16e5b30d0240",
    "name" : "星期五",
    "color" : "RED",
    "create_time" : "1732872062619"
  }, {
    "id" : "9",
    "name" : "托尔斯泰",
    "color" : "RED",
    "create_time" : "1732797203779"
  }, {
    "id" : "9d404d4a-3e6e-4e6e-a32b-a40fc4b944df",
    "name" : "目录1",
    "color" : "RED",
    "create_time" : "1732965317477"
  }, {
    "id" : "cc801dc3-2842-4d55-ae0b-1ceeae46f016",
    "name" : "黑色",
    "color" : "BLUE",
    "create_time" : "1732872043823"
  }, {
    "id" : "ff0f33d6-98fa-4008-a90b-1050a0e0af38",
    "name" : "梦入星河",
    "color" : "PURPLE",
    "create_time" : "1733226466014"
  } ],
  "total" : 7
}

状态码

状态码

描述

200

查询知识库下的所有标签响应成功。

500

内部异常。

错误码

请参见错误码

相关文档