promptflow.entities Modul#

class promptflow.entities.AzureContentSafetyConnection(api_key: str, endpoint: str, api_version: str = '2023-10-01', api_type: str = 'Content Safety', **kwargs)#

Bases: AzureContentSafetyConnection, _StrongTypeConnection

Azure Content Safety Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • endpoint (str) – Der API-Endpunkt.

  • api_version (str) – Die API-Version, Standard siehe: AZURE_CONTENT_SAFETY.

  • api_type (str) – Der API-Typ, Standard "Content Safety".

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von AzureContentSafetyConnection

class promptflow.entities.AzureOpenAIConnection(api_base: str, api_key: Optional[str] = None, api_type: str = 'azure', api_version: str = '2024-02-01', auth_mode: str = 'key', resource_id: Optional[str] = None, **kwargs)#

Bases: AzureOpenAIConnection, _StrongTypeConnection

Azure OpenAI Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • api_base (str) – Die API-Basis.

  • api_type (str) – Der API-Typ, Standard "azure".

  • api_version (str) – Die API-Version, Standard siehe: AZURE_OPEN_AI

  • auth_mode (str) – Der Authentifizierungsmodus, unterstützte Werte siehe: ConnectionAuthMode.

  • resource_id (str) – Optional, die ARM-Ressourcen-ID.

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von AzureOpenAIConnection

class promptflow.entities.CognitiveSearchConnection(api_base: str, api_key: Optional[str] = None, api_version: str = '2023-11-01', auth_mode: str = 'key', **kwargs)#

Bases: CognitiveSearchConnection, _StrongTypeConnection

Cognitive Search Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • api_base (str) – Die API-Basis.

  • api_version (str) – Die API-Version, Standard "2023-11-01".

  • auth_mode (str) – Der Authentifizierungsmodus, unterstützte Werte siehe: ConnectionAuthMode.

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von CognitiveSearchConnection

class promptflow.entities.CustomConnection(secrets: Dict[str, str], configs: Optional[Dict[str, str]] = None, **kwargs)#

Bases: CustomConnection, _Connection

Benutzerdefinierte Verbindung.

Parameter:

  • configs (Dict[str, str]) – Die Konfigurations-Schlüssel-Wert-Paare.

  • secrets (Dict[str, str]) – Die Geheimnis-Schlüssel-Wert-Paare.

  • name (str) – Verbindungsname

DATA_CLASS#

alias von CustomConnection

class promptflow.entities.DynamicList(function: dataclasses.InitVar[Union[str, Callable]], input_mapping: dataclasses.InitVar[Dict] = None)#

Basiert auf: object

func_kwargs: List#
func_path: str#
function: dataclasses.InitVar[Union[str, Callable]]#

Die dynamische Listenfunktion.

input_mapping: dataclasses.InitVar[Dict] = None#

Die Zuordnung zwischen dynamischen Listenfunktions- und Tool-Eingaben.

class promptflow.entities.FlowContext(*, connections=None, variant=None, overrides=None, streaming=None)#

Basiert auf: object

Flow-Kontext-Entität. Die Einstellungen in diesem Kontext werden bei der Ausführung auf den Flow angewendet.

Parameter:

  • connections (Optional[Dict[str, Dict]]) – Verbindungen für den Flow.

  • variant (Optional[Dict[str, Dict]]) – Variante des Flows.

  • variant – Überschreibungen des Flows.

  • streaming (Optional[bool]) – Ob die Ausgabe des Flows im Streaming-Modus zurückgegeben werden soll.

class promptflow.entities.FormRecognizerConnection(api_key: str, endpoint: str, api_version: str = '2023-07-31', api_type: str = 'Form Recognizer', **kwargs)#

Bases: FormRecognizerConnection, AzureContentSafetyConnection

Form Recognizer Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • endpoint (str) – Der API-Endpunkt.

  • api_version (str) – Die API-Version, Standard siehe: FORM_RECOGNIZER.

  • api_type (str) – Der API-Typ, Standard "Form Recognizer".

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von FormRecognizerConnection

class promptflow.entities.InputSetting(**kwargs)#

Basiert auf: object

Einstellungen des Tool-Inputs

allow_manual_entry: bool = None#

Benutzer die manuelle Eingabe des Werts erlauben.

dynamic_list: DynamicList = None#

Einstellungen der dynamischen Listenfunktion.

enabled_by: str = None#

Das Eingabefeld, das ein Enum-Typ sein muss und die Sichtbarkeit des abhängigen Eingabefeldes steuert.

