promptflow.azure.operations Modul#

class promptflow.azure.operations.FlowOperations(operation_scope: OperationScope, operation_config: OperationConfig, all_operations: OperationsContainer, credential, service_caller: FlowServiceCaller, workspace: Workspace, **kwargs: Dict)#

Bases: WorkspaceTelemetryMixin, _ScopeDependentOperations

FlowOperations, die Flows verwalten können.

Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie eine Instanz von PFClient erstellen und diese Operation ist als Attribut der Instanz verfügbar.

create_or_update(flow: Union[str, Path, Flow], display_name: str = None, type: str = None, **kwargs) → Flow#

Erstellt einen Flow aus lokaler Quelle in der Remote-Umgebung oder aktualisiert die Metadaten eines vorhandenen Flows.

Aktualisieren Sie einen Flow

Um einen bestehenden Flow zu aktualisieren, können Sie nur den Anzeigenamen, die Beschreibung und die Tags des Flows aktualisieren. Der Flow-Name ist eine GUID, die auf zwei Arten gefunden werden kann

  • Nachdem ein Flow für Azure erstellt wurde, kann er in der ausgegebenen Nachricht unter dem Attribut „name“ gefunden werden.

  • Öffnen Sie einen Flow im Azure-Portal. Die GUID befindet sich in der URL. Z. B. https://ml.azure.com/prompts/flow/<workspace-id>/<flow-name>/xxx

Parameter:

  • flow (Union[str, Path, Flow]) – Die Quelle des zu erstellenden oder zu aktualisierenden Flows. Beim Erstellen eines Flows füllen Sie diesen mit dem lokalen Flow-Pfad. Beim Aktualisieren eines Flows füllen Sie diesen mit dem Flow-Objekt mit einem gültigen Flow-Namen (siehe obige Dokumentation zur Suche eines Flow-Namens auf Azure).

  • display_name (str) – Der Anzeigename des zu erstellenden Flows. Standardmäßig der Ordnername des Flows + Zeitstempel, falls nicht angegeben. Z. B. „web-classification-10-27-2023-14-19-10“

  • type (str) – Der Typ des zu erstellenden Flows. Einer von [„standard“, „evaluation“, „chat“]. Standardmäßig „standard“, falls nicht angegeben.

  • description (str) – Die Beschreibung des zu erstellenden Flows. Standardmäßig die Beschreibung in der Flow-YAML-Datei.

  • tags (Dict[str, str]) – Die Tags des zu erstellenden Flows. Standardmäßig die Tags in der Flow-YAML-Datei.

get(name: str) → Flow#

Ruft einen Flow aus Azure ab.

Parameter:

name (str) – Der Name des abzurufenden Flows.

Gibt zurück:

Der Flow.

Rückgabetyp:

Flow

list(max_results: int = 50, flow_type: Optional[FlowType] = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, include_others: bool = False, **kwargs) → List[Flow]#

Listet Flows aus Azure auf.

Parameter:

  • max_results (int) – Die maximale Anzahl der zurückzugebenden Ausführungen, standardmäßig 50, maximal 100

  • flow_type (Optional[FlowType]) – Der Flow-Typ, standardmäßig None, was alle Flow-Typen bedeutet. Andere unterstützte Flow-Typen sind [„standard“, „evaluation“, „chat“].

  • list_view_type (ListViewType) – Der List-Ansichtstyp, standardmäßig ListViewType.ACTIVE_ONLY

  • include_others (bool) – Ob Flows aufgelistet werden sollen, die anderen Benutzern im Remote-Arbeitsbereich gehören, standardmäßig False

Gibt zurück:

Die Liste der Flows.

Rückgabetyp:

List[Flow]

class promptflow.azure.operations.RunOperations(operation_scope: OperationScope, operation_config: OperationConfig, all_operations: OperationsContainer, flow_operations: FlowOperations, trace_operations: TraceOperations, credential, service_caller: FlowServiceCaller, workspace: Workspace, **kwargs: Dict)#

Bases: WorkspaceTelemetryMixin, _ScopeDependentOperations

RunOperations, die Läufe verwalten können.

Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie eine Instanz von PFClient erstellen und diese Operation ist als Attribut der Instanz verfügbar.

archive(run: Union[str, Run]) → Run#

Archiviert einen Run.

Parameter:

run (Union[str, Run]) – Der Laufname oder das Laufobjekt

Gibt zurück:

Das Laufobjekt

Rückgabetyp:

Ausführen

cancel(run: Union[str, Run], **kwargs) → None#

Bricht einen Lauf ab.

Parameter:

run (Union[str, Run]) – Der Laufname oder das Laufobjekt

create_or_update(run: Run, **kwargs) → Run#

Erstellt oder aktualisiert einen Lauf.

Parameter:

run (Run) – Laufobjekt zum Erstellen oder Aktualisieren.

Gibt zurück:

Erstelltes oder aktualisiertes Laufobjekt.

Rückgabetyp:

Ausführen

download(run: Union[str, Run], output: Optional[Union[str, Path]] = None, overwrite: Optional[bool] = False) → str#

Lädt die Daten eines Laufs herunter, einschließlich Eingabe, Ausgabe, Snapshot und anderer Laufinformationen.

