promptflow.azure 模块#
- class promptflow.azure.PFClient(credential: Optional[TokenCredential] = None, subscription_id: Optional[str] = None, resource_group_name: Optional[str] = None, workspace_name: Optional[str] = None, **kwargs)#
基础类:
object一个用于与Promptflow服务交互的客户端类。
使用此客户端来管理promptflow资源，例如运行。
- Parameters:
credential (TokenCredential) – 用于身份验证的凭证，可选
subscription_id (可选[str]) – Azure 订阅 ID，仅对注册资产可选，可选
resource_group_name (可选[str]) – Azure 资源组，仅对注册表资产可选，可选
workspace_name (可选[str]) – 在客户端中使用的workspace，仅对不依赖于workspace的操作可选， 可选。
kwargs (dict) – 一个包含额外配置参数的字典。
- property flows#
返回可以管理流程的流程操作对象。
- classmethod from_config(credential: TokenCredential, *, path: Optional[Union[str, PathLike]] = None, file_name=None, **kwargs) PFClient#
返回一个连接到Azure机器学习工作区的PFClient对象。
从文件中读取工作区配置。如果找不到配置文件，则抛出异常。
该方法提供了一种简单的方式，在多个Python笔记本或项目中重复使用相同的工作区。 用户可以使用[workspace.write_config](https://aka.ms/ml-workspace-class)方法保存工作区的Azure资源管理器（ARM）属性， 并使用此方法在不同的Python笔记本或项目中加载相同的工作区，而无需重新输入工作区的ARM属性。
- Parameters:
credential (TokenCredential) – 工作空间的凭证对象。
path (Union[os.PathLike, str]) – 配置文件或开始搜索的目录的路径。 该参数默认为从当前目录开始搜索。 可选
file_name (str) – 允许在路径为目录路径时覆盖要搜索的配置文件名。 (默认值 = None)
- get_details(run: Union[str, 运行], max_results: int = 100, all_results: bool = False) DataFrame#
获取运行的详细信息，包括输入和输出。
注意
如果all_results设置为True，max_results将被覆盖为sys.maxsize。
- Parameters:
run (Union[str, Run]) – 运行名称或运行对象
max_results (int) – 返回的最大运行次数，默认为100
all_results (bool) – 是否返回所有结果，默认为 False
- Raises:
RunOperationParameterError – 如果 max_results 不是一个正整数。
- Returns:
详细数据框。
- Return type:
pandas.DataFrame
- get_metrics(run: Union[str, 运行]) dict#
将运行指标打印到控制台。
- Parameters:
run (Union[str, Run]) – 运行对象或运行的名称。
- Returns:
运行的指标
- Return type:
字典
- property ml_client#
返回一个客户端以与Azure ML服务进行交互。
- run(flow: Optional[Union[str, PathLike]] = None, *, data: Optional[Union[str, PathLike]] = None, run: Optional[Union[str, 运行]] = None, column_mapping: Optional[dict] = None, variant: Optional[str] = None, connections: Optional[dict] = None, environment_variables: Optional[dict] = None, name: Optional[str] = None, display_name: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resume_from: Optional[Union[str, 运行]] = None, code: Optional[Union[str, PathLike]] = None, init: Optional[dict] = None, **kwargs) 运行#
对提供的数据或运行执行流程。
注意
至少需要提供数据或运行中的一个。
数据可以是本地文件或远程路径。 - 示例： - data = “path/to/local/file” - data = “azureml:data_name:data_version” - data = “azureml://datastores/datastore_name/path/to/file” - data = “https://example.com/data.jsonl”
列映射是从流程输入名称到指定值的映射。 如果指定，流程将使用提供的值执行指定的输入。 该值可以是：
- 来自数据:
data.col1
- 来自运行：
run.inputs.col1: 如果需要引用运行的输入run.output.col1: 如果需要引用运行的输出
- 示例：
{"ground_truth": "${data.answer}", "prediction": "${run.outputs.answer}"}
- Parameters:
flow (Union[str, PathLike]) – 运行评估的流程目录路径
data (Union[str, PathLike]) – 指向用于评估运行的测试数据（变体批量运行）的指针
run (Union[str, Run]) – 流程运行ID或流程运行，保持当前运行和变体运行之间的沿袭关系， 在inputs_mapping中，批量输出可以引用为${run.outputs.col_name}
column_mapping (dict) – 定义数据流逻辑以映射输入数据。
variant (str) – 节点和变体名称的格式为${node_name.variant_name}，如果未指定，将使用默认变体。
connections (dict) – 使用提供的值覆盖节点级别的连接。 示例：
{"node1": {"connection": "new_connection", "deployment_name": "gpt-35-turbo"}}environment_variables (dict) – 通过指定属性路径和值来设置的环境变量。 示例：
{"key1": "${my_connection.api_key}", "key2"="value2"}对连接键的值引用将被解析为实际值， 并且所有指定的环境变量将被设置到os.environ中。name (str) – 运行的名称。
display_name (str) – 运行的显示名称。
tags (Dict[str, str]) – 运行的标签。
resume_from (str) – 从现有运行中创建运行恢复。
code (Union[str, PathLike]) – 要运行的代码目录的路径。
init (dict) – 用于初始化flex flow的参数，仅在flow为可调用类时支持。
- Returns:
流程运行信息。
- Return type:
- property runs#
返回可以管理运行的操作对象。