检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口获取 KooSearch服务接口组成： https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式： 账号登录CSS控制台。 左侧导航栏选择：“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”，单击进入已购买的服务。
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。
上传文档接口 功能介绍 上传文件至某个知识库。
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。
删除文档接口 功能介绍 删除指定ID的文件。
如何调用API 构造请求 认证鉴权 接口获取 返回结果
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。
构造请求 本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。
Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。
网络配置 虚拟私有云 指定集群节点使用的虚拟专用网络，实现不同业务的网络隔离。 单击“查看虚拟私有云”跳转到虚拟私有云列表，查看已创建或共享至当前账号下的VPC名称和ID。 如果没有合适的VPC，建议联系CSS服务管理员新建VPC，具体请参见创建虚拟私有云和子网。
{ "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4" } 状态码 状态码 描述 200 上传文档接口响应体 400 参数错误 500 内部异常 错误码 请参见错误码。
{ "file_id" : "60fa0fbf-a809-4e4e-8d26-ec389a497bf4" } 状态码 状态码 描述 200 上传文档接口响应体 400 参数错误 500 内部异常 错误码 请参见错误码。
如果您作为API提供者，您可以将成熟的业务能力（如虚拟机集群、数据、微服务集群等）作为后端服务，在API网关中开放API，并通过线下方式提供给API调用者使用，或者发布到API云商店，实现业务能力变现。
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
网络配置 虚拟私有云 指定集群节点使用的虚拟专用网络，实现不同业务的网络隔离。 单击“查看虚拟私有云”跳转到虚拟私有云列表，查看已创建或共享至当前账号下的VPC名称和ID。 如果没有合适的VPC，建议联系CSS服务管理员新建VPC，具体请参见创建虚拟私有云和子网。
表2 配置信息 参数 描述 虚拟私有云 服务所属的虚拟私有云。 企业项目 服务所属的企业项目。 单击项目名称可以跳转到项目管理页面查看企业项目的基本信息。 子网 服务所属的子网。 集群路由 单击右侧的“修改”，可修改集群路由信息，详情请参见配置Flexus企业搜索服务集群路由。
访问地址 MaaS服务的模型服务的“API接口公网地址”。获取方式请参见步骤1：在MaaS部署模型服务。 模型描述 模型详细信息的描述。 昇腾云模型名称 来源于MaaS服务的模型服务的“调用模型名称”，获取方式请参见步骤1：在MaaS部署模型服务。
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
对于获取用户Token接口，返回如图 获取用户Token响应消息头所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
