检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 欢迎使用Koosearch服务。Koosearch服务为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题: 使用前必读
缓存生成模型服务:选择一个模型服务。 缓存阈值:达到缓存阈值,就会使用缓存输入值必须在0.1到1之间。 缓存策略:达到缓存阈值,如果有多个答案,可以设置最高分或者随机。 过期策略配置:缓存过期的方式,有3中选择。 Least Recently Used:根据当前时间与最后一次访问时间的差值超过存活时间时删除。
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
如果用户请求涉及时效性,请基于搜索结果中满足用户请求时效性的部分进行回答; 4. 如果搜索引擎结果无法完整回答问题,可以补充内部知识或进行推理; 5. 基于已有知识都无法帮助回答时可以拒绝回答。 搜索引擎结果为: <#list docs as doc> [${doc?counter}]网页标题:${doc
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
doc:文档知识,使用query2doc模型 faq:FAQ,常见问答集,使用query2query模型 web:网络来源,来自于web搜索引擎 缺省值:doc 最小长度:1 最大长度:16 枚举值: doc faq web 响应参数 状态码: 200 表3 响应Body参数 参数
y和doc的相关性更加准确,可用于对向量召回结果的重新排序。 GuassDB向量数据库 基于Elasticsearch的华为云自研向量检索引擎。 访问方式 公有云提供了Web化的服务管理平台,即管理控制台和基于HTTPS请求的API(Application programming
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
answer_select_policy 是 String 缓存命中选择策略 FIRST:选择第一个命中 RANDOM:随机选择 枚举值: FIRST RANDOM eviction 是 Eviction object 缓存过期策略 model_name 是 String query2query模型名称
answer_select_policy 是 String 缓存命中选择策略 FIRST:选择第一个命中 RANDOM:随机选择 枚举值: FIRST RANDOM eviction 是 Eviction object 缓存过期策略 model_name 是 String query2query模型名称
answer_select_policy String 缓存命中选择策略 FIRST:选择第一个命中 RANDOM:随机选择 枚举值: FIRST RANDOM eviction Eviction object 缓存过期策略 model_name String query2query模型名称
answer_select_policy String 缓存命中选择策略 FIRST:选择第一个命中 RANDOM:随机选择 枚举值: FIRST RANDOM eviction Eviction object 缓存过期策略 model_name String query2query模型名称
开放API,并通过线下方式提供给API调用者使用,或者发布到API云商店,实现业务能力变现。 发布环境 选择一个发布策略,通过策略的方式,为API提供灵活的控制策略和扩展能力。 分组 选择一个分组,API分组相当于API的集合,API提供者以API分组为单位,管理分组内的所有API。
安全。 选择当前虚拟私有云下集群需要的子网。支持选择共享VPC下的子网。 安全组 安全组起着虚拟防火墙的作用,为集群提供安全的网络访问控制策略。 选择集群需要的安全组,单击“查看安全组”跳转到安全组列表,可以了解安全组详情。 说明: 为了确保您能够正常访问集群,需要放通安全组9200规则。
安全。 选择当前虚拟私有云下集群需要的子网。支持选择共享VPC下的子网。 安全组 安全组起着虚拟防火墙的作用,为集群提供安全的网络访问控制策略。 选择集群需要的安全组,单击“查看安全组”跳转到安全组列表,可以了解安全组详情。 购买时长 - 支持按月购买,购买周期越长价格越优惠,根
安全。 选择当前虚拟私有云下集群需要的子网。支持选择共享VPC下的子网。 安全组 安全组起着虚拟防火墙的作用,为集群提供安全的网络访问控制策略。 选择集群需要的安全组,单击“查看安全组”跳转到安全组列表,可以了解安全组详情。 购买时长 - 支持按月购买,购买周期越长价格越优惠,根
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。
管理KooSearch知识库 创建好的知识库可以进行查看、关闭、开启、引用、删除等操作。 查看知识库详情 进入KooSearch控制台。 左侧导航栏选择“知识库管理”,进入“知识库管理”页面。 单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情