enabled_by_value: List = None#

Definiert die akzeptierten Enum-Werte aus dem `enabled_by`-Feld, die dieses abhängige Eingabefeld sichtbar machen.

generated_by: GeneratedBy = None#

Einstellungen der `generated_by`-Funktion.

is_multi_select: bool = None#

Benutzer erlauben, mehrere Werte auszuwählen.

class promptflow.entities.OpenAIConnection(api_key: str, organization: Optional[str] = None, base_url=None, **kwargs)#

Bases: OpenAIConnection, _StrongTypeConnection

OpenAI Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • organization (str) – Optional. Die eindeutige Kennung für Ihre Organisation, die in API-Anfragen verwendet werden kann.

  • base_url (str) – Optional. Geben Sie dies an, wenn Sie eine benutzerdefinierte API-Basis verwenden, lassen Sie es auf None, um die Standard-API-Basis von OpenAI zu verwenden.

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von OpenAIConnection

class promptflow.entities.QdrantConnection(api_key: str, api_base: str, **kwargs)#

Bases: QdrantConnection, _StrongTypeConnection

Qdrant Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • api_base (str) – Die API-Basis.

  • name (str) – Verbindungsname.

DATA_CLASS#

alias von QdrantConnection

Klasse promptflow.entities.Run(flow: Optional[Union[str, Path]] = None, name: Optional[str] = None, data: Optional[str] = None, variant: Optional[str] = None, run: Optional[Union[Run, str]] = None, column_mapping: Optional[dict] = None, display_name: Optional[str] = None, description: Optional[str] = None, tags: Optional[List[Dict[str, str]]] = None, *, created_on: Optional[datetime] = None, start_time: Optional[datetime] = None, end_time: Optional[datetime] = None, status: Optional[str] = None, environment_variables: Optional[Dict[str, str]] = None, connections: Optional[Dict[str, Dict]] = None, properties: Optional[Dict[str, Any]] = None, source: Optional[Union[str, Path]] = None, init: Optional[Dict[str, Any]] = None, **kwargs)#

Bases: YAMLTranslatableMixin

Flow-Lauf-Entität.

Parameter:

  • flow (Pfad) – Lokaler Flow-Einstiegspunkt oder Remote-Flow.

  • name (str) – Name des Laufs.

  • data (Optional[str]) – Eingabedaten für den Lauf. Unterstützt werden lokale Pfade oder Remote-URIs (beginnen mit azureml: oder öffentlicher URL). Hinweis: Remote-URI wird nur für Cloud-Läufe unterstützt. # noqa: E501

  • variant (Optional[str]) – Variante des Laufs.

  • run (Optional[Union[Run, str]]) – Elternlauf oder Lauf-ID.

  • column_mapping (Optional[dict]) – Spaltenzuordnung für den Lauf. Optional, da es nicht in der Datenbank gespeichert wird.

  • display_name (Optional[str]) – Anzeigename des Laufs.

  • description (Optional[str]) – Beschreibung des Laufs.

  • tags (Optional[List[Dict[str, str]]]) – Tags des Laufs.

  • created_on (Optional[datetime.datetime]) – Datum und Uhrzeit, zu der der Lauf erstellt wurde.

  • start_time (Optional[datetime.datetime]) – Datum und Uhrzeit, zu der der Lauf gestartet wurde.

  • end_time (Optional[datetime.datetime]) – Datum und Uhrzeit, zu der der Lauf beendet wurde.

  • status (Optional[str]) – Status des Laufs.

  • environment_variables (Optional[Dict[str, str]]) – Umgebungsvariablen für den Lauf.

  • connections (Optional[Dict[str, Dict]]) – Verbindungen für den Lauf.

  • properties (Optional[Dict[str, Any]]) – Eigenschaften des Laufs.

  • init (Optional[Dict[str, Any]]) – Klassen-Init-Argumente für aufrufbare Klassen, nur für Flex-Flows unterstützt.

  • kwargs (Optional[dict]) – Zusätzliche Schlüsselwortargumente.

property created_on: str#
property init#
property properties: Dict[str, str]#
property status: str#
Klasse promptflow.entities.SerpConnection(api_key: str, **kwargs)#

Bases: SerpConnection, _StrongTypeConnection

Serp-Verbindung.

Parameter:

  • api_key (str) – Der API-Schlüssel.

  • name (str) – Verbindungsname.

DATA_CLASS#

alias of SerpConnection