检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中,上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度:1 最大长度:64 model_type 否 String 模型类型,枚举值:embedding
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs
获取知识库列表 功能介绍 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 知识库名称 最小长度:1
状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如,切换到HTTPS的高版本协议。
创建知识库 功能介绍 创建知识库。 URI POST /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
搜索结构化数据文件 功能介绍 根据文件名搜索目标文件。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/search 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64
列举批量上传FAQ文件 功能介绍 列举批量上传FAQ文件信息。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
查看知识库列表 功能介绍 查看知识库列表,包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos/{repo_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库I