消息模板
消息模板是预定义的标准化JSON消息结构,你可以将常用的消息内容创建为模板。
消息模板当前主要与工作流中的异常节点配合使用,可以在异常节点中快速引用这些模板,确保多个工作流、多个节点之间的消息输出格式统一且可维护。
前提条件
创建消息模板
- 登录AgentArts智能体开发平台,在左侧导航栏“个人空间”区域,选择目标空间。
- 单击左侧导航栏,单击左上角“消息模板”页签,进入消息模板管理界面。
- 在“消息模板”页面,单击右上角的“新建消息模板”。
- 在“创建消息模板”的弹框中输入消息的详细信息,如图1所示,参数说明请参见表1。
表1 创建消息参数说明 参数名称
参数说明
消息名称
模板的唯一标识名称,用于在节点中识别和选择。
消息分类
模板的用途分类。
- 异常:用于工作流异常节点的标准化错误消息输出,可在异常节点中引用。
- 自定义:预留分类,暂未开放此功能。
可见范围
设置消息模板的可见范围。当前支持以下三种设置。
- 租户内:整个租户内的所有空间和用户均可查看并引用,适用于企业级统一消息规范,如全局错误码场景。
- 当前空间内:仅当前空间的成员可查看并引用,适用于团队级消息模板,如项目组的异常话术场景。
- 仅个人:仅创建者本人可见,适用于开发调试阶段的临时模板场景。
消息体
消息体必须为合法的JSON格式。单击右侧的
可以扩展内容输入框,方便输入更多详细信息。注意:系统提供了校验功能,确保消息的语法正确性。如果消息体存在语法问题,将无法成功创建。
示例1:简单文本消息
{ "msg": "错误的URL、链接失效或网页已被删除", "code": "404" }示例2:结构化错误消息(含错误码)
{ "type": "error", "code": "ERR_MODEL_TIMEOUT", "message": "模型响应超时,请检查网络连接后重试。", "suggestion": "如果问题持续,请尝试切换至其他模型。", "contact": "技术支持:support@example.com" }示例3:多字段卡片消息
{ "type": "card", "title": "服务暂时不可用", "fields": [ {"label": "错误类型", "value": "服务过载"}, {"label": "影响范围", "value": "知识库检索功能"}, {"label": "预计恢复", "value": "10 分钟内"} ], "actions": [ {"label": "重试", "action": "retry"}, {"label": "联系支持", "action": "contact_support"} ] } - 单击“确定”可保存设置的消息信息。创建完成后,您可以在异常节点中使用创建好的消息模板。
在工作流中引用消息模板
消息模板创建后,可以在工作流的异常节点中引用,具体请参见异常。
更多操作
消息模板建完成后,您可以执行如表2的操作。
|
操作 |
说明 |
|---|---|
|
导入 |
支持批量导入功能。
上传文件时,请注意以下限制条件:
|
|
导出 |
在“消息模板”页面,选择需要导出的消息,单击“导出”,导出的消息会以xlsx的格式保存在本地。 |
|
编辑 |
编辑消息模板的内容。在“消息模板”页面,找到需要编辑的消息,单击操作列中的“编辑”,在弹出的“编辑消息模板”对话框中进行内容编辑。 |
|
删除 |
删除消息模板。在“消息模板”页面,勾选需要删除的消息模板,单击“删除”,可以删除消息模板。
|
常见问题
问:修改了消息模板后,已发布的工作流会受影响吗?
答:不会。已发布的工作流版本使用发布时的模板快照。修改仅影响未发布(开发中)的工作流版本在下次执行时的输出。如需更新已发布版本,请重新发布工作流。
