检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
删除批量导入FAQ文件 功能介绍 删除指定的FAQ文件。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~
查询对话历史列表 功能介绍 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 URI GET /v1/koosearch/chat-history 表1 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名 最小长度:1 最大长度:64
开启知识库 功能介绍 根据ID开启知识库,知识库开启后为可检索状态。 URI PUT /v1/koosearch/repos/{repo_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID,格式为img-[0-9a-z]{32} 最小长度:1 最大长度:64 请求参数
删除知识库 功能介绍 根据ID删除知识库。 URI DELETE /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
下载失败的条目 功能介绍 下载一个JSON文件,该文件包含给定上传Field的失败条目。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
关闭知识库 功能介绍 根据ID关闭知识库,知识库关闭后为不可检索状态。 URI PUT /v1/koosearch/repos/{repo_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
终端节点 终端节点(Endpoint)即调用API的请求地址,KooSearch局点在贵阳一,终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
获取图片内容 功能介绍 根据ID获取图片内容。 URI GET /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID,格式为img-[0-9a-z]{32} 最小长度:1 最大长度:64
搜索结构化数据文件 功能介绍 根据文件名搜索目标文件。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/search 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
列举批量上传FAQ文件 功能介绍 列举批量上传FAQ文件信息。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
下载批量导入FAQ原文件 功能介绍 下载批量导入FAQ的原始文件。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,
体验KooSearch搜索 当知识库有了数据以后,就可以在KooSearch体验平台支持进行搜索体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSear
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
获取知识库列表 功能介绍 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 知识库名称 最小长度:1
查看知识库列表 功能介绍 查看知识库列表,包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos/{repo_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库I
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1