Hinweis

Nach Abschluss des Downloads können Sie pf run create --source <run-info-local-folder> verwenden, um diesen Lauf als lokale Laufaufzeichnung zu registrieren. Anschließend können Sie Befehle wie pf run show/visualize verwenden, um den Lauf wie einen aus einem lokalen Flow erstellten Lauf zu inspizieren.

Parameter:

  • run (Union[str, Run]) – Der Laufname oder das Laufobjekt

  • output (Optional[str]) – Das Ausgabeverzeichnis. Standardmäßig im Ordner „~/.promptflow/.runs“.

  • overwrite (Optional[bool]) – Ob der vorhandene Laufordner überschrieben werden soll. Standardmäßig False.

Gibt zurück:

Der Pfad zum Laufverzeichnis

Rückgabetyp:

str

get(run: Union[str, Run], **kwargs) → Run#

Ruft einen Lauf ab.

Parameter:

run (Union[str, Run]) – Der Laufname

Gibt zurück:

Das Laufobjekt

Rückgabetyp:

Ausführen

get_details(run: Union[str, Run], max_results: int = 100, all_results: bool = False, **kwargs) → DataFrame#

Ruft die Details des Laufs ab.

Hinweis

Wenn all_results auf True gesetzt ist, wird max_results auf sys.maxsize überschrieben.

Parameter:

  • run (Union[str, Run]) – Der Laufname oder das Laufobjekt

  • max_results (int) – Die maximale Anzahl der zurückzugebenden Läufe, standardmäßig 100

  • all_results (bool) – Ob alle Ergebnisse zurückgegeben werden sollen, standardmäßig False

Löst aus:

RunOperationParameterError – Wenn max_results keine positive Ganzzahl ist.

Gibt zurück:

Der Details-Datenrahmen.

Rückgabetyp:

pandas.DataFrame

get_metrics(run: Union[str, Run], **kwargs) → dict#

Ruft die Metriken des Laufs ab.

Parameter:

run (Union[str, Run]) – Der Lauf oder das Laufobjekt

Gibt zurück:

Die Metriken

Rückgabetyp:

dict

list(max_results: int = 50, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) → List[Run]#

Listet Läufe im Arbeitsbereich auf.

Parameter:

  • max_results (int) – Die maximale Anzahl der zurückzugebenden Ausführungen, standardmäßig 50, maximal 100

  • list_view_type (ListViewType) – Der List-Ansichtstyp, standardmäßig ListViewType.ACTIVE_ONLY

Gibt zurück:

Die Liste der Läufe.

Rückgabetyp:

List[Run]

restore(run: Union[str, Run]) → Run#

Einen Lauf wiederherstellen.

Parameter:

run (Union[str, Run]) – Der Laufname oder das Laufobjekt

Gibt zurück:

Das Laufobjekt

Rückgabetyp:

Ausführen

stream(run: Union[str, Run], raise_on_error: bool = True, timeout: int = 600, **kwargs) → Run#

Streamt die Protokolle eines Laufs.

Parameter:

  • run (Union[str, Run]) – Der Laufname oder das Laufobjekt

  • timeout (int) – Wenn der Lauf länger als der Timeout-Wert im gleichen Status verbleibt und keine neuen Protokolle erzeugt, wird der Stream-Vorgang abgebrochen. Standard-Timeout-Wert ist 600 Sekunden.

  • raise_on_error (bool) – Löst eine Ausnahme aus, wenn ein Lauf fehlschlägt oder abgebrochen wird.

Gibt zurück:

Das Laufobjekt

Rückgabetyp:

Ausführen

update(run: Union[str, Run], display_name: Optional[str] = None, description: Optional[str] = None, tags: Optional[Dict[str, str]] = None) → Optional[Run]#

Aktualisiert einen Lauf. Kann den Anzeigenamen, die Beschreibung oder die Tags aktualisieren.

Hinweis

  • Anzeigename und Beschreibung sind Zeichenfolgen, und Tags ist ein Wörterbuch aus Schlüssel-Wert-Paaren, sowohl Schlüssel als auch Wert sind Zeichenfolgen.

  • Tags ist ein Wörterbuch aus Schlüssel-Wert-Paaren. Das Aktualisieren von Tags überschreibt das vorhandene Schlüssel-Wert-Paar, löscht aber nicht die vorhandenen Schlüssel-Wert-Paare.

Parameter:

  • run (Union[str, Run]) – Der Laufname oder das Laufobjekt

  • display_name (Optional[str]) – Der Anzeigename

  • description (Optional[str]) – Die Beschreibung

  • tags (Optional[Dict[str, str]]) – Die Tags

Löst aus:

UpdateRunError – Wenn nichts oder falsch typisierte Werte zur Aktualisierung des Laufs bereitgestellt werden.

Gibt zurück:

Das Laufobjekt

Rückgabetyp:

Optional[Run]

visualize(runs: Union[str, Run, List[str], List[Run]], **kwargs) → None#

Visualisiert Lauf(e) über das Azure AI Portal.

Parameter:

runs (Union[str, Run, List[str], List[Run]]) – Namen der Läufe oder Liste von Laufobjekten.