检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。
将KooSearch API发布到不同环境后，支持在环境中调用API使用KooSearch服务。操作流程如下： 在APIG服务配置API网关：配置API网关。 在CSS服务发布KooSearch API：发布KooSearch API。
如何调用API 构造请求 认证鉴权 接口获取 返回结果
接口获取 KooSearch服务接口组成： https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式： 账号登录CSS控制台。 左侧导航栏选择：“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”，单击进入已购买的服务。
删除文档接口 功能介绍 删除指定ID的文件。
公共参数 状态码 错误码
图片管理 上传图片 获取图片内容
chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id 是 String 对话历史ID 最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。
使用KooSearch的API实现搜索文档 您也可以使用调用API的方式实现搜索问答，KooSearch服务提供的API支持发布到不同的环境，发布成功后支持被调用，具体操作如下： 配置API网关。 发布KooSearch API。 调用已发布的KooSearch API。
构造请求 本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。
模型管理 新增模型 修改模型配置 列举模型 删除模型
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。
KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
结构化数据 上传结构化数据 搜索结构化数据文件
URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000
对于获取用户Token接口，返回如图 获取用户Token响应消息头所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
