Тряпное время
Раг с открытым исходным кодом для Slack и Discord с использованием Vectara. С помощью этого бота вы можете создать бот Slack или Discord, который подключен к вашему серверу, и отвечает на вопросы пользователя, запрашивая корпус Vectara.
Использование
- Укажите бота в сообщении, чтобы получить ответ.
- Отправьте прямое сообщение боту для разговора 1: 1.
- BOT хранит сообщение и идентификаторы потоков для предоставления ответов на контекст в потоках или во время ответа.
Пример команд
- Упомяните бот:
@bot-name Your message here - Отправить прямое сообщение:
Your message here
Установка
Предварительные условия
Настраивать
- Клонировать репозиторий:
git clone https://github.com/vectara/ragtime.git
cd ragtime
- Установите требуемые зависимости:
pip3 install requirement.txt
- Настройка переменных среды:
- Создайте файл
.env в корне вашего проекта и добавьте следующее:
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>
Чтобы включить агентскую тряпку добавить следующие переменные.
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'
VECTARA_CUSTOMER_ID и VECTARA_CORPUS_IDS указывают на вашу учетную запись Vectara и соответствующие корпусы для использования.-
VECTARA_CORPUS_IDS может быть единственным идентификатором корпуса (цифровой) или отдельным списком корпораций.
Бегущие боты тряпки
Ragtime поддерживает Slack Bot, Discord Bot и WhatsApp Bot. Вы можете запустить один из них, или все.
Как запустить его на местном уровне
Запустите приложение с помощью Docker
Стройте и бегите с Docker.
Шаги по созданию Slack Bot
В Orer, чтобы подключить свой бот Ragtime к вашему обслуживанию Slack, выполните следующие действия:
- Войдите в свое рабочее пространство Slack и перейдите на сайт Slack API. Нажмите на «Ваши приложения», а затем «Создайте новое приложение». Укажите имя для вашего приложения, выберите рабочее пространство, где вы хотите его установить, и нажмите «Создать приложение».
- В настройках приложения вы можете настроить различные детали, такие как имя приложения, значок и описание. Обязательно заполните необходимую информацию точно.
- После того, как вы настроили свое приложение, перейдите в раздел «Установка приложения». Нажмите кнопку «Установить приложение в рабочее пространство», чтобы добавить бот в свое рабочее пространство. Этот шаг генерирует токен доступа OAuth, который вам понадобится для аутентификации вашего бота.
- Чтобы добавить область пользовательского токена, перейдите в раздел «OAuth & разрешения» в настройках вашего приложения. В разделе «Токены OAuth для вашего рабочего пространства» вам нужно добавить
app_mentions:read , channels:history im:history groups:history chat:write mpim:history mpim:read chat:write.public users:read mpim:write Создайте токен и сохраните его как SLACK_BOT_TOKEN в вашем файле .env . - Создайте токен на уровне приложения с помощью
connection:write область применения. Сохраните этот токен как SLACK_APP_TOKEN в вашем файле .env . - Обязательно сохраните любые изменения, которые вы внесли в настройки вашего приложения и установите/переустановите бот на рабочем месте.
Шаги по созданию бота Discord
Чтобы подключить свой бот Ragtime к вашему серверу Discord, выполните следующие действия:
- Перейдите на страницу приложений Discord Developer Portal и создайте новое приложение, нажав кнопку «Новое приложение» в верхнем правом углу.
- Перейдите на страницу «Бот», выбрав опцию «Бот» из левого столбца.
- Скопируйте предоставленный токен и сохраните его в качестве
DISCORD_BOT_TOKEN . - Выберите «OAuth2» из левого столбца и выберите генератор URL.
- В разделе «Разрешения бота» внизу выберите необходимые разрешения.
- Выберите опцию «BOT» в поле «Область», а под ним появится поле «Разрешения бота».
- Выберите «Читать сообщение», «Отправить сообщение» и «Управление сообщением».
- Скопируйте сгенерированный URL и вставьте его в свой веб -браузер. Он перенаправляет вас на страницу Discord, чтобы добавить бот на ваш сервер.
Как настроить WhatsApp Bot с помощью Twilio
Чтобы подключить свой бот в Ragtime WhatsApp, выполните следующие действия:
- Войдите в свою консоль Twilio.
- Перейдите к песочнице WhatsApp.
- Настройте конечную точку
/whatsapp для связи. - Скопируйте учетную запись SID, Auth Token и WhatsApp Sandbox в
.env
Автор
? Vectara
- Веб -сайт: https://vectara.com
- Твиттер: @Vectara
- GitHub: @Vectara
- LinkedIn: @Vectara
- Discord: @Vectara
? Внося
Взносы, проблемы и запросы на функции приветствуются!
Не стесняйтесь проверять страницу проблем. Вы также можете взглянуть на руководство.
Покажите свою поддержку
Дайте ️, если этот проект помог вам!
Лицензия
Copyright © 2024 Vectara.
Этот проект лицензирован Apache 2.0.