检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
借助API网关,可以简单、快速、低成本、低风险地实现内部系统集成和业务能力开放。API网关帮助您变现服务能力的同时,降低企业研发投入,让您专注于企业核心业务,提升运营效率。
最新动态(html) 本文介绍了Huawei Cloud EulerOS产品新特性和对应的文档动态,新特性将在各个区域(Region)陆续发布,欢迎体验。
None 操作指导 API网关 APIG 介绍开放API的操作流程 04:34 开放API API网关 APIG 介绍如何创建流控策略 02:11 设置流量控制 API网关 APIG 介绍如何调用API(签名认证) 02:28 调用API(签名认证) API网关 APIG 介绍如何调用
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。
响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图 获取用户Token响应消息头所示的消息头,其中“x-subject-token”就是需要获取的用户Token。
API网关 APIG SCP不直接进行授权,只划定权限边界。将SCP绑定到组织单元或者成员账号时,并没有直接对组织单元或成员账号授予操作权限,而是规定了成员账号或组织单元包含的成员账号的授权范围。
在“发布”页面配置API网关信息。 表1 发布服务 参数 说明 实例 发布为APIG的实例。
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。
单击展开箭头,即可查看每个API详情,包括“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题: 如何调用API
详细的公共请求消息头字段请参见表 公共请求消息头。 表2 公共请求消息头 参数 是否必选 描述 Content-Type 是 消息体的类型(格式)。推荐用户使用默认值application/json。 X-Auth-Token 否(使用Token认证时必选) 用户Token。
API网关 APIG APIG专享版实例配置安全认证类型 APIG专享版实例配置访问日志 APIG专享版实例域名均关联SSL证书 父主题: 系统内置预设策略
如何调用API 构造请求 认证鉴权 接口获取 返回结果
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口
使用KooSearch的API实现搜索文档 您也可以使用调用API的方式实现搜索问答,KooSearch服务提供的API支持发布到不同的环境,发布成功后支持被调用,具体操作如下: 配置API网关。 发布KooSearch API。 调用已发布的KooSearch API。
公共参数 状态码 错误码
配置OCR增强实现文档智能解析 应用场景 Flexus企业搜索服务(后续简称为KooSearch),Koosearch结合OCR服务文档识别能力,通过NET网关打通网络,使Koosearch支持智能文档解析能力,对PDF/Word等格式的文档内容进行版式分析,智能识别文档中的各种版式类型
模型管理 新增模型 修改模型配置 列举模型 删除模型
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
使用前必读 概述 欢迎使用Flexus企业搜索服务。Flexus企业搜索服务基于业界效果突出的搜索模型、云搜索服务的高性能GaussDB向量数据库以及LLM模型组成行业RAG解决方案,导入非结构化或者结构化业务数据,帮助企业客户快速一站式搭建企业智能问答应用。搜索增强大模型,数据来源于搜索
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
搜索与问答 搜索知识库 生成答案
“标头键”填写“X-Apig-AppCode”,“标头值”填写MaaS服务中模型服务的“AppCode”,获取方式请参见步骤1:在MaaS部署模型服务。 创建成功后 ,可以在模型管理页面中看到创建的模型服务。 创建知识库。