发布并部署应用为API服务
将Agent应用发布为API服务后,可以通过调用OpenAPI的方式使用Agent程序。本文介绍如何将开发完成的Agent应用发布并部署为API服务。
费用说明
智能体发布后通过API接口调用时,会产生tokens消耗。
- 如果需要使用平台预置的MaaS模型即服务的模型,需要先开通模型并设置鉴权。具体操作请参考接入预置的付费模型,计费规则请参考MaaS模型即服务价格。
- 如果使用自定义接入的第三方模型,其收费规则请参考该第三方模型的官方说明。
智能体部署并通过API调用后,除模型tokens消耗外,如果开启了日志记录(LTS)、调用链(APM)、指标(AOM)功能,以及使用了API Key认证(DEW凭据托管),均会产生按需计费费用。建议在部署前了解各项服务的计费规则,合理控制成本。
前提条件
发布Agent应用为API服务
- 登录AgentArts智能体平台。
- 单击左侧导航栏“开发中心 > 智能体管理”,单击左上角“单智能体”页签,进入单智能体应用管理界面。 图1 单智能体应用开发页面
- 应用开发主页面,选择已创建的Agent应用或单击左上角的“创建单智能体”按钮。创建应用时需在弹出的创建应用子窗口中填入应用“名称”、“描述”后单击“确定”进入应用编辑页面。 图2 创建应用
- 在应用编辑页面完成该应用的功能编辑调试,然后单击右上角的“提交版本”按钮。在弹出的发布信息填写提示窗中填写本发布的“版本名称”和“版本描述”信息详细请参考表1。
表1 发布单智能体参数说明 配置项
功能描述
版本名称
必填。 系统根据时间戳自动生成,同时支持用户自定义。支持英文、数字、下划线,长度1~64字符。
版本描述
(可选)在此处输入版本的详细描述,以帮助团队成员和用户了解版本更新的具体内容和改进点。
长度0~1024字符,建议填写本次更新的关键变更点,方便后续版本管理。
部署至实例
默认勾选。
将该版本同步部署为API接口,便于后续接口调用。
图3 填写版本信息
已发布的应用支持在Agent应用编辑页面选择“更新版本”按钮重新发布应用。
- 单击“确定”。
提交版本后,在“单智能体”页面的卡片上,显示“已提交”。
如果勾选“部署至实例”,进入“部署智能体”页面,具体部署操作请参考部署智能体。
- 发布完成后单击“分享”按钮跳转至“渠道管理”页面,可以查看API调用接口信息。
也可通过左侧导航栏中选择,单击目标应用,进入单智能体配置页面,选择上方“渠道管理”页签,进入渠道管理页面。
如果未部署过版本,则API详情为空。图4 调用API
部署智能体
未部署的智能体,不能被通过API接口调用,部署是按版本进行部署。
- 登录AgentArts智能体平台。
- 在左侧导航,选择“开发中心 > 智能体管理 ”。
- 选择“单智能体”页签,单击待部署的单智能体应用卡片。
- 在“单智能体配置”页面右上角,单击
。 - 在“部署智能体”页面,配置部署信息如图5所示,参数配置请参考表2。
表2 部署智能体 参数
说明
智能体名称
为创建单智能体应用自定义的智能体名称,不可修改。
智能体版本
为发布Agent应用为API服务的版本名称。默认为最新的版本名称,可以在下拉框中切换。
运行时名称
运行时的名称,默认以jiuwen-开头的名称。仅第一次部署时支持自定义。
由2~48个字符组成,包含小写字母、数字、中划线,以小写字母开头,以小写字母或数字结尾。
入站身份认证
选择调用此API接口时,使用的认证鉴权方式,如何进行认证鉴权请参考认证鉴权。
- IAM认证:将华为云IAM身份配置为入站身份认证,以验证调用者的身份。适用于华为云内部系统或已接入华为云IAM的系统,集成复杂度低,安全等级高。
- OAuth 2.0认证:将JWT(如OAuth令牌)配置为入站身份认证,以验证传入的令牌签名和范围。适用于已有身份提供商(如Okta、Cognito等)的企业系统,集成复杂度高,安全等级高。
- Discovery URL:身份提供商(例如Okta、Cognito等)提供的Discovery URL,该URL通常可在该提供商的文档中找到。
- JWT授权配置:配置JWT令牌的访问控制规则。
- 允许的受众:指定的受众是否在Agent Identity运行中指定的受众匹配或为其子集。
- 允许的客户端:指定的客户端标识符是否被允许访问Agent Identity。
- 允许的范围:仅当令牌包含此处配置的至少一个必须范围时,才允许访问自定义声明。
- 自定义声明:仅当令牌中的特定声明与预定义字符串值相匹配时,才允许访问。
- API Key认证:将预设的密钥对(键和值)配置为入站身份认证,以验证请求中携带的密钥合法性。适用于内部测试或轻量级集成,集成复杂度低,安全等级中。 注意:
身份认证凭证在凭据管理服务(DEW)托管,托管按需计费,使用DEW产生的费用请参考DEW计费说明。
日志记录
默认开启。
开启日志记录功能后,智能体产生的日志会上报到云日志服务 LTS,便于日志的集中管理和分析。日志管理费用按需收取,具体计费详情请参考LTS计费说明。
日志信息展示在“运营运维 > 观测 > 调用链分析”的详情页的“日志”页签中。
指标
默认开启。
开启调用链功能后,智能体产生的调用链数据会上报到应用性能管理 APM,帮助开发者追踪和分析应用的性能问题。调用链管理费用按需收取,具体计费详情请参考APM计费说明。
调用链信息展示在“运营运维 > 观测 > 调用链分析”的详情页的“链路信息”页签中。
调用链
默认开启。
开启指标功能后,智能体产生的指标数据会上报到应用运维管理 AOM,便于实时监控和分析应用的运行状态。指标管理费用按需收取,具体计费详情请参考AOM计费说明。
指标信息展示在“运营运维 > 观测 > 调用链分析”的详情页的“指标”页签中。
- 单击“确定”。
部署成功后,可以在“部署运行 > 智能体运行时”页面,通过搜索运行时名称查看部署的智能体。
单智能体部署后,支持通过API调用,具体请参考通过API调用单智能体应用。
- (可选)在“发布部署”页面,单击“分享”,进入“渠道管理”页面。在“渠道管理”中单击“查看API”即可查看API调用接口信息。
典型场景
- 系统集成:将智能体能力集成到企业OA系统或客服工作台,通过API实现后台自动处理。
- 批量处理:通过脚本批量调用API,自动化处理大量文本数据。
- 自定义前端:获取API接口后,结合企业自有UI框架构建专属的对话交互界面。
常见问题
发布后API调用返回错误码AgentArts.02001017如何处理?
原因:表示您的智能体API调用次数已达到当前套餐的额度限制。系统检测到您的API调用量已超过套餐包含的调用次数上限。
解决办法:
- 登录AgentArts控制台,检查当前套餐的API调用额度及使用情况。
- 如需继续使用API服务,请升级至更高套餐以获得更大的API调用额度。
- 升级套餐后,API调用功能将恢复正常。
