promptflow.connections Modul#

class promptflow.connections.AzureAIServicesConnection(endpoint: str, api_key: Optional[str] = None, auth_mode: str = 'key', **kwargs)#

Bases: _StrongTypeAADSupportedConnection

Azure AI Services Verbindung.

Parameter:

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

  • endpoint (str) – Der API-Endpunkt.

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

  • name (str) – Verbindungsname.

TYPE = 'AzureAIServices'#
property endpoint#

Gibt den Verbindungsendpunkt zurück.

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

Bases: _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.

TYPE = 'AzureContentSafety'#
property api_type#

Gibt den API-Typ der Verbindung zurück.

property api_version#

Gibt die API-Version der Verbindung zurück.

property endpoint#

Gibt den Verbindungsendpunkt zurück.

class promptflow.connections.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: _StrongTypeAADSupportedConnection

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.

TYPE = 'AzureOpenAI'#
property api_base#

Gibt die API-Basis der Verbindung zurück.

property api_type#

Gibt den API-Typ der Verbindung zurück.

property api_version#

Gibt die API-Version der Verbindung zurück.

classmethod from_env(name=None)#

Verbindung aus Umgebungsvariablen erstellen.

Relevante Umgebungsvariablen

  • AZURE_OPENAI_ENDPOINT: Die API-Basis.

  • AZURE_OPENAI_API_KEY: Der API-Schlüssel.

  • OPENAI_API_VERSION: Optional.

Die API-Version standardmäßig auf AZURE_OPEN_AI.

property resource_id#

Gibt die Ressourcen-ID der Verbindung zurück.

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

Bases: _StrongTypeAADSupportedConnection

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.

TYPE = 'CognitiveSearch'#
property api_base#

Gibt die API-Basis der Verbindung zurück.

property api_version#

Gibt die API-Version der Verbindung zurück.

class promptflow.connections.ConnectionProvider#

Bases: ABC

Die Schnittstelle des Verbindungsanbieters zum Auflisten/Abrufen von Verbindungen in der aktuellen Umgebung.

PROVIDER_CONFIG_KEY = 'PF_CONNECTION_PROVIDER'#
abstract get(name: str) → _Connection#

Verbindung nach Name abrufen.

classmethod get_instance(**kwargs) → ConnectionProvider#

Ruft die Instanz des Verbindungsanbieters in der aktuellen Umgebung ab. Es werden unterschiedliche Implementierungen zurückgegeben, je nach aktueller Umgebung.

classmethod init_from_provider_config(provider_config: str, credential=None)#

Initialisiert den Verbindungsanbieter aus einer Anbieterkonfiguration.

Erwarteter Wert: - local - azureml://subscriptions/<ihre-abonnement-id>/resourceGroups/<ihre-ressourcengruppe>/ providers/Microsoft.MachineLearningServices/workspaces/<ihr-arbeitsbereich>

abstract list(**kwargs) → List[_Connection]#

Listet alle Verbindungen ohne Geheimnisse auf.

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

Bases: _Connection

Benutzerdefinierte Verbindung.

Parameter:

  • configs (Dict[str, str]) – Die Konfigurations-KV-Paare.

  • secrets (Dict[str, str]) – Die Geheimnis-KV-Paare.

  • name (str) – Verbindungsname

TYPE = 'Custom'#
is_secret(item)#

Prüft, ob das Element ein Geheimnis ist.

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

Bases: _Connection

Benutzerdefinierte starke Typverbindung.

Hinweis

Dieser Verbindungstyp sollte nicht direkt verwendet werden. Unten ist ein Beispiel für die Verwendung von CustomStrongTypeConnection

class MyCustomConnection(CustomStrongTypeConnection):
    api_key: Secret
    api_base: str
Parameter:

  • configs (Dict[str, str]) – Die Konfigurations-KV-Paare.

  • secrets (Dict[str, str]) – Die Geheimnis-KV-Paare.

  • name (str) – Verbindungsname

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

Bases: 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.

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

Bases: _StrongTypeConnection

OpenAI Verbindung.

Parameter:

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

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

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

  • name (str) – Verbindungsname.

TYPE = 'OpenAI'#
property base_url#

Gibt die API-Basis der Verbindung zurück.

classmethod from_env(name=None)#

Verbindung aus Umgebungsvariablen erstellen.

Relevante Umgebungsvariablen: - OPENAI_API_KEY: Der API-Schlüssel. - OPENAI_ORG_ID: Optional. Die eindeutige Kennung Ihrer Organisation, die in API-Anfragen verwendet werden kann. - OPENAI_BASE_URL: Optional. Geben Sie an, wenn Sie eine benutzerdefinierte API-Basis verwenden, lassen Sie None, um die Standard-API-Basis von OpenAI zu verwenden.

property organization#

Gibt die Organisation der Verbindung zurück.

class promptflow.connections.SerpConnection(api_key: str, **kwargs)#

Bases: _StrongTypeConnection

Serp Verbindung.

Parameter:

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

  • name (str) – Verbindungsname.

TYPE = 'Serp'#
class promptflow.connections.ServerlessConnection(api_key: str, api_base: str, **kwargs)#

Bases: _StrongTypeConnection

Serverless Verbindung.

Parameter:

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

  • api_base (str) – Die API-Basis.

  • name (str) – Verbindungsname.

TYPE = 'Serverless'#
property api_base#

Gibt die API-Basis der Verbindung zurück.