检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时
如何调用API 构造请求 认证鉴权 接口获取 返回结果
“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 父主题: 如何调用API
建为“我的模型”。操作指导请参见在MaaS中创建模型。 将创建好的模型部署为模型服务,具体操作请参见使用MaaS部署模型服务。 选择使用AppCode认证方式调用部署好的模型服务,具体操作请参见调用MaaS部署的模型服务。 获取并记录模型服务的“调用模型名称”、“API接口公网地
创建和管理KooSearch模型服务(可选) 场景描述 用户可以在模型管理页面配置不同的模型,建好的模型服务可以在体验问答和搜索的时候用来配置,也可以在配置知识库时,选择您建好的模型。 创建模型服务 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企
选择目标服务,单击服务名称,进入服务详情页。 单击“集群路由”后面的“修改”。 在“修改集群路由”弹窗中,配置路由信息。 表1 配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址,取前16位或者24位,例如源IP为“192.168.1.1”,可以填“192.168.0.0”。
文档解析:该类API主要用于对文档数据进行处理,例如切分文档内容。 将KooSearch API发布到不同环境后,支持在环境中调用API使用KooSearch服务。操作流程如下: 在APIG服务配置API网关:配置API网关。 在CSS服务发布KooSearch API:发布KooSearch API。
Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。
在公网NAT网关列表页面,单击“购买公网NAT网关”,进入购买公网NAT网关页面。 在购买公网NAT网关页面,配置NAT网关。 关键参数请参见表2配置,其他参数可以保持默认值或基于业务场景参考购买公网NAT网关完成配置。 表2 购买公网NAT网关 参数 说明 计费模型 因为KooSearch是离线服务,建议选择“按需计费”。
单击页面右上角的“购买Flexus企业搜索服务”按钮,进入购买页面。 在购买页面,完成“区域”、“版本规格”、“实例名称”、“OCR增强”、“网络配置”、“购买时长”配置,配置参数如下表所示。 表1 购买Flexus企业搜索服务 参数 子参数 说明 区域 - 实例的所在区域。 版本规格 智能搜索版 提
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
Flexus企业搜索服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用。 调用方法请参见如何调用API。 终端节点 终端节点(Endpoint)即调用API的请求地址,Flexus企业搜索服务局点在贵阳一,终端节点见表1。 表1 Flexus企业搜索服务终端节点
修改知识库配置 功能介绍 修改知识库配置。 包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置:自动分段、长度分段(按文本长度分段)、层级分段(按小标题分段,可自定义小标题解析规则) 搜索模型设置:rerank模型配置 NLP模型设置:生成模型选择
引用定位:针对回答结果定位到原文位置。 图文结合:展示原文引用关联图片。 知识库缓存:如果打开知识库缓存按钮,您的搜索效率会相对高效。使用知识库缓存需要选择以下几个参数。 缓存生成模型服务:选择一个模型服务。 缓存阈值:达到缓存阈值,就会使用缓存输入值必须在0.1到1之间。 缓存策略:
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 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
String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512 请求示例 配置示例 /v1/koosearch/repos/919e8b10-b0c4-4bcd-9d5a-8ebb69594514/common-prompt