检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 调用说明 终端节点 基本概念
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
概述 欢迎使用Koosearch服务。Koosearch服务为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题: 使用前必读
账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。
sentational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。关于使用APP认证的方法,具体请参考《开发指南》。 当选择“APP认证”时,需要配置“APP凭据”。 “APP凭据”:使用APP认证的API,需要在API网关中创建一个凭据,以生成凭据ID和密钥对(Key、Secret)。将创建的凭据绑定
下载失败的条目 功能介绍 下载一个JSON文件,该文件包含给定上传Field的失败条目。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
终端节点 终端节点(Endpoint)即调用API的请求地址,KooSearch局点在贵阳一,终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
将本地文件上传至KooSearch知识库。 使用KooSearch服务进行问答和搜索。 体验KooSearch问答。 体验KooSearch搜索。 管理知识库。 使用KooSearch的API实现搜索文档 您也可以使用调用API的方式实现搜索问答,KooSearch服务提供的API支持发布到不同的环境,发布成功后支持被调用,具体操作如下:
在控制台使用KooSearch实现搜索问答 创建和管理KooSearch模型服务(可选) 创建KooSearch知识库 将本地文件上传至KooSearch知识库 体验KooSearch问答 体验KooSearch搜索 管理KooSearch知识库
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中,上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表3 请求Body参数 参数 是否必选 参数类型 描述 regexs 是 Array
搜索精排模型:对搜索的召回结果进行重排序,提升向量检索的效果。 搜索规划模型:提供多轮改写及意图识别功能。 缓存生成模型:提供query之间相似度的计算,用于知识库的缓存功能。 访问地址 模型的内网访问地址及端口。 模型描述 模型详细信息的描述。 昇腾云模型名称 来源于昇腾云服务开通的NLP大模型的模型名称。
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
类-金融:贷款重组的定义是什么?行业知识类-政务:《国务院关于印发新一代人工智能发展规划的通知》的指导思想是什么? 说明: 未选择分类的先使用知识库检索再进行大模型总结,选中的分类直接使用大模型回答。 搜索增强自定义prompt 使用场景:主要用于RAG场景下的模型生成阶段。(R
人工智能发展规划的通知》的指导思想是什么? 说明: 未选择分类的先使用知识库检索再进行大模型总结,选中的分类直接使用大模型回答。 搜索增强自定义prompt 使用场景:主要用于RAG场景下的模型生成阶段。(RAG场景:对话生成任务中,使用检索步骤来增强生成模型的能力。) 组成要素
“删除”:当不再需要此版本时,可以删除版本。 “激活”:可用状态的版本可以激活,激活后此版本的状态变为“使用中”,之前“使用中”的版本状态变为“可用”。 被关闭的版本可进行如下操作: “启用”:被关闭版本如果想再次使用,可以单击此按钮启用,启用后版本状态会变成“可用”。 “删除”:当不再需要此版本时,可以删除版本。
在输入框中输入问题,单击,查看搜索结果。 图1 体验搜索 选中搜索结果,可查看更详细的内容。单击“阅读全文”,可查看文档原文。 当前针对上传的多栏排版docx文档,查看文档原文时存在内容显示错位及显示不全的问题。 父主题: 在控制台使用KooSearch实现搜索问答
X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 需要删除的规则ID 最小长度:1 最大长度:64