ragtime Download - ragtime Source Code Download

ragtime

AI-Quellcode

1.0.0

Herunterladen

Ragtime

Ein Open-Source-Rag-Bot für Slack und Zwietracht mit Vectara. Mit diesem Bot können Sie einen Lack- oder Discord -Bot erstellen, der mit Ihrem Server verbunden ist und Benutzerfragen beantwortet, indem Sie einen Vectara -Korpus abfragen.

Verwendung

Erwähnen Sie den Bot in einer Nachricht, um eine Antwort zu erhalten.
Senden Sie eine direkte Nachricht an den Bot für ein 1: 1 -Gespräch.
Der Bot speichert Nachrichten- und Thread-IDs, um kontextbewusste Antworten in Threads oder während der Beantwortung anzugeben.

Beispielbefehle

Erwähnen Sie den Bot: @bot-name Your message here
Senden Sie eine direkte Nachricht: Your message here

Installation

Voraussetzungen

Python 3,8 oder höher

Aufstellen

Klonen Sie das Repository:

git clone https://github.com/vectara/ragtime.git
cd ragtime

Installieren Sie die erforderlichen Abhängigkeiten:
```
 pip3 install requirement.txt
```

Umgebungsvariablen einrichten:

Erstellen Sie eine .env -Datei im Stamm Ihres Projekts und fügen Sie Folgendes hinzu:

 SLACK_BOT_TOKEN=<OAuth level token>
SLACK_APP_TOKEN=<APP level token>
DISCORD_BOT_TOKEN=<Discord bot token>
VECTARA_CUSTOMER_ID="<VECTARA_CUSTOMER_ID>"
VECTARA_CORPUS_IDS="<VECTARA_CORPUS_IDS>"
VECTARA_API_KEY="<VECTARA_API_KEY>"
ACCOUNT_SID=<Twilio account SID>
Auth_TOKEN=<Twilio auth token>
TWILIO_WHATSAPP_NUMBER=<Whatsapp number configured in twilio>

Um den Agentenlag zu aktivieren, fügen Sie die folgenden Variablen hinzu.

 ENABLE_AGENTIC_RAG=True ## To enable agentic rag. By default ragtime uses vanilla RAG.
AGENTIC_RAG_DATA_DESCRIPTION='Vectara website, docs and forum data'
AGENTIC_RAG_ASSISTANT_SPECIALTY='Vectara'
AGENTIC_RAG_TOOL_NAME='ask_vectara'

Die VECTARA_CUSTOMER_ID und VECTARA_CORPUS_IDS verweisen auf Ihr Vectara -Konto und die relevante Korpora, die sie verwenden können.
VECTARA_CORPUS_IDS können eine einzelne Corpus-ID (numerisch) oder eine von Kommas getrennte Corpora-Liste sein.

Ausführen von Ragtime -Bots

Ragtime unterstützt Slack Bot, Discord Bot und WhatsApp Bot. Sie können eines davon oder alles ausführen.

Wie man es lokal ausführt

Beide Bots ausführen
```
python3 main.py
```
Nur Slack Bot ausführen
```
python3 main.py slack
```
Nur Discord Bot ausführen
```
python3 main.py discord
```
Nur WhatsApp Bot ausführen
```
python3 main.py whatsapp
```

Führen Sie die Anwendung mit Docker aus

Bauen und mit Docker laufen.

Beide Bots ausführen
```
bash run_docker.sh
```
Nur Slack Bot ausführen
```
bash run_docker.sh slack
```
Nur Discord Bot ausführen
```
bash run_docker.sh discord
```
Nur WhatsApp Bot ausführen
```
bash run_docker.sh whatsapp
```

Schritte zum Erstellen von Slack Bot

Befolgen Sie die folgenden Schritte in Orer, um Ihren Ragtime -Bot mit Ihrem Slack -Service zu verbinden:

