promptflow.client Modul#

class promptflow.client.PFClient(**kwargs)#

Basiert auf: object

Eine Client-Klasse zur Interaktion mit Prompt-Flow-Entitäten.

property connections: ConnectionOperations#

Verbindungsoperationen zur Verwaltung von Verbindungen.

property flows: FlowOperations#

Operationen für den Flow zur Verwaltung von Flows.

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

Ruft die Details aus der Ausführung ab, einschließlich Eingaben und Ausgaben.

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]) → Dict[str, Any]#

Ruft Ausführungsmetriken ab.

Parameter:

run (Union[str, Run]) – Ausführungsobjekt oder Name der Ausführung.

Gibt zurück:

Ausführungsmetriken.

Rückgabetyp:

Dict[str, Any]

run(flow: Optional[Union[str, PathLike, Callable]] = None, *, data: Optional[Union[str, PathLike]] = None, run: Optional[Union[str, Run]] = 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, Run]] = None, code: Optional[Union[str, PathLike]] = None, init: Optional[dict] = None, **kwargs) → Run#

Führt den Flow anhand der bereitgestellten Daten oder Ausführung aus.

Hinweis

Mindestens einer der Parameter data oder run muss angegeben werden.

Spaltenzuordnung

Die Spaltenzuordnung ist eine Zuordnung von Flow-Eingabenamen zu bestimmten Werten. Wenn angegeben, wird der Flow mit dem bereitgestellten Wert für die angegebenen Eingaben ausgeführt. Der Wert kann sein

  • aus Daten

    • data.col1

  • aus Ausführung

    • run.inputs.col1: wenn auf die Eingaben der Ausführung verwiesen werden soll

    • run.output.col1: wenn auf die Ausgaben der Ausführung verwiesen werden soll

  • Beispiel

    • {"ground_truth": "${data.answer}", "prediction": "${run.outputs.answer}"}

Parameter:

  • flow (Union[str, PathLike]) – Pfad zum Flow-Verzeichnis für die Ausführung der Bewertung.

  • data (Union[str, PathLike]) – Zeiger auf die Testdaten (für Bulk-Läufe von Varianten) für Evaluationsläufe.

  • run (Union[str, Run]) – Flow-Lauf-ID oder Flow-Lauf. Dieser Parameter hilft, die Abstammung zwischen dem aktuellen Lauf und Variantenläufen beizubehalten. Batch-Ausgaben können als ${run.outputs.col_name} in der Eingabezuordnung referenziert werden.

  • column_mapping (Dict[str, str]) – Definiert eine Datenflusslogik zur Zuordnung von Eingabedaten.

  • variant (str) – Knoten- & Variantenname im Format ${node_name.variant_name}. Die Standardvariante wird verwendet, wenn keine angegeben ist.

  • connections (Dict[str, Dict[str, str]]) – Überschreibt knotenspezifische Verbindungen mit den bereitgestellten Werten. Beispiel: {"node1": {"connection": "new_connection", "deployment_name": "gpt-35-turbo"}}

  • environment_variables (Dict[str, str]) – Umgebungsvariablen, die durch Angabe eines Eigenschaftspfads und eines Werts gesetzt werden. Beispiel: {"key1": "${my_connection.api_key}", "key2"="value2"} Der Wert, der auf Verbindungs-Schlüssel verweist, wird zu seinem tatsächlichen Wert aufgelöst, und alle angegebenen Umgebungsvariablen werden in os.environ gesetzt.

  • name (str) – Name des Laufs.

  • display_name (str) – Anzeigename der Ausführung.

  • tags (Dict[str, str]) – Tags der Ausführung.

  • resume_from (str) – Erstellt eine Ausführung, die von einer vorhandenen Ausführung fortgesetzt wird.

  • code (Union[str, PathLike]) – Pfad zum Code-Verzeichnis zur Ausführung.

  • init (dict) – Initialisierungsparameter für Flex-Flow, nur unterstützt, wenn der Flow eine aufrufbare Klasse ist.

Gibt zurück:

Informationen zum Flow-Lauf.

Rückgabetyp:

Ausführen

property runs: RunOperations#

Ausführungsoperationen zur Verwaltung von Ausführungen.

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

Streamt Run-Protokolle an die Konsole.

Parameter:

  • run (Union[str, Run]) – Ausführungsobjekt oder Name der Ausführung.

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

Gibt zurück:

Informationen zum Flow-Lauf.

Rückgabetyp:

Ausführen

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

Testet einen Flow oder Knoten.

Parameter:

  • flow (Union[str, PathLike]) – Pfad zum Flow-Verzeichnis, das getestet werden soll.

  • inputs (Union[dict, PathLike]) – Eingabedaten oder JSON-Datei 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 gesetzt werden. Beispiel: {“key1”: “${my_connection.api_key}”, “key2”=”value2”} Der Wert, der auf Verbindungs-Schlüssel verweist, wird zu seinem 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

property tools: ToolOperations#

Tool-Operationen zur Verwaltung von Tools.

property traces: TraceOperations#

Operationen für den Trace zur Verwaltung von Traces.

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

Visualisiert Lauf(e).

Parameter:

run (Union[str, Run]) – Ausführungsobjekt oder Name der Ausführung.

promptflow.client.load_flow(source: Union[str, PathLike, IO], **kwargs) → Flow#

Lädt einen Flow aus einer YAML-Datei.

Parameter:

source (Union[PathLike, str]) – Die lokale YAML-Quelle eines Flows. Muss ein Pfad zu einer lokalen Datei sein. Wenn die Quelle ein Pfad ist, wird sie geöffnet und gelesen. Es wird eine Ausnahme ausgelöst, wenn die Datei nicht existiert.

Gibt zurück:

Ein Flow-Objekt.

Rückgabetyp:

Flow

promptflow.client.load_run(source: Union[str, PathLike, IO], params_override: Optional[list] = None, **kwargs) → Run#

Lädt eine Ausführung aus einer YAML-Datei.

Parameter:

  • source (Union[PathLike, str]) – Die lokale YAML-Quelle einer Ausführung. Muss ein Pfad zu einer lokalen Datei sein. Wenn die Quelle ein Pfad ist, wird sie geöffnet und gelesen. Es wird eine Ausnahme ausgelöst, wenn die Datei nicht existiert.

  • params_override (List[Dict]) – Felder, die auf Basis der YAML-Datei überschrieben werden sollen. Format: [{“field1”: “value1”}, {“field2”: “value2”}]

Gibt zurück:

Ein Run-Objekt.

Rückgabetyp:

Ausführen