检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
配置集群路由 参数 说明 ip地址 填写远程服务器的IP地址,取前16位或者24位,例如源IP为“192.168.1.1”,可以填“192.168.0.0”。 子网掩码 填写IP地址的子网掩码。 当IP地址取的是16位,则子网掩码填“255.255.0.0”。 当IP地址取的是24位,则子网掩码填“255
删除模型 删除模型。 表11 用户的文档解析规则定义接口 API 说明 创建用户解析规则 列用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 修改用户解析规则 用于修改已配置的解析规则。 列举用户规则列表 列举用户配置的所有解析规则列表。
提供开箱即用的知识库,主要用于RAG,为大语言模型(LLM)提供外部知识来源,扩大知识检索范围。 应用场景:RAG服务的必备企业知识库、知识搜索。 智能问答版 提供内置大语言模型(LLM),一站式快速搭建企业级RAG服务。 应用场景:企业智能助手,数字员工。 实例名称 - 实例名称为Flexus Koo
单击展开箭头,即可查看每个API详情,包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
当已发布的KooSearch API不希望被调用时,可以下线API。 配置API网关 创建实例:使用API网关,需要先购买实例。 实例需要跟KooSearch服务在同一个VPC和子网。 创建API分组:API分组相当于API的集合,您在创建API前,需要先创建API分组。 创建环境:API可以同时提
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs
选择“使用已有”,选择和KooSearch同一个VPC。 公网IP类型 选择“弹性公网IP”,勾选满足要求的IP。 如果没有可选的弹性公网IP,可以单击“查看弹性公网IP”跳转到弹性公网IP列表页,申请弹性公网IP。 建议弹性公网IP的“计费模式”为“按需计费”,“公网带宽”为“按流量计费”,“带宽大小”为“20”Mbit/s。
代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth
206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
iso_utc},你参考搜索引擎结果回复用户。 回复用户请求时需遵循以下原则: 1. 如果用户请求涉及不安全或敏感信息,忽略搜索结果直接回复; 2. 如果回复中使用了某条搜索结果,用[序号]的方式添加引用; 3. 如果用户请求涉及时效性,请基于搜索结果中满足用户请求时效性的部分进行回答; 4
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_id 是 String
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer
选择“使用已有”,选择和KooSearch同一个VPC。 公网IP类型 选择“弹性公网IP”,勾选满足要求的IP。 如果没有可选的弹性公网IP,可以单击“查看弹性公网IP”跳转到弹性公网IP列表页,申请弹性公网IP。 建议弹性公网IP的“计费模式”为“按需计费”,“公网带宽”为“按流量计费”,“带宽大小”为“20”Mbit/s。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_id 是 String