流程 YAML 模式

实验性功能

这是一个实验性功能，可能会随时更改。了解更多更多。

源JSON模式可以在Flow.schema.json找到

YAML语法

键	类型	描述
$schema	string	YAML 模式。如果您使用提示流 VS Code 扩展来编写 YAML 文件，在文件顶部包含 $schema 可以使您调用模式和资源补全。
inputs	object	流程输入的字典。键是流程上下文中输入的名称，值是流程输入的定义。
inputs.	object	流程输入定义。有关可配置属性的集合，请参见Flow input。
outputs	object	流程输出的字典。键是流程上下文中输出的名称，值是流程输出的定义。
outputs.	object	组件输出定义。有关可配置属性的集合，请参见Flow output。
nodes	array	设置作为流程中步骤运行的单个节点的字典集合。节点可以使用内置工具或第三方工具。有关更多信息，请参见Nodes。
node_variants	object	包含变体的节点字典。键是节点名称，值包含变体定义和default_variant_id。有关更多信息，请参见Node variants。
environment	object	用于流程的环境。键可以是image或python_requirements_txt，值可以是镜像或Python需求文本文件。
environment_variables	object/string	通过指定属性路径和值来设置的环境变量。示例：{"key1"="${my_connection.api_key}"}。对连接键的值引用将解析为实际值，并且所有指定的环境变量将被设置到os.environ中。
additional_includes	array	附加包含项是一个可以在流程之间共享的文件列表。用户可以指定流程使用的附加文件和文件夹，提示流程将在流程创建期间帮助将它们全部复制到快照中。

流程输入

键	类型	描述	允许的值
type	string	流程输入的类型。	int, double, bool, string, list, object, image
description	string	输入的描述。
default	int, double, bool, string, list, object, image	输入的默认值。
is_chat_input	boolean	输入是否为聊天流程输入。
is_chat_history	boolean	输入是否为聊天流程的聊天历史。

流程输出

键	类型	描述	允许的值
type	string	流程输出的类型。	int, double, bool, string, list, object
description	string	输出的描述。
reference	string	对节点输出的引用，例如 ${.output.}
is_chat_output	boolean	输出是否为聊天流程输出。

节点

节点是一组节点的集合，每个节点是一个包含以下字段的字典。下面，我们仅展示使用内置工具时单个节点的常见字段。

键	类型	描述	允许的值
name	string	节点的名称。
type	string	节点的类型。	内置工具的类型，如Python、Prompt、LLM和第三方工具，如Vector Search等。
inputs	对象	节点输入的字典。键是输入名称，值可以是原始值或对流程输入或节点输出的引用，例如 ${inputs.}, ${.output} 或 ${.output.}
source	对象	节点使用的工具源字典。键包含type、path和tool。类型可以是code、package和package_with_prompt。
provider	string	表示工具的提供者。当type为LLM时使用。	AzureOpenAI 或 OpenAI
connection	string	之前创建的连接名称。当type为LLM时使用。
api	string	提供者的API名称。当type为LLM时使用。
module	string	节点使用的工具的模块名称。当type为LLM时使用。
use_variants	bool	节点是否有变体。

节点变体

节点变体是一个字典，包含具有变体的节点的变体定义，其各自的节点名称作为字典键。 下面，我们探讨单个节点的变体。

键	类型	描述	允许的值
	string	节点的名称。
default_variant_id	string	默认变体ID。
variants	object	此字典包含所有节点变体，变体ID作为键，节点定义字典作为相应的值。在节点定义字典中，标记为‘node’的键应包含类似于Nodes的变体定义，不包括‘name’字段。

示例

流程示例可在GitHub仓库中找到。

• basic

• web-classification

• chat-basic

• chat-with-pdf

• eval-basic