Introducing the Doc-Buddy Project
Overview
Doc-Buddy is an innovative Telegram chatbot designed to revolutionize the way individuals interact with their documents. Powered by the advanced capabilities of GPT and OpenAI, Doc-Buddy allows users to upload PDF and various other document formats. The bot ingests the information and enables users to query it, acting as a quick reference tool that is particularly useful when dealing with substantial quantities of information.
Core Requirements
To bring Doc-Buddy to life, users will need:
- An OpenAI account coupled with an API Key.
- A Pinecone account and an API Key, essential for handling document embeddings.
- Access to an S3-like storage solution for saving files, aiding in the re-indexing process if necessary.
- A Telegram key obtained from BotFather, a tool used to create Telegram bots.
Optional Enhancements
For those who opt not to use the DigitalOcean one-click deploy feature, additional steps are necessary, such as deploying OpenAI's embeddings project separately. This requires setting up an EMBEDDINGS_URL environment variable. Alternatively, deploying via DigitalOcean simplifies this by implementing the necessary components for you. A DigitalOcean account is advised for this purpose.
Getting Started
Embarking on the Doc-Buddy journey is straightforward:
- Create a Telegram Bot: Begin with BotFather to set up a new Telegram bot. A detailed guide is available to aid this process.
- Secure a Pinecone Account: This will serve as the storage space for the document embeddings data.
- Establish S3 Storage: Or any similarly configured storage, crucial for storing uploaded documents for potential re-indexing.
- Deploy the App: Utilize DigitalOcean’s streamlined platform to launch your app efficiently. Substitute default environment variable values with your own during this process.
- Activate and Interact: Once the app activates, it will seamlessly connect to the Telegram API, allowing users to engage with their newly created bot.
Deploying with DigitalOcean
Deploying Doc-Buddy through DigitalOcean is a hassle-free procedure, especially when using their App Platform. After logging into your DigitalOcean account and initiating the app deploy, it's important to adjust the plan settings during the "Review" stage. This ensures that both chat and memory components are optimized for efficient operation without unnecessary cost.
Necessary Environment Variables
Certain environment variables are necessary to fully configure Doc-Buddy:
- AI Model Specification: Default is "gpt-3.5-turbo".
- API Keys: For OpenAI, Pinecone, and storage solutions.
- Pinecone Configuration: Including the environment and index name.
Using Doc-Buddy
Interacting with Doc-Buddy is as simple as uploading a document to the Telegram chat. The bot processes the document and becomes an interactive repository of its contents. This feature is demonstrated via easy document uploads directly through the chat interface.
Customization Options
Doc-Buddy allows for customizable interactions. Users can modify the assistant’s response style by adjusting the prompt in the prompt.md file, tailoring the chatbot’s interaction to better suit personal needs or preferences.
Sponsorship
Doc-Buddy is proudly sponsored by Ellie, your AI Email Assistant, which personalizes communication by learning your writing style.
This sponsorship underlines a shared commitment to AI’s role in enhancing productivity and personalizing user experiences.
The Doc-Buddy project simplifies document management and interaction through cutting-edge AI, resulting in a practical tool for handling information-heavy tasks with ease and efficiency.