pfazure#

实验性功能

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

使用 prompt flow CLI 在 Azure 上管理 prompt flow 资源。

命令

描述

pfazure flow

管理流。

pfazure run

管理运行。

pfazure flow#

管理流。

命令

描述

pfazure flow create

创建流。

pfazure flow update

更新流。

pfazure flow list

列出工作区中的流。

pfazure flow create#

从本地流文件夹在 Azure AI 中创建流。

pfazure flow create [--flow]
                    [--set]
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

参数#

--flow

流目录的本地路径。

--set

通过指定属性路径和要设置的值来更新对象。

  • display_name: 将在远程创建的流显示名称。如果未指定，默认为流文件夹名称 + 时间戳。例如，“--set display_name=<display_name>”。

  • type: 流类型。如果未指定，默认为“standard”。可用类型有：“standard”、“evaluation”、“chat”。例如，“--set type=<type>”。

  • description: 流描述。例如，“--set description=<description>。”

  • tags: 流标签。例如，“--set tags.key1=value1 tags.key2=value2。”

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure flow update#

更新流的元数据，例如 display name、description 和 tags。

pfazure flow update --flow
                    [--set]
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

参数#

--flow

Azure 上的流名称。它是一个 GUID，可以通过两种方式找到

  • 将流创建到 Azure 后，可以在打印消息的“name”属性中找到它。

  • 在 Azure 门户中打开流，GUID 在 URL 中。例如 https://ml.azure.com/prompts/flow/{workspace-id}/{flow-name}/xxx

--set

通过指定属性路径和要设置的值来更新对象。

  • display_name: 流显示名称。例如，“--set display_name=<display_name>”。

  • description: 流描述。例如，“--set description=<description>。”

  • tags: 流标签。例如，“--set tags.key1=value1 tags.key2=value2。”

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure flow list#

列出 Azure AI 上的远程流。

pfazure flow list [--max-results]
                  [--include-others]
                  [--type]
                  [--output]
                  [--archived-only]
                  [--include-archived]
                  [--subscription]
                  [--resource-group]
                  [--workspace-name]
                  [--output]

参数#

--max-results -r

要返回的最大结果数。默认为 50，上限为 100。

--include-others

包括其他所有者创建的流。默认情况下，仅返回当前用户创建的流。

--type

按类型筛选流。可用类型有：“standard”、“evaluation”、“chat”。

--archived-only

仅列出已存档的流。

--include-archived

列出已存档的流和活动的流。

--output -o

输出格式。允许值：json、table。默认值：json。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run#

管理 prompt flow 运行。

命令

描述

pfazure run create

创建运行。

pfazure run list

列出工作区中的运行。

pfazure run show

显示运行的详细信息。

pfazure run stream

将运行日志流式传输到控制台。

pfazure run show-details

显示运行详细信息。

pfazure run show-metrics

显示运行指标。

pfazure run visualize

可视化运行。

pfazure run archive

归档运行。

pfazure run restore

恢复运行。

pfazure run update

更新运行。

pfazure run download

下载运行。

pfazure run create#

创建运行。

pfazure run create [--file]
                   [--flow]
                   [--data]
                   [--column-mapping]
                   [--run]
                   [--variant]
                   [--stream]
                   [--environment-variables]
                   [--connections]
                   [--resume-from] # require promptflow>=1.8.0
                   [--set]
                   [--subscription]
                   [--resource-group]
                   [--workspace-name]

参数#

--file -f

包含 prompt flow 运行规范的 YAML 文件的本地路径；可以被其他参数覆盖。有关 YAML 模式，请参阅此处。

--flow

用于创建运行的流源。它可以是

  • 流目录的本地路径。

    pfazure run create --flow <path-to-flow-directory> --data <path-to-data-file> --column-mapping <key-value-pair>

  • 带有前缀 azureml: 的 Azure 上的流名称。流名称是一个 GUID，可以通过两种方式找到

    • 将流创建到 Azure 后，可以在打印消息的“name”属性中找到它。

    • 在 Azure 门户中打开流，GUID 在 URL 中。例如 https://ml.azure.com/prompts/flow/{workspace-id}/{flow-name}/xxx

    pfazure run create --flow azureml:<flow-name> --data <path-to-data-file> --column-mapping <key-value-pair>

