检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 模型调用 应用中心 知识中心
如何调用API 构造请求 认证鉴权 返回结果
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 模型调用 包含文本对话类、文本向量化类模型服务调用接口。 应用中心 包含Agent调用、用户配置(工作流、技能)调用、文件盒子等接口。 知识中心 包含知识库和知识数据集的创建、删除、执行及查询等接口。
新增平台API Key API Key是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。租户开发的Agent在调用平台接口时需要进行平台鉴权认证,可以使用“平台API Key”进行平台的鉴权认证。 背景信息 对于华为或者第三方运营的商业化模型服务,支持通过API接入到
模型调用 文本对话 文本向量化 父主题: API
查询知识库最新执行记录 修改知识库召回状态 创建知识数据集 查询知识数据集详情 删除知识数据集 执行知识数据集 查询知识数据集最新执行记录 父主题: API
应用中心 调用知识检索流 调用流 调用技能 文件盒子上传文件 文件盒子删除文件 调用Agent 父主题: API
模型API接入接口规范 当前模型网关支持文本对话(Chat)、文本向量化(Embeddings)、文本排序(Rerank)三种类型的API接入。模型API接入之前,请确保符合相对应的接口规范,其中Chat接口和Embeddings接口需要符合OpenAI接口规范,Rerank接口需要符合AI引擎标准协议。
附录 状态码 错误码 知识数据集请求参数说明
如何获取Agent发布时要所需的API Key? 填写AI原生应用引擎平台的API Key,生成方式请参见新增平台API Key。仅AI原生应用引擎管理员角色可以创建API Key,请通过管理员获取。 父主题: AI原生应用引擎
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
{ } } API Key认证 API Key全称为应用程序接口密钥,是一种用于验证和授权API请求的代码。它通常是一串字符,用于识别调用API的应用程序和开发者。 获取API Key 以管理员身份登录AI原生应用引擎工作台,参考创建API Key获取。 使用API Key鉴权
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于文本对话接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头。例如,Content-Type=application/json
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。仅AI原生应用引擎管理员角色可以创建API Key,请通过管理员获取。 h-user-id 是 String 用户ID,在session接口返回体中可获取userId。