ragtime Download - ragtime Source Code Download

ragtime

Code Source AI

1.0.0

Télécharger

Rag-time

Un bot de chiffon open source pour Slack et Discord en utilisant Vectara. Avec ce bot, vous pouvez créer un bot Slack ou Discord qui est connecté à votre serveur et répond aux questions des utilisateurs en interrogeant un corpus vectara.

Usage

Mentionnez le bot dans un message pour recevoir une réponse.
Envoyez un message direct au bot pour une conversation 1: 1.
Le BOT stocke le message et les identifiants de threads pour fournir des réponses au contexte dans les threads ou pendant la réponse.

Exemples de commandes

Mentionnez le bot: @bot-name Your message here
Envoyez un message direct: Your message here

Installation

Condition préalable

Python 3,8 ou plus

Installation

Clone le référentiel:

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

Installez les dépendances requises:
```
 pip3 install requirement.txt
```

Configurer des variables d'environnement:

Créez un fichier .env à la racine de votre projet et ajoutez ce qui suit:

 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>

Pour activer le chiffon agentique, ajoutez les variables suivantes.

 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'

Le VECTARA_CUSTOMER_ID et VECTARA_CORPUS_IDS pointent vers votre compte Vectara et les corpus pertinents à utiliser.
VECTARA_CORPUS_IDS peut être un seul ID de corpus (numérique) ou une liste de corpus séparés par des virgules.

Running ragtime bots

Ragtime prend en charge Slack Bot, Discord Bot et WhatsApp Bot. Vous pouvez en exécuter un, ou tous.

Comment l'exécuter localement

Exécuter les deux bots
```
python3 main.py
```
Running Only Slack Bot
```
python3 main.py slack
```
Exécuter uniquement Discord Bot
```
python3 main.py discord
```
Exécuter uniquement WhatsApp Bot
```
python3 main.py whatsapp
```

Exécutez l'application à l'aide de Docker

Construisez et exécutez avec Docker.

Exécuter les deux bots
```
bash run_docker.sh
```
Running Only Slack Bot
```
bash run_docker.sh slack
```
Exécuter uniquement Discord Bot
```
bash run_docker.sh discord
```
Exécuter uniquement WhatsApp Bot
```
bash run_docker.sh whatsapp
```

Étapes pour créer un bot Slack

À Orer pour connecter votre bot Ragtime à votre service Slack, suivez ces étapes:

Connectez-vous à votre espace de travail Slack et accédez au site Web de l'API Slack. Cliquez sur "Vos applications" puis "Créer une nouvelle application". Fournissez un nom pour votre application, sélectionnez l'espace de travail où vous souhaitez l'installer et cliquez sur "Créer l'application".
Dans les paramètres de l'application, vous pouvez configurer divers détails tels que le nom de l'application, l'icône et la description. Assurez-vous de remplir avec précision les informations nécessaires.
Une fois que vous avez configuré votre application, accédez à la section "Installer l'application". Cliquez sur le bouton "Installer l'application dans l'espace de travail" pour ajouter le bot à votre espace de travail Slack. Cette étape générera un jeton d'accès OAuth que vous devrez utiliser pour authentifier votre bot.
Pour ajouter la portée des jetons utilisateur, accédez à la section "OAuth & Permissions" dans les paramètres de votre application. Dans la section "OAuth Tokens for Your Workspace", vous devrez ajouter app_mentions:read , channels:history , chat:write , chat:write.public , groups:history , im:history , mpim:history , mpim:read , mpim:write , users:read Scopes. Créez le jeton et enregistrez-le en SLACK_BOT_TOKEN dans votre fichier .env .
Créez un jeton de niveau d'application avec la connection:write la portée. Enregistrez ce jeton en tant que SLACK_APP_TOKEN dans votre fichier .env .
Assurez-vous d'enregistrer toutes les modifications que vous avez apportées aux paramètres de votre application et d'installer / réinstaller le bot sur le lieu de travail.

Étapes pour créer Discord Bot

Afin de connecter votre bot Ragtime à votre serveur Discord, suivez ces étapes:

Accédez à la page Discord Developer Portal Applications et créez une nouvelle application en cliquant sur le bouton «Nouvelle application» dans le coin supérieur droit.
Accédez à la page «Bot» en sélectionnant l'option «Bot» dans la colonne de gauche.
Copiez le jeton fourni et enregistrez-le sous DISCORD_BOT_TOKEN .
Choisissez 'OAuth2' dans la colonne de gauche et sélectionnez le générateur d'URL.
Dans la section «Autorisations de bot» en bas, sélectionnez les autorisations nécessaires.
Choisissez l'option «bot» dans la case «Scope» et la case «Permissions de bot» apparaîtra en dessous.
Sélectionnez «Read Message», «Envoyer un message» et «Gérer le message».
Copiez l'URL générée et collez-le dans votre navigateur Web. Il vous redirigera vers la page Discord pour ajouter le bot à votre serveur.

Comment configurer le bot WhatsApp à l'aide de Twilio

Afin de connecter votre bot Whatsapp Ragtime, suivez ces étapes:

Connectez-vous à votre console Twilio.
Accédez au bac à sable WhatsApp.
Configurez le point de terminaison /whatsapp pour la communication.
Copiez le compte SID, Token Auth et WhatsApp Numéro Sandbox dans .env

Auteur

? Vectara

Site Web: https://vectara.com
Twitter: @vectara
Github: @vectara
LinkedIn: @vectara
Discorde: @vectara

? Contributif

Les contributions, les problèmes et les demandes de fonctionnalités sont les bienvenus!
N'hésitez pas à vérifier la page des problèmes. Vous pouvez également jeter un œil au guide de contribution.