检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
获取对话历史 功能介绍 根据chat_id获取对话历史,返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
上传文档接口 功能介绍 上传文件至某个知识库。 URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“API
Flexus企业搜索服务使用流程 华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案,帮助企业聚焦业务场景和应用开发,场景服务化、技术简单化、低门槛化,满足开发者基于业务场景的二次开发。在RAG(Retrieval-Augmented Generation
搜索知识库 功能介绍 根据query,在指定知识库中搜索得到topN相关的分片文档。 URI POST /v1/koosearch/experience/search 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
批量删除FAQ 功能介绍 选择多个需要删除的FAQ,根据ID批量删除。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID,1~64个字符,只能包含数字、字母、中划线和下划线。 最小长度
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度:1 最大长度:64 model_type 否 String 模型类型
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将
删除Flexus企业搜索服务 当无需使用KooSearch文档问答服务时,可删除服务释放资源。 约束限制 删除服务时,会清理业务数据也会删除依赖集群,请谨慎操作。 删除包年/包月的服务 包年包月计费方式的服务支持退订/释放,退订/释放服务后,服务将会释放资源并清空数据,且无法恢复,
删除批量导入FAQ文件 功能介绍 删除指定的FAQ文件。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,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 请求参数
查看Flexus企业搜索服务详情 在服务的基本信息页面,可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外,还能进行管理服务、API管理和日志管理。 管理服务:KooSearch文档问答服务针对已创建的服务所配置的集群,可前往云搜索服务控制台对集群进行管理
删除知识库 功能介绍 根据ID删除知识库。 URI DELETE /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户
下载失败的条目 功能介绍 下载一个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