-
响应示例 状态码:400 缺少请求体。 {
"error_code" : "AIAE.00001400",
"error_msg" : "Request body is missing"
} 状态码:500 服务器内部错误或三方服务器内部错误。 {
"error_code" : "AIAE.00001500",
"error_msg" : "Internal Server Error."
}
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 data Object true/false。 error_code String 错误码。 error_msg String 错误信息。 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 错误码。 取值范围: 不涉及。 error_msg String 参数解释: 错误信息。 取值范围: 不涉及。 状态码:500 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释: 错误码。 取值范围: 不涉及。 error_msg String 参数解释: 错误信息。 取值范围: 不涉及。
-
请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3和表4。 表3 AK/SK认证公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型(格式),当前只支持application/json。 是 application/json ts 毫秒时间戳。 是 1707101222000 nonce 请求唯一标识(UUID)。从AK/SK认证中获取。 是 - ak 为AK/SK凭证文件中的AK明文。从AK/SK认证中获取。 是 - sign 签名字符串。从AK/SK认证中获取。 是 - resource-code WiseAgent对外开放接口对应的唯一编码,每个接口唯一。请参考表5。 是 modelmarket.chat 表4 API Key认证公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型(格式),当前只支持application/json。 是 application/json Authorization 认证信息。格式为:Bearer ${API Key} 是 Bearer sk-5db9*********dd58 表5 Resource-code Resource-code 接口 modelrouter.chat 调用文本对话模型服务 modelrouter.embeddings 调用文本向量化模型服务 knowledgeBases.query.embeddata 检索知识库数据
-
请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。如果请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://aiae.appstage.myhuaweicloud.com/v1/chat/completions
{
"model": "platform:chatglm3-6b",
"messages": [
{
"role": "user",
"content": "你好!"
}
],
"stream": false
} 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。
-
请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在调用文本对话接口的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://aiae.appstage.myhuaweicloud.com/v1/chat/completions
-
请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,当前AppStage服务只在“华北-北京四”部署,Endpoint为“aiae.appstage.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如文本对话API的resource-path为“/v1/chat/completions”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如,您需要调用AppStage在“华北-北京四”区域的文本对话接口,则需使用“华北-北京四”区域的Endpoint(aiae.appstage.myhuaweicloud.com),并在文本对话的URI部分找到resource-path(/v1/chat/completions),拼接起来如下所示。 https://aiae.appstage.myhuaweicloud.com/v1/chat/completions 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
-
更多操作 MCP服务创建完成后,可根据需要执行如表2所示的操作。 表2 更多操作 操作 步骤 卸载MCP服务 卸载后,MCP服务会下线,请谨慎操作。 在“我的MCP”页面,将鼠标光标移至MCP卡片上,单击“卸载”。 查看MCP服务概览 在“我的MCP”页面,单击MCP卡片,选择“概览”页签,可以查看MCP的服务描述、服务介绍、能力以及使用说明等信息。 查看工具 在“我的MCP”页面,单击MCP卡片,选择“工具”页签,可以查看MCP支持的工具详情并测试工具运行效果。 查看运行监控 支持对MCP服务的调用次数、成功率及操作日志进行监控,以便实时掌握服务运行状态。 在“我的MCP”页面,单击MCP卡片,选择“运行监控”页签,在运行监控页面直观展示了近30天、近7天、近24小时的调用次数统计总览,并支持查看调用次数、调用成功率及日志信息。 “调用次数”面板默认展示近30天的MCP服务调用次数,以及当前时间跨度内调用次数的最大值和最小值。 单击右上角的时间选择下拉框,可切换查看近30天、近7天或近24小时的调用次数。 “调用成功率”面板默认展示近30天的MCP服务调用成功率,以及当前时间跨度内调用成功率的最大值和最小值。 单击右上角的时间选择下拉框,可切换查看近30天、近7天或近24小时的调用成功率。 “日志”区域可以查看MCP服务在运行过程中自动生成的日志信息,支持按时间或日志名称查询符合条件的日志信息。
-
平台预置的MCP介绍 您可以在AI原生应用引擎的左侧导航栏选择“资产中心”,选择“MCP”页签,查看平台预置的MCP资源,如图1所示。 在各MCP卡片上,可直观查看MCP的评分、阅读量及安装量。 单击卡片,在“MCP详情”页面可以查看MCP的详细信息,包括服务描述、服务介绍、功能、安装信息、配置信息、配置示例及许可证等;在“服务描述”区域单击“我来评分”即可对MCP服务进行评分;在“MCP详情”页面的“热门使用推荐”区域,可查看热门MCP服务。 图1 资产中心MCP
-
Agent编排流程 图1 Agent编排流程 表1 Agent的使用流程详解 序号 流程环节 说明 1 创建Agent 创建专属Agent,并将应用程序及相关组件进行发布,使其能够正常运行。当前支持创建以下几种类型的Agent。 在AI原生应用引擎中创建单Agent(自主规划模式):将准备好的模型服务(必选)、工具、工作流、知识库、MCP等编排成Agent。 在AI原生应用引擎中创建单Agent(工作流模式):用户与工作流进行对话,因此必须添加工作流,不支持添加模型、工具、知识库等配置。 在AI原生应用引擎中创建单Agent(复杂任务规划):内置复杂任务规划和通用任务执行工具,可扩展外部MCP和工具结合任务经验模板,以处理复杂的智能体逻辑。 2 发布Agent 在AI原生应用引擎中发布Agent:Agent支持API接口、Web应用等多形态的发布与集成,发布后用户可进行体验、使用。 3 体验Agent 在AI原生应用引擎中体验Agent:通过对话的形式,对自创建的Agent进行体验调测,以发现并解决Agent接口上的问题和错误。 4 使用Agent 在AI原生应用引擎中使用Agent:Agent支持API调用、Web界面操作或直接在Versatile中引用等使用方式,具体方式取决于Agent发布时所选的发布渠道及Agent类型。
-
了解AI原生应用引擎资产中心 进入AI原生应用引擎,在AI原生应用引擎的左侧导航栏选择“资产中心” ,进入资产中心页面,资产中心页面分为搜索、快速筛选、卡片展示三个区域,如图1所示。 资产中心提供了AI应用、工具、MCP、大模型、数据集及提示语模板各类资产,请参考表1了解各类资产及使用说明。 ①:搜索区域,输入资产名称关键字进行搜索。 ②:快速筛选区域,支持按照行业、适用领域、通用各维度快速筛选资产。 ③:卡片展示区域,以卡片形式展示资产,单击卡片,进入详情页面查看各资产的详情,包括基本信息、基本配置、模型介绍、数据集的数据概况等;另外,卡片上还提供了安装、收藏、体验、去创建等入口,以便对各类资产进行操作。 图1 资产中心 表1 资产介绍 资产 说明 AI应用 AI应用页签下展示系统预置的Agent,AI应用可以体验、收藏,具体操作请参考体验和收藏AI应用(系统预置的Agent)。 工具 工具页签下展示平台预置的第三方工具。请参考对第三方工具设置鉴权设置鉴权,再进行调用。 MCP MCP页签下展示平台预置的MCP资源,例如,百度地图、飞书、MySQL、MongoDB、支付宝MCP、FireCrawl网络抓取服务器等。 请参考创建MCP服务安装部署,部署后即可在Agent开发过程中添加使用,增强Agent工具调用能力。 大模型 大模型页签下展示模型供应商信息。 在模型供应商卡片上,提供“鉴权配置”入口,为模型设置鉴权具体操作请参考对平台接入的第三方模型设置鉴权。 单击模型供应商卡片,可以查看接入模型信息,提供“鉴权配置”入口,为模型设置鉴权具体操作请参考对平台接入的第三方模型设置鉴权,可以对已设置鉴权的接入模型进行调测,具体操作请参考体验模型服务。 数据集 数据集页签下展示平台预置的微调数据集和知识数据集。 微调数据集 可用于模型微调任务,使用前请先参考收藏微调数据集收藏数据集。 知识数据集 仅展示,不支持使用。 提示语模板 提示语模板页签下展示平台预置的提示语模板。支持收藏、测试提示语,并支持基于模板创建新的提示语,请参考管理平台预置的提示语模板。您可以在模型调测时直接选择预置提示语进行使用。
-
用户自主部署的模型服务使用流程介绍 AI原生应用引擎支持将模型资产部署为模型服务,模型来源包括: 将平台预置模型部署为模型服务:平台提供开源模型,由用户在平台自主完成部署。 创建模型并部署为模型服务:用户自研或通过开源社区获取模型文件,在平台上传模型文件并完成部署。 微调模型部署为模型服务:用户在平台上选择自定义的微调模型并完成部署。 模型服务部署完成后,用户可便捷地体验和调用。 图1 用户自主部署模型服务使用流程 表1 用户自主部署的模型服务使用流程详解 序号 流程环节 说明 1 创建模型 支持通过上传模型文件的方式创建模型。 2 部署模型服务 模型需要部署成功后才可正式提供模型服务。部署成功后,可以对模型服务进行模型调测。 3 调测模型服务 调测模型服务是指通过对模型进行实际操作、参数调整及效果观测,以验证其在特定场景下的功能表现、性能指标及适用范围的过程。其核心目的是确保模型在真实业务场景中能够稳定、高效地运行。 4 使用模型服务 模型服务部署后,可在Agent、工作流中调用模型服务或通过API调用模型服务,请参考在AI原生应用引擎中创建单Agent(自主规划模式)、创建工作流以及模型调用。 父主题: 调用用户自主部署的模型服务
-
更多操作 表3 更多操作 操作 步骤 置顶任务 在页面左侧任务列表中,将鼠标移至目标任务,单击,选择“置顶”,可以将任务放置页面顶端,方便查找。 回放任务 在页面左侧任务列表中,将鼠标移至目标任务,单击,选择“回放”,将按时间顺序完整呈现任务执行的全部过程,包括浏览器搜索的网页、文件处理过程以及指令输入等关键交互点。 在任务回放过程中,您也可以直接单击页面底部的“查看结果”,直接查看执行结果。 删除任务 在页面左侧任务列表中,将鼠标移至目标任务,单击,选择“删除”,直接从任务列表中删除任务。
-
开始并执行任务 Versatile空间收到用户任务后,首先通过意图识别机制精准解析用户需求,随后将复杂任务拆解为一系列可执行的子任务,并梳理子任务间的依赖关系与优先级、明确执行顺序,最后生成具体的任务执行计划,任务执行计划罗列了每项子任务及具体内容,如图2所示。 图2 任务执行计划 开始任务。 如果任务执行计划符合需求,请单击“开始任务”,Versatile空间开始逐步执行任务。 如果任务执行计划与您的需求存在偏差,您也可以单击“修改任务”对任务内容进行调整。 10分钟未开启任务,系统会自动确认并开启。 监控任务。 在“工作空间”中可以进行轨迹追踪、查看浏览器的搜索结果以及查看各子任务相关的文件,便于监控任务进展与追溯任务历史。 轨迹追踪:在工作空间的“轨迹追踪”页签中,可以实时监控任务进展并了解执行动态,涵盖任务的搜索过程、文件整理等环节。 图3 轨迹追踪 检索追溯:在工作空间“浏览器”页签中,可以查看任务相关的搜索结果,追溯任务执行过程中访问的网页信息,确保信息来源可查、可靠。 图4 浏览器 查看文件:工作空间的“文件”页签中集中展示与任务相关的所有文件,用户可通过文件快速获取任务的关键数据和执行逻辑等细节。将鼠标移至目标文件,单击可以将文件保存至本地,以便查看、编辑和备份。 调整任务。 当用户发现任务执行结果与预期不一致时,在任务执行过程中单击可以随时暂停任务,在任务输入框中输入提示词,重新引导系统执行。 Versatile空间具备异常处理机制,在执行任务时如果遇到需要无法自行处理的问题时,系统会自动中断任务并提醒用户。如果任务中断后一小时内未收到回复,系统将自动结束该任务。 查看Versatile空间整理归纳的信息。 子任务全部执行完成后,Versatile空间会自动梳理执行过程中生成的各类内容,将相关内容保存到文件夹,包含PDF、网页等格式,您可在工作空间的“文件”页签中在线浏览或单击下载文件。
-
向Versatile空间发送任务 每个账号只能使用15个Versatile空间任务。 进入AI原生应用引擎。 在AI原生应用引擎的左侧导航栏选择“Versatile空间”。 (可选)在任务输入框中选择自创建的单Agent(复杂任务规划)或选择Versatile预置的专家Agent。 图1 选择智能助手 表1 Agent介绍 Agent 说明 单Agent(复杂任务规划) 通过AI原生应用引擎自创建的单Agent(复杂任务规划),发布后可在Versatile中选用。 专家Agent 市场研究分析:智能追踪市场动态,深度分析,精准捕捉商机与风险,提供可执行策略,助力决策。 采购智能助手:智能寻源比价,自动初筛供应商,分析采购数据,推荐最优方案,高效降本。 合同审查助手:智能审阅合同,识别关键条款,比对标准库,定位风险异常,提供高效法务建议。 DeepResearch:智能深度解析文献数据,提供跨学科知识推理与决策支持,助力研究创新突破。 通用助手 通用助手通过用户输入的任务,搜索网络信息,生成文本文件或网页。 如果没有指定自创建的单Agent(如复杂任务规划Agent)或预置的专家Agent,系统默认使用通用助手来处理用户请求。 如果已经选择单Agent(复杂任务规划)或专家Agent,在“配置Agent”下单击,删除已选择的Agent,系统自动默认选择通用助手。 在页面输入框中输入任务提示词,字数上限为5000字。 任务提示词的核心是明确任务内容及目标,向Versatile空间输入任务指令时,语言需自然流畅,避免过于复杂或模糊的表述。任务提示词将直接影响后续任务规划的准确性与有效性。例如,分析利率变动对房地产市场投资的影响机制。 单击,可以上传相关数据、文档链接或历史案例。支持.md、.txt、.json、.csv、.py、.sh、.html、.js、.log、.pptx、.docx、.xlsx、.pdf、.jsx类型的文件,最多上传5个附件,单个文件最大为5MB。 选择与Versatile空间的协作模式。 表2 协作模式 模式 说明 探索模式 将任务完全交给AI,让AI自主动态思考,通过增强学习和实时优化,精准理解需求,高效规划和执行任务,实时监控和反馈,最终实现更快的完成速度和更高的任务质量。 规划模式 AI帮助您规划详细的步骤,待用户确认步骤信息,并分步指导您执行,确保每一步都高效、准确的完成。 单击发送。
-
调用子工作流 调用子工作流是工作流的基础节点之一,仅包含“调用子工作流”一个执行动作。 您可以使用该节点调用或触发另一个工作流(即子工作流)。调用子工作流节点的输入和输出通常以JSON格式传递,因此,一般在调用子工作流节点前添加一个JSON构造器节点,将对象转换为JSON格式字符串,在调用子工作流节点后添加一个JSON解析动作,用于解析调用子工作流的输出,提供给后续节点使用,如图1所示。 相较于“调用子工作流”节点,“调用子流程”节点的运行速度更快,推荐优先使用“调用子流程”节点调用子工作流。 图1 调用子工作流 输入 表1 输入参数说明 参数 是否必填项 说明 子流Id 是 子工作流的ID。 单击“获取工作流ID”,进入“我的工作流”列表,单击工作流ID列的复制工作流ID。 子流输入参数 是 填写子工作流起始节点所定义的请求体,格式为对象。 输出 该执行动作根据用户定义的内容输出指定参数。 节点实例 在工作流中首次调用“调用子工作流”节点需要新增实例,实例是节点的鉴权方式,如果未新增实例,节点就无法调通。 单击“新增实例”,在“创建实例”面板,配置表2参数信息。 表2 创建实例参数说明 参数名称 参数说明 基本信息 实例名称 必填项,自定义实例名称。 描述 选填项,输入实例相关描述信息。 验证信息 API Key 必填项,单击“获取API key”跳转至AI原生应用引擎的“我的凭证”页面,在“平台API Key”页签获取,具体介绍请参见创建API Key。 单击“保存”,创建实例成功。 节点备注 输入节点备注信息,方便后续查阅节点功能。节点备注最大长度限制为1000个字符。 父主题: 工作流基础节点说明