Giter Club home page Giter Club logo

youtubot's Introduction

YouTube Summarizer Telegram Bot

Project link

Overview

This Telegram bot utilizes Large Language Models (LLM) for summarizing and answering questions about YouTube videos. It provides users with concise summaries and responses based on the content of the videos.

Features

  • Summarize YouTube videos: The bot can generate brief summaries of YouTube videos.
  • Answer questions: Users can ask questions about the video content, and the bot will attempt to provide relevant answers.
  • Telegram integration: The bot is integrated with Telegram messenger, allowing users to interact with it seamlessly.

Deployment

The application is deployed using Docker Compose, with two containers for Redis and Python.

Prerequisites

  • Docker
  • Docker Compose

Deployment Steps

  1. Install Git and Docker Compose
sudo apt install git docker-compose
  1. Add current user to Docker group
sudo usermod $(whoami) -a -G docker
  1. Clone the current repository
git clone https://github.com/stepvg/youtubot.git
  1. Navigate to the project directory:
cd youtubot/
  1. Add a Telegram token and change the necessary parameters in the .env file.
editor .env
  1. Run containers
docker-compose up -d --build
  1. The bot should now be running and accessible via Telegram.

Usage

  1. Start a conversation with the bot on Telegram.
  2. Send a YouTube video link to the bot.
  3. Optionally, ask questions about the video content.
  4. The bot will respond with a summary or answers based on the provided video.

Configuration

The bot's behavior and settings can be configured via environment variables or a .env file. The following variables are available:

  • HUGGING_FACE_EMBEDDINGS: The name of the embeddings model, which can be obtained from the huggingface.
  • TELEGRAM_BOT_TOKEN: Telegram bot token obtained from BotFather.
  • GIGACHAT_CREDENTIALS: API key for accessing the GigaChat Large Language Model service.
  • REDIS_HOST: Hostname for the Redis container.
  • REDIS_PORT: Port for accessing the Redis container.
  • REDIS_PASSWORD: Password for accessing the Redis container.

Contributing

Contributions to the project are welcome! Please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the MIT License.

Source code

  • Docker Compose file describes the Redis server and the bot application.
  • Python file contains the entry point to the bot application.
  • Dockerfile describes the Docker image that is used to run the bot application.

youtubot's People

Contributors

stepvg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.