检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口
如何调用API 构造请求 认证鉴权 接口获取 返回结果
单击展开箭头，即可查看每个API详情，包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题： 如何调用API
在“发布”页面配置API网关信息。 表1 发布服务 参数 说明 实例 发布为APIG的实例。
响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于获取用户Token接口，返回如图 获取用户Token响应消息头所示的消息头，其中“x-subject-token”就是需要获取的用户Token。
公共参数 状态码 错误码
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线
详细的公共请求消息头字段请参见表 公共请求消息头。 表2 公共请求消息头 参数 是否必选 描述 Content-Type 是 消息体的类型（格式）。推荐用户使用默认值application/json。 X-Auth-Token 否（使用Token认证时必选） 用户Token。
Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。
获取对话历史 功能介绍 根据chat_id获取对话历史，返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
模型管理 新增模型 修改模型配置 列举模型 删除模型
使用KooSearch的API实现搜索文档 您也可以使用调用API的方式实现搜索问答，KooSearch服务提供的API支持发布到不同的环境，发布成功后支持被调用，具体操作如下： 配置API网关。 发布KooSearch API。 调用已发布的KooSearch API。
状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如，切换到
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
“标头键”填写“X-Apig-AppCode”，“标头值”填写MaaS服务中模型服务的“AppCode”，获取方式请参见步骤1：在MaaS部署模型服务。 创建成功后 ，可以在模型管理页面中看到创建的模型服务。 创建知识库。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
