检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。
如何调用API 构造请求 认证鉴权 接口获取 返回结果
安全认证 选择API认证方式。 “APP认证”：表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。 当选择“APP认证”时，需要配置“APP凭据”。
构造请求 本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。
接口获取 KooSearch服务接口组成： https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式： 账号登录CSS控制台。 左侧导航栏选择：“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”，单击进入已购买的服务。
对于获取用户Token接口，返回如图 获取用户Token响应消息头所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。
公共参数 状态码 错误码
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
模型管理 新增模型 修改模型配置 列举模型 删除模型
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
使用前必读 概述 调用说明 终端节点 基本概念
搜索与问答 搜索知识库 生成答案
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。
结构化数据 上传结构化数据 下载失败的条目 搜索结构化数据文件
图片管理 上传图片 获取图片内容
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题： 使用前必读
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
