hugging face qa bot
v0.3
Ein Multi-Größen-Q & A-System, das LLM und Abrufer Generation (Abruf Augmented Generation) verwendet, um Antworten auf der Grundlage von Dokumentationen mit der Umarmung zu liefern. Als API, Discord Bot oder Gradio -App betrieben werden, bietet sie auch Links zu der Dokumentation, mit der jede Antwort formuliert wird.
Um die verfügbaren Schnittstellen auszuführen, geben Sie die erforderlichen Parameter in der .env -Datei basierend auf dem .env.example im config/ Verzeichnis an. Alternativ können Sie diese als Umgebungsvariablen festlegen:
QUESTION_ANSWERING_MODEL_ID - (STR) Eine Zeichenfolge, die entweder die Modell -ID aus dem umarmenden Gesichtszentrum oder das Verzeichnis, das die Modellgewichte enthält, angibtEMBEDDING_MODEL_ID - (str) Einbettungsmodell -ID aus dem Umarmungs -Face -Hub. Wir empfehlen die Verwendung des hkunlp/instructor-largeINDEX_REPO_ID - (STR) Repository -ID aus dem Umarmungs -Face -Hub, in dem der Index gespeichert ist. Liste der tatsächlichsten Indizes finden Sie in diesem Abschnitt: IndizesPROMPT_TEMPLATE_NAME - (STR) Name der für die Beantwortung der Frage verwendeten Modell -Eingabeaufforderung -Vorlage. Vorlagen werden im Verzeichnis config/api/prompt_templates gespeichertUSE_DOCS_FOR_CONTEXT - (bool) Verwenden Sie abgerufene Dokumente als Kontext für eine bestimmte AbfrageNUM_RELEVANT_DOCS - (int) Anzahl der für die vorherigen Funktion verwendeten DokumenteADD_SOURCES_TO_RESPONSE - (bool) enthalten Quellen der abgerufenen Dokumente, die als Kontext für eine bestimmte Abfrage verwendet werdenUSE_MESSAGES_IN_CONTEXT - (bool) Verwenden Sie den Chat -Verlauf für KonversationserfahrungenDEBUG - (BOOL) bietet zusätzliche ProtokollierungInstallieren Sie die erforderlichen Abhängigkeiten aus der Anforderungen Datei:
pip install -r requirements.txt Geben Sie nach Abschluss aller Schritte, wie im Abschnitt "Einrichten" beschrieben, die Umgebungsvariable APP_MODE als gradio an und führen Sie den folgenden Befehl aus:
python3 app.py Standardmäßig wird die API unter http://0.0.0.0:8000 serviert. Führen Sie alle im Abschnitt "Einrichten" beschriebenen Schritte aus und führen Sie den folgenden Befehl aus:
python3 -m api Um mit dem System als Discord -Bot zu interagieren, fügen Sie zusätzliche erforderliche Umgebungsvariablen aus dem Abschnitt Discord bot in der Datei .env.example im config/ Verzeichnis hinzu.
DISCORD_TOKEN - (str) API -Schlüssel für die Bot -AnwendungQA_SERVICE_URL - (str) URL des API -Dienstes. Wir empfehlen: http://0.0.0.0:8000NUM_LAST_MESSAGES - (int) Anzahl der Nachrichten, die für den Kontext in Gesprächen verwendet werdenUSE_NAMES_IN_CONTEXT - (bool) Einbeziehen Benutzernamen im KonversationskontextENABLE_COMMANDS - (bool) Erlauben Sie Befehle, z. B. KanalreinigungDEBUG - (BOOL) bietet zusätzliche ProtokollierungFühren Sie nach Abschluss aller Schritte aus:
python3 -m bot Geben Sie die Variable der APP_MODE -Umgebungsvariable als discord an, um Bot auf Umarmungsräumen zu hosten, und der Bot wird automatisch aus der app.py -Datei ausgeführt.
Die folgende Liste enthält die aktuellsten Indizes, die für das System verwendet werden können:
Wir verwenden Python 3.10
Führen Sie den folgenden Befehl aus, um alle notwendigen Python -Pakete zu installieren:
pip install -r requirements.txtWir verwenden die Pipreqsnb, um die Datei der Anforderungen.txt zu generieren. Führen Sie den folgenden Befehl aus, um Pipreqsnb zu installieren:
pip install pipreqsnbFühren Sie den folgenden Befehl aus: Um die Datei "Anforderungen.txt" zu generieren, führen Sie den folgenden Befehl aus:
pipreqsnb --force .Um Unit -Tests auszuführen, können Sie den folgenden Befehl verwenden:
pytest -o " testpaths=tests " --noconftest
