检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
模型管理 新增模型 修改模型配置 列举模型 删除模型
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。
图片管理 上传图片 获取图片内容
结构化数据 上传结构化数据 搜索结构化数据文件
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
搜索与问答 搜索知识库 生成答案
删除对话历史 功能介绍 根据指定ID，删除对应的对话历史。 URI DELETE /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id 是 String 对话历史ID
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法
更新FAQ 功能介绍 更新指定ID的FAQ的问题、答案、相似问题。 URI PUT /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
生成答案 功能介绍 将content输入给模型，使用模型能力生成答案。 注意： 当"chat_id"为空时，"chat_create_flag"应为"1"，表示需要开启新的对话；当"chat_id"有值时，"chat_create_flag"可以为"0"，表示不需要开启新的对话。
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
如何调用API 构造请求 认证鉴权 接口获取 返回结果
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
批量删除对话历史 功能介绍 根据对话ID，批量删除对话历史信息。 URI DELETE /v1/koosearch/chat-history/batch 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
