promptflow.rag.config Modul#

class promptflow.rag.config.AzureAISearchConfig(*, ai_search_index_name: Optional[str] = None, ai_search_connection_config: Optional[ConnectionConfig] = None, connection_id: Optional[str] = None)#

Basiert auf: object

Konfigurationsklasse zur Erstellung eines Azure AI Search Index.

Parameter:

  • ai_search_index_name (Optional[str]) – Der Name des Azure AI Search Index.

  • ai_search_connection_id – Die Azure AI Search Verbindungskonfiguration.

  • ai_search_connection_id – Der Name des Azure AI Search Index.

get_connection_id() → Optional[str]#

Connection-ID aus der Verbindungskonfiguration oder der Connection-ID abrufen

class promptflow.rag.config.AzureAISearchSource(*, ai_search_index_name: str, ai_search_content_key: str, ai_search_embedding_key: str, ai_search_title_key: str, ai_search_metadata_key: str, ai_search_connection_id: Optional[str] = None, num_docs_to_import: int = 50)#

Bases: IndexDataSource

Konfigurationsklasse zur Erstellung eines ML-Index aus einem OpenAI <Ding>.

Parameter:

  • ai_search_index_name (str) – Der Name des Azure AI Search Index, der als Quelle verwendet werden soll.

  • ai_search_content_key (str) – Der Schlüssel für das Inhaltsfeld im Azure AI Search Index.

  • ai_search_embedding_key (str) – Der Schlüssel für das Embedding-Feld im Azure AI Search Index.

  • ai_search_title_key (str) – Der Schlüssel für das Titel-Feld im Azure AI Search Index.

  • ai_search_metadata_key (str) – Der Schlüssel für das Metadatenfeld im Azure AI Search Index.

  • ai_search_connection_id (str) – Die Verbindungs-ID für den Azure AI Search Index.

  • num_docs_to_import (int) – Anzahl der aus dem vorhandenen Azure AI Search Index zu importierenden Dokumente. Standardmäßig 50.

class promptflow.rag.config.ConnectionConfig(*, subscription_id: str, resource_group_name: str, workspace_name: str, connection_name: str)#

Basiert auf: object

Konfigurationsklasse für die Verbindung.

Parameter:

  • subscription (str) – Das Abonnement einer Verbindung.

  • resource_group (str) – Die Ressourcengruppe einer Verbindung.

  • workspace (str) – Der Arbeitsbereich einer Verbindung.

  • connection_name (str) – Der Verbindungsname.

build_connection_id() → str#

Erstellt die Verbindungs-ID aus der Verbindungskonfiguration

class promptflow.rag.config.EmbeddingsModelConfig(*, model_name: Optional[str] = None, deployment_name: Optional[str] = None, connection_id: Optional[str] = None, connection_config: Optional[ConnectionConfig] = None)#

Basiert auf: object

Konfigurationsklasse für ein Embedding-Modell.

Parameter:

  • model_name (Optional[str]) – Der Name des Embedding-Modells.

  • deployment_name (Optional[str]) – Der Deployment-Name für das Embedding-Modell.

  • connection_id (Optional[str]) – Die Verbindungs-ID für das Embedding-Modell.

  • connection_config (Optional[ConnectionConfig]) – Die Verbindungskonfiguration für das Embedding-Modell.

get_connection_id() → Optional[str]#

Connection-ID aus der Verbindungskonfiguration oder der Connection-ID abrufen

class promptflow.rag.config.GitSource(*, git_url: str, git_branch_name: str, git_connection_id: str)#

Bases: IndexDataSource

Konfigurationsklasse zur Erstellung eines ML-Index aus Dateien in einem Git-Repository.

Parameter:

  • git_url (str) – Ein Link zum zu verwendenden Repository.

  • git_branch_name (str) – Der Name des zu verwendenden Branches aus dem Ziel-Repository.

  • git_connection_id (str) – Die Verbindungs-ID für GitHub

class promptflow.rag.config.IndexDataSource(*, input_type: Union[str, IndexInputType])#

Basiert auf: object

Basisklasse für Konfigurationen, die Daten definieren, die in einen ML-Index verarbeitet werden. Diese Klasse sollte nicht direkt instanziiert werden. Verwenden Sie stattdessen eine ihrer Unterklassen.

Parameter:

input_type (Union[str, IndexInputType]) – Ein Typ-Enum, das die Quelle des Index beschreibt. Wird verwendet, um direkte Typüberprüfungen zu vermeiden.

class promptflow.rag.config.LocalSource(*, input_data: str)#

Bases: IndexDataSource

Konfigurationsklasse zur Erstellung eines ML-Index aus einer Sammlung lokaler Dateien.

Parameter:

input_data (str) – Eine Eingabezeichenkette für den lokalen Speicherort der Indexquellendateien.