Download do ragtime - Download do código fonte ragtime

ragtime

Código-Fonte de IA

1.0.0

Baixar

Ragtime

Um bot de faixa de código aberto para folga e discórdia usando Vectara. Com este bot, você pode criar um Bot Slack ou Discord que está conectado ao seu servidor e responda às perguntas do usuário, consultando um corpus Vectara.

Uso

Mencione o bot em uma mensagem para receber uma resposta.
Envie uma mensagem direta ao bot para uma conversa 1: 1.
O BOT armazena IDs de mensagem e encadeamento para fornecer respostas com reconhecimento de contexto em threads ou ao responder.

Comandos de exemplo

Mencione o bot: @bot-name Your message here
Envie uma mensagem direta: Your message here

Instalação

Pré -requisitos

Python 3.8 ou superior

Configurar

Clone o repositório:

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

Instale as dependências necessárias:
```
 pip3 install requirement.txt
```

Configurar variáveis de ambiente:

Crie um arquivo .env na raiz do seu projeto e adicione o seguinte:

 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>

Para habilitar o RAG Agentic, adicione as seguintes variáveis.

 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'

O VECTARA_CUSTOMER_ID e VECTARA_CORPUS_IDS apontam para sua conta Vectara e corpora relevante para usar.
VECTARA_CORPUS_IDS pode ser um único ID de corpus (numérico) ou uma lista de corpora separada por vírgula.

Executando os bots Ragtime

O Ragtime suporta Slack Bot, Discord Bot e Whatsapp Bot. Você pode executar um desses, ou tudo.

Como executá -lo localmente

Executando os dois bots
```
python3 main.py
```
Correndo apenas Bot Slack
```
python3 main.py slack
```
Executando apenas o Bot Discord
```
python3 main.py discord
```
Executando apenas o BOT do WhatsApp
```
python3 main.py whatsapp
```

Execute o aplicativo usando o Docker

Construa e corra com o Docker.

Executando os dois bots
```
bash run_docker.sh
```
Correndo apenas Bot Slack
```
bash run_docker.sh slack
```
Executando apenas o Bot Discord
```
bash run_docker.sh discord
```
Executando apenas o BOT do WhatsApp
```
bash run_docker.sh whatsapp
```

Etapas para criar Bot Slack

Em ORER, para conectar seu bot Ragtime ao seu serviço de folga, siga estas etapas:

Faça login no seu espaço de trabalho Slack e navegue para o site da Slack API. Clique em "Seus aplicativos" e depois "crie um novo aplicativo". Forneça um nome para o seu aplicativo, selecione o espaço de trabalho onde deseja instalá -lo e clique em "Criar aplicativo".
Nas configurações do aplicativo, você pode definir vários detalhes, como o nome do aplicativo, o ícone e a descrição. Certifique -se de preencher as informações necessárias com precisão.
Depois de configurar seu aplicativo, navegue para a seção "Instalar aplicativo". Clique no botão "Instale o aplicativo para a área de trabalho" para adicionar o bot à sua área de trabalho Slack. Esta etapa gerará um token de acesso OAuth que você precisará usar para autenticar seu bot.
Para adicionar o escopo do token do usuário, navegue para a seção "OAuth & Permissions" nas configurações do seu aplicativo. Sob a seção "OAuth Tokens para o seu espaço de trabalho", você precisará adicionar app_mentions:read , channels:history , chat:write , chat:write.public , groups:history , im:history , mpim:history , mpim:read , mpim:write , users:read escopos. Crie o token e salve -o como SLACK_BOT_TOKEN no seu arquivo .env .
Crie um token de nível de aplicativo com a connection:write o escopo. Salve este token como SLACK_APP_TOKEN no seu arquivo .env .
Certifique -se de salvar as alterações que você fez nas configurações do seu aplicativo e instale/reinstale o bot no local de trabalho.

Etapas para criar Bot Discord

Para conectar seu bot ragtime ao seu servidor Discord, siga estas etapas:

Navegue para a página Aplicativos do Portal de Desenvolvedores da Discord e crie um novo aplicativo clicando no botão 'Novo aplicativo' no canto superior direito.
Vá para a página 'Bot' selecionando a opção 'Bot' na coluna esquerda.
Copie o token fornecido e salve -o como DISCORD_BOT_TOKEN .
Escolha 'OAuth2' na coluna esquerda e selecione o gerador de URL.
Na seção 'Permissões de bot' na parte inferior, selecione as permissões necessárias.
Escolha a opção 'Bot' na caixa 'Scope' e a caixa 'Permissões de bot' aparecerá abaixo dela.
Selecione as opções 'Leia a mensagem', 'Enviar mensagem' e 'Gerenciar a mensagem'.
Copie o URL gerado e cole -o no seu navegador da web. Ele o redirecionará para a página Discord para adicionar o bot ao seu servidor.

Como configurar o Bot WhatsApp usando o Twilio

Para conectar seu bot ragtime whatsapp, siga estas etapas:

Faça login no seu console do Twilio.
Navegue até a caixa de areia do WhatsApp.
Configure o ponto final /whatsapp para comunicação.
Copie o número da conta Sid, Auth Token e WhatsApp Sandbox para .env

Autor

? Vectara

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

? Contribuindo

Contribuições, questões e solicitações de recursos são bem -vindos!
Sinta -se à vontade para verificar a página de problemas. Você também pode dar uma olhada no guia contribuinte.