检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
选择目标服务,单击服务名称,进入服务详情页。 单击“集群路由”后面的“修改”。 在“修改集群路由”弹窗中,配置路由信息。 表1 配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址,取前16位或者24位,例如源IP为“192.168.1.1”,可以填“192.168.0.0”。
修改知识库配置 功能介绍 修改知识库配置。 包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择
在公网NAT网关列表页面,单击“购买公网NAT网关”,进入购买公网NAT网关页面。 在购买公网NAT网关页面,配置NAT网关。 关键参数请参见表2配置,其他参数可以保持默认值或基于业务场景参考购买公网NAT网关完成配置。 表2 购买公网NAT网关 参数 说明 计费模型 因为KooSearch是离线服务,建议选择“按需计费”。
可以扩展上下文以生成更全面的响应。 部署ID 模型的部署id信息。 认证类型 IAM认证:支持华为iam认证,系统将默认使用css资源租户进行认证。开启使用委托账号后可以通过配置委托名和委托账号的方式使用委托账号的权限进行认证。 自定义认证:支持在调用时添加自定义请求头。 URL
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时
API的请求说明请参见《API参考》。 为API请求添加认证信息。 表2 认证方式 认证方式 API请求参数配置 APP认证 表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。关于使用APP认证的方法,具体请参考《开发指南》。 当选择“APP认证”时,需要配置“APP凭据”。 “APP凭据
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
建为“我的模型”。操作指导请参见在MaaS中创建模型。 将创建好的模型部署为模型服务,具体操作请参见使用MaaS部署模型服务。 选择使用AppCode认证方式调用部署好的模型服务,具体操作请参见调用MaaS部署的模型服务。 获取并记录模型服务的“调用模型名称”、“API接口公网地
如何调用API 构造请求 认证鉴权 接口获取 返回结果
服务的内网访问知识管理地址。 表2 配置信息 参数 描述 虚拟私有云 服务所属的虚拟私有云。 企业项目 服务所属的企业项目。 单击项目名称可以跳转到项目管理页面查看企业项目的基本信息。 子网 服务所属的子网。 集群路由 单击右侧的“修改”,可修改集群路由信息,详情请参见配置Flexus企业搜索服务集群路由。
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /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
获取用户Token响应消息头所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。
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
单击页面右上角的“购买Flexus企业搜索服务”按钮,进入购买页面。 在购买页面,完成“区域”、“版本规格”、“实例名称”、“OCR增强”、“网络配置”、“购买时长”配置,配置参数如下表所示。 表1 购买Flexus企业搜索服务 参数 子参数 说明 区域 - 实例的所在区域。 版本规格 智能搜索版 提
管理Flexus企业搜索服务 查看Flexus企业搜索服务详情 配置Flexus企业搜索服务集群路由 删除Flexus企业搜索服务