创建标签 - CreateLabel
功能介绍
创建知识库的文档标签。
URI
POST /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/labels
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
| application_id | 是 | String | 参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
| repo_id | 是 | String | 参数解释: 知识库ID。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 标签名称。 约束限制: 25.2.T1版本在原有基础上增加URL常用特殊字符::/.?&=@#%+~!$'(),;*[] 等特殊字符。 取值范围: 只能包含1到255位英文字母、中文、数字以及URL特殊字符( : - _ / . ? & = @ # / %+ ~ ! $ ' ( ) , ; *[] );并且以字母、数字或者中文开头。 默认取值: 不涉及 |
| color | 否 | String | 参数解释: 标签颜色。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| label_id | String | 参数解释: 创建的标签id。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
创建知识库的文档标签。
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/5071b12e-8c5c-4181-a15b-41e6ae3915ea/uni-search/ae63178c-f9d1-46c9-96d2-de045dfc6810/labels
{
"name" : "经济类",
"color" : "RED"
} 响应示例
状态码:200
创建知识库的文档标签成功。
{
"label_id" : "e45c84fd-5a3c-4771-9aae-ebf47354efac"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 创建知识库的文档标签成功。 |
| 400 | 请求体参数错误。 |
| 500 | 内部异常。 |
错误码
请参见错误码。