本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。
概述#
工具以消息和变量的形式返回结果。本页介绍消息接口、变量创建和输出模式定义。
数据结构#
消息返回#
Dify 支持多种消息类型,包括文本、链接、图片、文件 blob 和 JSON,每种类型都通过专用接口返回。
默认情况下,工作流中工具的输出包含三个固定变量:files、text 和 json。以下方法用于填充这些变量。
虽然你可使用 create_image_message 等方法返回图片,但工具也支持自定义输出变量,从而更便于在工作流中引用特定数据。
消息类型#
处理文件 blob 时,请始终在 meta 字典中指定 mime_type,以确保文件得到正确处理。例如:{"mime_type": "image/png"}。
变量#
create_stream_variable_message 目前仅支持字符串数据。复杂数据类型无法通过打字机效果进行流式输出。
自定义输出变量#
要在 Workflow 应用中引用工具的输出变量,需在工具清单中使用 JSON Schema 声明工具可能输出的变量。
定义输出模式#
仅定义输出模式还不够:实现代码仍须使用 create_variable_message() 返回每个变量。否则,工作流将收到该变量的 None 值。
实现示例#
对于复杂的工作流,您可以定义多个输出变量并全部返回。这为工作流设计者使用您的工具时提供了更大的灵活性。
示例#
完整的工具实现#
设计工具时,请同时考虑直接输出(用户看到的内容)和变量输出(其他工作流节点可以使用的内容)。这种分离为工具的使用方式提供了灵活性。