--data

数据文件的本地路径或远程数据。例如 azureml:name:version。

--column-mapping

输入列映射，使用 ${data.xx} 引用数据列，使用 ${run.inputs.xx} 引用引用的运行的数据列，使用 ${run.outputs.xx} 引用运行输出列。

--run

引用的流运行名称。例如，您可以针对现有运行运行评估流。例如，“pfazure run create –flow evaluation_flow_dir –run existing_bulk_run –column-mapping url='${data.url}'”。

--variant

节点和变体名称，格式为 ${node_name.variant_name}。

--stream -s

指示是否将运行日志流式传输到控制台。默认值：False

--environment-variables

通过指定属性路径和值来设置环境变量。示例：--environment-variable key1='${my_connection.api_key}' key2='value2'。引用连接键的值将解析为实际值，并且所有指定的环境变量都将设置到 os.environ 中。

--connections

用提供的值覆盖节点级连接。示例：--connections node1.connection=test_llm_connection node1.deployment_name=gpt-35-turbo

--resume-from

从现有运行恢复创建运行。（需要 promptflow>=1.8.0）示例：--resume-from <run_name>

--set

通过指定属性路径和要设置的值来更新对象。示例：--set property1.property2=<value>。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run list#

列出工作区中的运行。

pfazure run list [--archived-only]
                 [--include-archived]
                 [--max-results]
                 [--subscription]
                 [--resource-group]
                 [--workspace-name]

参数#

--archived-only

仅列出已存档的运行。默认值：False

--include-archived

列出已存档的运行和活动的运行。默认值：False

--max-results -r

要返回的最大结果数。默认值为 50，上限为 100。默认值：50

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run show#

显示运行的详细信息。

pfazure run show --name
                 [--subscription]
                 [--resource-group]
                 [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run stream#

将运行日志流式传输到控制台。

pfazure run stream --name
                   [--timeout]
                   [--subscription]
                   [--resource-group]
                   [--workspace-name]

参数#

--name -n

运行名称。

--timeout

超时时间（秒）。如果运行在一段时间内保持相同状态且没有生成新日志，并且该时间长于超时值，则流操作将中止。默认值为 600 秒

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run show-details#

显示运行详细信息。

pfazure run show-details --name
                         [--subscription]
                         [--resource-group]
                         [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run show-metrics#

显示运行指标。

pfazure run show-metrics --name
                         [--subscription]
                         [--resource-group]
                         [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run visualize#

可视化运行。

pfazure run visualize --name
                      [--subscription]
                      [--resource-group]
                      [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run archive#

归档运行。

pfazure run archive --name
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run restore#

恢复运行。

pfazure run restore --name
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

参数#

--name -n

运行名称。

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run update#

更新运行的元数据，例如 display name、description 和 tags。

pfazure run update --name
                    [--set display_name="<value>" description="<value>" tags.key="<value>"]
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

示例#

设置 display name、description 和 tags

pfazure run update --name <run_name> --set display_name="<value>" description="<value>" tags.key="<value>"

参数#

--name -n

运行名称。

--set

设置运行的元信息，例如 display_name、description 或 tags。示例：–set=.

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。

pfazure run download#

下载运行的元数据，例如 input、output、snapshot 和 artifact。下载完成后，您可以使用 pf run create --source <run-info-local-folder> 将此运行注册为本地运行记录，然后您可以使用 pf run show/visualize 等命令检查运行，就像从本地流创建的运行一样。

pfazure run download --name
                    [--output]
                    [--overwrite]
                    [--subscription]
                    [--resource-group]
                    [--workspace-name]

示例#

将运行数据下载到本地

pfazure run download --name <name> --output <output-folder-path>

参数#

--name -n

运行名称。

--output -o

输出文件夹路径，用于存储下载的运行数据。如果未指定，默认为 ~/.promptflow/.runs

--overwrite

如果输出文件夹已存在，则覆盖现有运行数据。如果未指定，默认为 False

--subscription

订阅 ID，当 az configure 没有默认值时必需。

--resource-group -g

资源组名称，当 az configure 没有默认值时必需。

--workspace-name -w

工作区名称，当 az configure 没有默认值时必需。