Giter Club home page Giter Club logo

veedaisme / askyournotes Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 0.0 336 KB

๐Ÿ“š askYourNotes: A Telegram bot for seamless note-taking and retrieval, powered by MongoDB Atlas for efficient storage and OpenAI's language model for intelligent search. Store, search, and get personalized insights from your notes effortlessly. Explore the future of note-taking via chat! ๐Ÿš€ ---- created by ChatGPT

JavaScript 1.54% TypeScript 98.21% Shell 0.19% Nix 0.06%
llm mongodb-atlas openai telegram-bot

askyournotes's Introduction

askYourNotes

askYourNotes is a Telegram bot designed to streamline note-taking and retrieval. It leverages MongoDB Atlas Search as a vector database for efficient storage and retrieval of notes, and it integrates OpenAI's powerful LLM to enhance search capabilities, providing a more intelligent and personalized assistant experience.

Note:

  • You can easily replace OpenAI with other LLM processors such as Hugging Face, Ollama, etc., based on your preferences.
  • You can easily replace the vector DB as a source of your data

Features

  • Store and Search through your notes using keywords or phrases to find the information you need quickly.
  • Leverage LLM (Large Language Model) capabilities to deliver more than just simple search results. It understands the context of your queries and provides insightful responses.

Tech Stack

  • bun (package installer) -- experiment
  • node 18.12.1 strict
  • vector db: MongoDB atlas (or chroma db)
  • LLM: openai API (or hugging face infer or ollama)

Installation

To install and run askVeedaBot on your local machine, follow these steps:

  1. Clone the repository:
git clone https://github.com/iqbaaaaalf/askYourNotes.git
  1. Install the required dependencies:
cd askVeedaBot
bun install
  1. Configure the bot:

Create a new Telegram bot and obtain the API token.

OpenAI API key is required since we are using the embedding function text-embedding-ada-002 of openAI

export OPENAI_KEY=your_openai_api_key
export TELEGRAM_TOKEN=your_telegram_bot_token
export MONGO_USER=your_mongodb_user
export MONGO_PASSWORD=your_mongodb_password

  1. Start the bot:
npm start:notes

Additional notes

  1. Two Projects in One: This repository consists of two projects, AskYourNotes and Tanya Jago Bot (deprecated).
  2. Learning and Exploration: The primary purpose of this repository is as a learning project, exploring the concept of note-taking via chat. The idea is to adapt to the common practice of storing information in chat interfaces.

askyournotes's People

Contributors

veedaisme avatar

Stargazers

 avatar Fadillah Hadiyanto avatar Ichroman Raditya Duwila avatar

Watchers

 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.