检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
单击“API管理”，即可看到支持的所有API列表。 单击展开箭头，即可查看每个API详情，包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题： 如何调用API
7317c/files 响应示例 状态码： 201 上传文档接口响应体 { "file_id" : "5c46f7e31c5c4587ac99ef0da0502470" } 状态码 状态码 描述 201 上传文档接口响应体 400 请求体参数错误 500 内部异常 错误码 请参见错误码。
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。 最小长度：1
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
最大值：65535 缺省值：10 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 响应参数 状态码： 200
将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口 Koosearch的搜索与模型问答接口。 对话历史接口 用户对话历史接口。 图片管理接口 图片管理相关接口。
完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于获取用户Token接口，返回如图 获取用户Token响应消息头所示的消息头，其中
"aa1298dfe8a2cfd3f4392019231137d2", "doc_title" : "中国人民共和国保险法.pdf", "subtitle" : "中国人民共和国保险法\n中华人民共和国保险法 第四章 保险经营规则(1)", "doc_content"
构造请求 本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs
oad file 响应示例 状态码： 200 上传文档接口响应体 { "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4" } 状态码 状态码 描述 200 上传文档接口响应体 400 参数错误 500 内部异常 错误码 请参见错误码。
ata file 响应示例 状态码： 200 上传文档接口响应体 { "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4" } 状态码 状态码 描述 200 上传文档接口响应体 400 参数错误 500 内部异常 错误码 请参见错误码。
某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.sco
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
如何调用API 构造请求 认证鉴权 接口获取 返回结果
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 响应参数 无 请求示例 无
最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 响应参数 无 请求示例 无
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
