检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
文件抽取配置项 tags Array of strings 文档标签,可以使用标签对文档进行自动分组,用于筛选过滤。 注意事项: 1.建议不区分大小写,例如, Approved and approved 是同一个标签 2.文档可以有一个或多个标签 3.建议格式为:标签名称:标签值 ,
String 错误描述 最小长度:2 最大长度:512 请求示例 /v1/koosearch/repos/0ac621de-3624-454e-adcf-8c5b4cf7317c/files 响应示例 状态码: 201 上传文档接口响应体 { "file_id" : "5c46f7
将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口 Koosearch的搜索与模型问答接口。 对话历史接口 用户对话历史接口。 图片管理接口 图片管理相关接口。
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
error_msg String 错误描述 最小长度:2 最大长度:512 请求示例 /v1/koosearch/repos/files/69692c309a37a00ae746a926a81e5d41 响应示例 无 状态码 状态码 描述 200 下载成功的文件 400 请求体参数错误
单击“API管理”,即可看到支持的所有API列表。 单击展开箭头,即可查看每个API详情,包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
如何调用API 构造请求 认证鉴权 接口获取 返回结果
最大长度:512 请求示例 无 响应示例 状态码: 200 删除成功 { "id" : "1777619994213965826" } 状态码 状态码 描述 200 删除成功 400 请求体参数错误 500 内部异常 错误码 请参见错误码。 父主题: 用户的文档解析规则定义
两类API。 知识管理:该类API主要用于知识库管理,例如上传文档、刷新文档等。 文档解析:该类API主要用于对文档数据进行处理,例如切分文档内容。 将KooSearch API发布到不同环境后,支持在环境中调用API使用KooSearch服务。操作流程如下: 在APIG服务配置API网关:配置API网关。
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
公共参数 状态码 错误码
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图 获取用户Token响应消息头所示的消息头,其中
String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 请求示例 无 响应示例 状态码: 200 用户定义规则列表 { "rules" : [ { "id" : "string", "rule_regexs"
atch/upload file 响应示例 状态码: 200 上传文档接口响应体 { "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4" } 状态码 状态码 描述 200 上传文档接口响应体 400 参数错误 500 内部异常
模型管理 新增模型 修改模型配置 列举模型 删除模型
最大长度:512 请求示例 /v1/{project_id}/applications/{application_id}/uni-search/rule-regex { "regexs" : [ "string", "string" ] } 响应示例 状态码: 200 创建成功
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth.sco
最大长度:512 请求示例 样例 /v1/{project_id}/applications/{application_id}/uni-search/rule-regex/{id} { "regexs" : [ "string", "string" ] } 响应示例 状态码: 200
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口