pfazure#

实验性功能

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

使用提示流CLI在Azure上管理提示流资源。

命令	描述
pfazure flow	管理流程。
pfazure run	管理运行。

pfazure 流#

管理流程。

命令	描述
pfazure flow create	创建一个流程。
pfazure flow update	更新一个流程。
pfazure flow list	列出工作区中的流程。

pfazure 流创建#

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

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

参数#

--flow

流程目录的本地路径。

--设置

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

display_name: 将在远程创建的流程显示名称。如果未指定，则默认为流程文件夹名称加上时间戳。例如：“–set display_name=”。
type: 流程类型。如果未指定，默认为“standard”。可用的类型有：“standard”、“evaluation”、“chat”。例如：“–set type=”。
description: 流程描述。例如：“--set description=。”
tags: 流程标签。例如：“--set tags.key1=value1 tags.key2=value2。”

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 流更新#

更新流程的元数据，例如 显示名称、描述 和 标签。

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

--设置

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

display_name: 流程显示名称。例如：“--set display_name=”。
description: 流程描述。例如：“--set description=<description>。”
tags: 流程标签。例如：“--set tags.key1=value1 tags.key2=value2。”

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 流程列表#

列出 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

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

--类型

按类型筛选流程。可用的类型有：“standard”（标准）、“evaluation”（评估）、“chat”（聊天）。

--仅存档

仅列出已归档的流程。

--include-archived

列出已归档的流程和活动的流程。

--output -o

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

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行#

管理提示流运行。

命令	描述
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 运行创建#

创建一个运行。

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

包含提示流运行规范的YAML文件的本地路径；可以被其他参数覆盖。有关YAML模式的参考，请参见这里。

--flow

创建运行的流程源。它可能是：

流目录的本地路径。

pfazure run create --flow  --data  --column-mapping 

Azure上的流程名称带有前缀azureml:。流程名称是一个guid，可以通过两种方式找到：
- 在创建流程到Azure后，可以在打印消息中的“name”属性中找到。
- 在Azure门户中打开一个流程，guid在url中。例如：https://ml.azure.com/prompts/flow/{workspace-id}/{flow-name}/xxx
```
pfazure run create --flow azureml: --data  --column-mapping 
```

--数据

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

--列映射

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

--运行

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

--变体

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

--stream -s

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

--环境变量

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

--连接数

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

--resume-from

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

--设置

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

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行列表#

列出工作区中的运行。

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

参数#

--仅存档

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

--include-archived

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

--max-results -r

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

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行显示#

显示运行的详细信息。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行流#

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

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

参数#

--name -n

运行的名称。

--timeout

超时时间（以秒为单位）。如果运行状态保持不变且在一段时间内未产生新日志，且该时间段超过超时值，流操作将中止。默认值为600秒。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行显示详情#

显示运行详情。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行显示指标#

显示运行指标。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行可视化#

可视化一个运行。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行存档#

归档一个运行。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行恢复#

恢复一个运行。

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

参数#

--name -n

运行的名称。

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行更新#

更新运行的元数据，例如 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

运行的名称。

--设置

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

--订阅

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

--resource-group -g

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

--workspace-name -w

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

pfazure 运行下载#

下载运行的元数据，例如 input, output, snapshot 和 artifact。下载完成后，您可以使用 pf run create --source 将此运行注册为本地运行记录，然后您可以使用诸如 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

--覆盖

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

--订阅

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

--resource-group -g

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

--workspace-name -w

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