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

创建标签

功能介绍

创建知识库的文档标签。

URI

POST /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 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

标签名称。

约束限制:

25.2.T1版本在原有基础上增加URL常用特殊字符::/.?&=@#%+~!$'(),;*[] 等特殊字符。

取值范围:

只能包含1到255位英文字母、中文、数字以及URL特殊字符( : - _ / . ? & = @ # / %+ ~ ! $ ' ( ) , ; *[] );并且以字母、数字或者中文开头。

默认取值:

不涉及

color

String

参数解释:

标签颜色。

约束限制:

不涉及

取值范围:

  • red:红色

  • orange:橙色

  • green:绿色

  • blue:蓝色

  • purple:紫色

  • grey:灰色

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

label_id

String

参数解释:

创建的标签id。

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

取值范围:

不涉及

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及

请求示例

创建知识库的文档标签。

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

{
  "name" : "label1",
  "color" : "red"
}

响应示例

状态码:200

创建知识库的文档标签成功。

{
  "label_id" : "label_1"
}

状态码

状态码

描述

200

创建知识库的文档标签成功。

400

请求体参数错误。

500

内部异常。

错误码

请参见错误码

相关文档