知识库版本操作
功能介绍
参数解释:
知识库版本管理,版本状态和操作表:
重建 | 启用 | 关闭 | 删除 | 激活 | 更新 | |
---|---|---|---|---|---|---|
使用中 | 1 | 1 | ||||
可用 | 1 | 1 | 1 | 1 | 1 | |
关闭 | 1 | 1 | 1 |
版本状态为使用中:支持重建和更新;
版本状态为可以:支持重建、关闭、删除、激活和更新;
版本状态为关闭:支持启用、删除和更新。
取值范围:
不涉及
URI
POST /v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/versions/{version_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方法请参见获取项目ID。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
application_id |
是 |
String |
参数解释: 应用ID,获取方法请参见获取应用ID。 约束限制: 字符串 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线,且必须以字母开头。 默认取值: 不涉及 |
repo_id |
是 |
String |
参数解释: 知识库ID。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性。 约束限制: 不涉及 取值范围: 1~64个字符,只能包含数字、字母、中划线和下划线。 默认取值: 不涉及 |
version_id |
是 |
String |
参数解释: 知识库版本ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理",单击进入具体的知识库后,选择"版本管理"页签,在此界面获取"版本ID"字段的值,表示该知识库版本标识,具有唯一性。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
operation |
是 |
String |
参数解释: 知识库版本操作。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
name |
否 |
String |
参数解释: 版本名称,重建操作时必选。 约束限制: 不涉及 取值范围: 只能包含1到64位英文字母、中文、数字、中划线或者下划线,并且以字母、数字或者中文开头。 默认取值: 不涉及 |
detail |
否 |
String |
参数解释: 知识库描述,允许重建、更新。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
options |
否 |
参数解释: 重建版本选项: source: 重建来源, 取值范围:index(索引)和file(文档), 默认值:file parser: 文档解析规则设置,重建来源为file时生效。 取值范围:inherit(继承)和 latest(最新), 默认值:inherit active: 是否立即激活, 取值范围:布尔值, 默认值: 重建来源为index时默认false,重建来源file为true。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source |
否 |
String |
参数解释: 重建来源。 约束限制: 不涉及 取值范围:
默认取值: file |
parser |
否 |
String |
参数解释: 文档解析规则设置,重建来源为file时生效。 约束限制: 不涉及 取值范围:
默认取值: inherit |
active |
否 |
Boolean |
参数解释: 是否立即激活。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 重建来源为index时默认false,重建来源file为true。 |
embedding_model |
否 |
String |
参数解释: embedding模型名称为版本重建时embedding模型集合中所选,未重建时为知识库中的embedding模型名称。 约束限制: 此参数只有25.7.T1及之后版本支持。 取值范围: embedding模型名称长度不超过32位。 默认取值: 与对应知识库的embedding_model名称一致。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
version_id |
String |
参数解释: 版本ID,如果是重建操作,返回新创新的。 取值范围: 不涉及 |
请求示例
知识库版本操作。
/v1/{project_id}/applications/{application_id}/uni-search/knowledge-repo/{repo_id}/versions//{version_id} { "operation" : "reindex", "name" : "chy_new", "detail" : "", "options" : { "embedding_model" : "embedding-zh-r3", "source" : "index", "active" : true } }
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
修改知识库版本管理信息响应体。 |
错误码
请参见错误码。