promptflow.operations Modul#

class promptflow.operations.ConnectionOperations(**kwargs)#

Bases: TelemetryMixin

ConnectionOperations.

create_or_update(connection: Type[_Connection], **kwargs)#

Erstellt oder aktualisiert eine Verbindung.

Parameter:: connection (_Connection) – Das zu erstellende oder zu aktualisierende Run-Objekt.

delete(name: str) → None#

Löscht eine Verbindungsentität.

Parameter:: name (str) – Name der Verbindung.

get(name: str, **kwargs) → _Connection#

Ruft eine Verbindungsentität ab.

Parameter:: name (str) – Name der Verbindung.
Gibt zurück:: Aus der Datenbank abgerufenes Verbindungsobjekt.
Rückgabetyp:: _Connection

list(max_results: int = 50, all_results: bool = False) → List[_Connection]#

Listet Verbindungen auf.

Parameter:

max_results (int) – Maximale Anzahl der zurückzugebenden Ergebnisse.
all_results (bool) – Gibt alle Ergebnisse zurück.

Gibt zurück:

Liste der Run-Objekte.

Rückgabetyp:

List[_Connection]

class promptflow.operations.FlowOperations(client, **kwargs)#

Bases: TelemetryMixin

FlowOperations.

build(flow: Union[str, PathLike], *, output: Union[str, PathLike], format: str = 'docker', variant: str = None, **kwargs)#

Erstellt einen Flow in ein anderes Format.

Parameter:

flow (Union[str, PathLike]) – Pfad zum Flow-Verzeichnis oder zur zu exportierenden Flow-DAG.
format (str) – Exportformat, unterstützt derzeit nur "docker" und "executable".
output (Union[str, PathLike]) – Ausgabe-Verzeichnis.
variant (str) – Knotenvariante im Format {knoten_name}.{varianten_name}, verwendet die Standardvariante, wenn nicht angegeben.

Gibt zurück:

keine Rückgabe

Rückgabetyp:

Keine

infer_signature(entry: Union[Callable, FlexFlow, Flow, Prompty], **kwargs) → dict#

Extrahiert die Signatur für eine aufrufbare Klasse oder eine Funktion oder einen Flow. Die Signatur gibt die Ports eines Flex-Flows unter Verwendung der aufrufbaren Funktion an.

Für Flex-Flows: Wenn der Einstiegspunkt eine aufrufbare Funktion ist, enthält die Signatur Eingaben und Ausgaben. Wenn der Einstiegspunkt eine aufrufbare Klasse ist, enthält die Signatur Eingaben, Ausgaben und Initialisierung.
Für Prompty-Flows: Die Signatur umfasst Eingaben, Ausgaben und die Initialisierung. Die Initialisierung bezieht sich auf PromptyModelConfiguration.
Für DAG-Flows: Die Signatur umfasst Eingaben und Ausgaben.

Der Typ jedes Ports wird aus den Typ-Annotationen der aufrufbaren Funktion abgeleitet und folgt dem Typsystem des JSON-Schemas. Da der Flow JSON-Eingaben im Batch-Run und beim Serven akzeptiert, unterstützen wir nur einen Teil der Typen für diese Ports. Komplizierte Typen müssen mit Dataclasses.dataclass dekoriert werden. Fehler werden ausgelöst, wenn annotierte Typen nicht unterstützt werden.

Parameter:: entry (Callable) – Einstiegspunkt des Flows, sollte ein Methodenname relativ zum Code sein.
Gibt zurück:: Signatur des Flows.
Rückgabetyp:: dict

save(entry: Union[str, Callable], code: Optional[Union[str, PathLike]] = None, path: Optional[Union[str, PathLike]] = None, *, python_requirements_txt: str = None, image: str = None, signature: dict = None, sample: Union[str, PathLike, dict] = None, **kwargs) → NoReturn#

Speichert eine aufrufbare Klasse oder eine Funktion als Flex-Flow.

Parameter:

entry (Union[str, Callable]) – Einstiegspunkt des Flows. Wenn der Einstiegspunkt ein String ist, wird `code` benötigt und der Einstiegspunkt muss ein Methodenname relativ zu `code` sein, z. B. „modul.methode“. Wenn der Einstiegspunkt eine aufrufbare Klasse oder eine Funktion ist, muss `code` auf None gesetzt sein.
code (Union[str, PathLike]) – Pfad zum Code-Verzeichnis. Wird in das Zielverzeichnis kopiert. Wenn der Einstiegspunkt eine aufrufbare Funktion ist, muss `code` auf None gesetzt sein und das übergeordnete Verzeichnis der Quell-Datei des Einstiegspunkts wird als Code verwendet.
path (Union[str, PathLike]) – Zielverzeichnis zum Erstellen des Flows. Wenn angegeben, muss es ein leeres oder nicht vorhandenes Verzeichnis sein. Wenn nicht angegeben, wird die Flow-Definition YAML-Datei im Code aktualisiert.
python_requirements_txt (str) – Pfad zur Python-Anforderungsdatei. Wenn nicht angegeben, wird requirements.txt verwendet, falls es im Code-Verzeichnis vorhanden ist.
image (str) – Bild zum Ausführen des Flows. Wird das Standardbild verwendet, wenn nicht angegeben.
signature (dict) – Signatur des Flows, gibt die Ein- und Ausgabepunkte des Flows an.
sample (dict) – Beispiel-Eingabedaten für den Flow. Wird für die Swagger-Generierung in flow serve verwendet.