Melden Sie sich in Ihrem Slack -Arbeitsbereich an und navigieren Sie zur Slack -API -Website. Klicken Sie auf "Ihre Apps" und dann "Neue App erstellen". Geben Sie einen Namen für Ihre App an, wählen Sie den Arbeitsbereich aus, in dem Sie ihn installieren möchten, und klicken Sie auf "App erstellen".
In den App -Einstellungen können Sie verschiedene Details wie App -Namen, Symbol und Beschreibung konfigurieren. Stellen Sie sicher, dass Sie die erforderlichen Informationen genau ausfüllen.
Sobald Sie Ihre App konfiguriert haben, navigieren Sie zum Abschnitt "App installieren". Klicken Sie auf die Schaltfläche "App für die App für den Arbeitsbereich installieren", um den Bot zu Ihrem Slack -Arbeitsbereich hinzuzufügen. Dieser Schritt erzeugt ein OAuth Access -Token, mit dem Sie Ihren Bot authentifizieren müssen.
Um den Bereich "Nutzer -Token" hinzuzufügen, navigieren Sie in Ihren App -Einstellungen zum Abschnitt "OAuth & Berechtigungen". Unter dem Abschnitt "OAuth -Token für Ihren Arbeitsbereich" müssen Sie app_mentions:read , channels:history , chat:write , chat:write.public , groups:history , im:history , mpim:history mpim:read mpim:write , users:read Scopes. Erstellen Sie das Token und speichern Sie es in Ihrer .env -Datei als SLACK_BOT_TOKEN .
Erstellen Sie ein App -Level -Token mit der connection:write Umfang. Speichern Sie dieses Token als SLACK_APP_TOKEN in Ihrer .env -Datei.
Stellen Sie sicher, dass Sie alle Änderungen an Ihren App -Einstellungen speichern und den Bot am Arbeitsplatz installieren/neu installieren.

Schritte zum Erstellen von Discord Bot

Befolgen Sie die folgenden Schritte, um Ihren Ragtime -Bot an Ihren Discord -Server zu verbinden:

Navigieren Sie zu Discord Developer Portal Applications-Seite und erstellen Sie eine neue Anwendung, indem Sie auf die Schaltfläche "Neue Anwendung" in der oberen rechten Ecke klicken.
Gehen Sie zur Seite "Bot", indem Sie die Option "Bot" aus der linken Spalte auswählen.
Kopieren Sie das bereitgestellte Token und speichern Sie es als DISCORD_BOT_TOKEN .
Wählen Sie in der linken Spalte 'oAuth2' und wählen Sie den URL -Generator.
Wählen Sie im Abschnitt "BOT -Berechtigungen" unten die erforderlichen Berechtigungen aus.
Wählen Sie die Option "Bot" im Feld "Scope", und unten wird das Feld "Bot -Berechtigungen" angezeigt.
Wählen Sie "Nachricht lesen", "Nachricht senden" und "Nachricht verwalten".
Kopieren Sie die generierte URL und fügen Sie sie in Ihren Webbrowser ein. Es wird Sie zur Discord -Seite umleiten, um den Bot zu Ihrem Server hinzuzufügen.

So richten Sie WhatsApp -Bot mit Twilio ein

Um Ihren Ragtime WhatsApp -Bot zu verbinden, befolgen Sie die folgenden Schritte:

Melden Sie sich bei Ihrer Twilio -Konsole an.
Navigieren Sie zur WhatsApp -Sandbox.
Konfigurieren Sie den /whatsapp -Endpunkt für die Kommunikation.
Kopieren Sie das Konto SID, Auth Token und WhatsApp Sandbox -Nummer in .env

Autor

? Vectara

Website: https://vectara.com
Twitter: @Vectara
Github: @Vectara
LinkedIn: @Vectara
Discord: @Vectara

? Beitragen

Beiträge, Probleme und Feature -Anfragen sind willkommen!
Fühlen Sie sich frei, Probleme mit der Seite zu überprüfen. Sie können sich auch den beitragenden Leitfaden ansehen.