检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
修改知识库配置 功能介绍 修改知识库配置。 包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择
配置Flexus企业搜索服务集群路由 当KooSearch服务需要主动访问公网,或者是需要跨网络访问KooSearch API,则需要配置KooSearch服务的集群路由,连通网络。 操作步骤 进入KooSearch服务详情页面。 登录云搜索服务管理控制台。 在左侧导航栏选择“K
创建和管理KooSearch模型服务(可选) 场景描述 用户可以在模型管理页面配置不同的模型,建好的模型服务可以在体验问答和搜索的时候用来配置,也可以在配置知识库时,选择您建好的模型。 创建模型服务 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企
在公网NAT网关列表页面,单击“购买公网NAT网关”,进入购买公网NAT网关页面。 在购买公网NAT网关页面,配置NAT网关。 关键参数请参见表2配置,其他参数可以保持默认值或基于业务场景参考购买公网NAT网关完成配置。 表2 购买公网NAT网关 参数 说明 计费模型 因为KooSearch是离线服务,建议选择“按需计费”。
String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 请求示例 配置示例 /v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/common-prompt
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1/koosearch/rep
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
建为“我的模型”。操作指导请参见在MaaS中创建模型。 将创建好的模型部署为模型服务,具体操作请参见使用MaaS部署模型服务。 选择使用AppCode认证方式调用部署好的模型服务,具体操作请参见调用MaaS部署的模型服务。 获取并记录模型服务的“调用模型名称”、“API接口公网地
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
设置topk召回数量。 召回结果中topk的文档将被精排模型使用。 topk未配置时,将使用默认值50。 参考文档数量 设置RAG大模型参考的文档数量。 参考文档数量未配置时,将使用默认值3 精排 知识库精排开关默认为开启状态,如果未配置,则为开启状态。 注意: 关闭精排时相关性得分范围为0-20
最大长度:128 vector_config VectorConfig object 向量模型的相关配置 nlp_config NlpConfig object NLP大模型相关配置 表6 IamInfo 参数 参数类型 描述 iam_enabled Boolean 是否启用iam鉴权
问答体验将在所选择的知识库中进行答案搜索。 配置问答 在“体验平台”页面,单击右上角,在配置页面进行问答配置。 表1 问答配置 参数分类 参数 说明 搜索配置 相关性阈值 超过相关度阈值的搜索结果才能在搜索结果页展示,否则被过滤。 问答配置 NLP模型服务 选择NLP模型服务。 引用相关度阈值
控制台方式 其他相关操作,请使用管理控制台方式访问。如果用户已注册公有云,可直接登录管理控制台,在服务列表搜索“云搜索服务”。如果未注册,请单击右上方“注册”,根据界面提示填写用户基本信息,然后单击“同意协议并注册”完成管理控制台用户注册。
请求URL 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP,不同服务在不同区域,Endpoint不同,可以参考终端节点获取。例如IAM服务在“西南-贵阳一”区域的Endpoint为“iam.cn-southwest-2
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
Flexus企业搜索服务终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2.myhuaweicloud.com HTTPS 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服
服务的内网访问知识管理地址。 表2 配置信息 参数 描述 虚拟私有云 服务所属的虚拟私有云。 企业项目 服务所属的企业项目。 单击项目名称可以跳转到项目管理页面查看企业项目的基本信息。 子网 服务所属的子网。 集群路由 单击右侧的“修改”,可修改集群路由信息,详情请参见配置Flexus企业搜索服务集群路由。
模型管理接口 模型管理的相关接口。 用户的文档解析规则定义接口 用户文档解析自定义规则配置接口。 表2 知识库管理接口 API 说明 创建知识库 创建名称为xxx的知识库。 修改知识库配置 修改知识库配置。包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token