readme.md

Телеграм-бот на базе GPT

Телеграм-бот анализирует ваш сайт и отвечает на вопросы по его содержимому.

Стек

• Node.js
• Langchain
• Pinecone
• OpenAI GPT
• Telegraf
• Crawlee
• TypeScript
• ESLint

Обязательные требования

Для запуска проекта необходимы:

• Node.js 18+
• npm 9+

и аккаунты в следующих сервисах:

• Telegram
• Pinecone
• OpenAI

Быстрый старт

1. Создайте телеграм-бота через @BotFather

2. Создайте .env файл, скопируйте туда значения из файла .env.example и заполните их соответсвующими значениями.

   cp .env.example. .env
   

3. Выполните следующие команды

   npm install
   npm start
   

4. Откройте в телеграм вашего бота и выполните команду /start

5. Введите адрес веб-сайта, который необходимо проиндексировать

6. Дождитесь сообщения об успешной индексации

7. Задайте вопрос боту

Как это работает

1. Бот принимает на вход адрес веб-сайта и индексирует его

2. На базе полученных данных строится индекс в Pinecone

3. Бот получает вопрос пользователя и строит ответ при помощи модели gpt-3.5-turbo в соответствии с заданным промптом.

Создание индекса в Pinecone

1. Зарегистрируйтесь в Pinecone. Рекомендуем воспользоваться входом через Github.
2. Создайте организацию.
3. Создайте индекс со следующими параметрами:
   • Dimensions: 1536
   • Metric: cosine
   • Pod type: Starter

4. Для получения API ключа PINECONE_API_KEY и окружения PINECONE_ENVIRONMENT, зайдите в Pinecone и нажмите API Keys. Здесь вы увидите ваш API ключ и название вашего окружения.

Переменные окружения

Бот работает автоматически подгружает переменные окружения из .env файла.

Реальные сценарии использования

• Wikibot
• Помощник по Excel от Wikibot