Gibt zurück:

keine Rückgabe

Rückgabetyp:

Keine

test(flow: Union[str, PathLike], *, inputs: dict = None, variant: str = None, node: str = None, environment_variables: dict = None, init: Optional[dict] = None, **kwargs) → dict#

Testet Flow oder Knoten.

Parameter:

flow (Union[str, PathLike]) – Pfad zum zu testenden Flow-Verzeichnis.
inputs (dict) – Eingabedaten für den Flow-Test.
variant (str) – Knoten- &-Variantenname im Format ${node_name.variant_name}, es wird die Standardvariante verwendet, wenn nicht angegeben.
node (str) – Wenn angegeben, wird nur dieser Knoten getestet, andernfalls wird der Flow getestet.
environment_variables (dict) – Umgebungsvariablen, die durch Angabe eines Eigenschaftspfads und eines Werts festgelegt werden. Beispiel: {„key1“: „${my_connection.api_key}“, „key2“=”value2”} Der Wert, der auf Verbindungen verweist, wird auf den tatsächlichen Wert aufgelöst, und alle angegebenen Umgebungsvariablen werden in os.environ gesetzt.
init (dict) – Initialisierungsparameter für Flex-Flow, nur unterstützt, wenn der Flow eine aufrufbare Klasse ist.

Gibt zurück:

Das Ergebnis des Flows oder Knotens.

Rückgabetyp:

dict

validate(flow: Union[str, PathLike], *, raise_error: bool = False, **kwargs) → ValidationResult#

Validiert den Flow.

Parameter:

flow (Union[str, PathLike]) – Pfad zum Flow-Verzeichnis oder zur zu exportierenden Flow-DAG.
raise_error (bool) – Gibt an, ob bei fehlgeschlagener Validierung ein Fehler ausgelöst werden soll.

Gibt zurück:

Ein Validierungsergebnisobjekt.

Rückgabetyp:

ValidationResult

class promptflow.operations.RunOperations(client, **kwargs)#

Bases: TelemetryMixin

RunOperations.

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

Archiviert einen Run.

Parameter:: name (str) – Name des Laufs.
Gibt zurück:: Archiviertes Run-Objekt.
Rückgabetyp:: Ausführen

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

Erstellt oder aktualisiert einen Run.

Parameter:: run (Run) – Das zu erstellende oder zu aktualisierende Run-Objekt.
Gibt zurück:: Erstelltes oder aktualisiertes Run-Objekt.
Rückgabetyp:: Ausführen

delete(name: str) → None#

Löscht den Run dauerhaft. Vorsicht: Diese Operation löscht den Run dauerhaft von Ihrer lokalen Festplatte. Sowohl die Run-Entität als auch die Ausgabedaten werden gelöscht.

Parameter:: name – Name des zu löschenden Runs.
Gibt zurück:: Keine

get(name: str) → Run#

Ruft eine Run-Entität ab.

Parameter:: name (str) – Name des Laufs.
Gibt zurück:: Aus der Datenbank abgerufenes Run-Objekt.
Rückgabetyp:: Ausführen

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

Ruft die Details des Runs ab.

Hinweis

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

Parameter:

name (Union[str, Run]) – Der Name des Runs oder das Run-Objekt.
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(name: Union[str, Run]) → Dict[str, Any]#

Ruft die Metriken des Runs ab.

Parameter:: name (str) – Name des Runs.
Gibt zurück:: Run-Metriken.
Rückgabetyp:: Dict[str, Any]

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

Listet Runs auf.

Parameter:

max_results (Optional[int]) – Maximale Anzahl der zurückzugebenden Ergebnisse. Standard: MAX_RUN_LIST_RESULTS.
list_view_type – Ansichtstyp zum Ein-/Ausschließen (z. B.) archivierter Runs. Standard: ACTIVE_ONLY.

Gibt zurück:

Liste der Run-Objekte.

Rückgabetyp:

List[Run]

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

Einen Lauf wiederherstellen.

Parameter:: name (str) – Name des Laufs.
Gibt zurück:: Wiederhergestelltes Run-Objekt.
Rückgabetyp:: Ausführen

stream(name: Union[str, Run], raise_on_error: bool = True) → Run#

Streamt Run-Protokolle an die Konsole.

Parameter:

name (Union[str, Run]) – Name des Runs oder Run-Objekt.
raise_on_error (bool) – Löst eine Ausnahme aus, wenn ein Lauf fehlschlägt oder abgebrochen wird.

Gibt zurück:

Run-Objekt.

Rückgabetyp:

Ausführen

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

Aktualisiert den Status eines Runs.

Parameter:

name – Name des Runs.
display_name – anzuzeigender Name für die Aktualisierung.
description – Beschreibung für die Aktualisierung.
tags – Tags für die Aktualisierung.
kwargs – Weitere zu aktualisierende Felder. Nicht unterstützte Felder werden direkt verworfen.

Gibt zurück:

Aktualisiertes Run-Objekt.

Rückgabetyp:

Ausführen

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

Visualisiert Lauf(e).

Parameter:: runs (Union[str, Run, List[str], List[Run]]) – Liste der Run-Objekte oder Namen der Runs.