QueryGPT

QueryGPT: Your Personalized Q&A Chatbot with NodeJS & OpenAI

What is QueryGPT?

QueryGPT is an open-source project that allows you to create a question-answering chatbot powered by NodeJS and OpenAI's GPT models. It enables the chatbot to learn from a knowledge base you provide, offering precise answers grounded in your data and OpenAI's training data. This makes it ideal for handling tech documentation, scientific papers, business product data, and more.

How does QueryGPT work?

QueryGPT leverages embeddings and completion models to provide accurate responses. Here's a breakdown of the process:

1. Data Preparation: The project works seamlessly with text files, eliminating the need for JSON/JSONL conversion. Split your data into smaller paragraphs for optimal embedding.
2. Embedding: The text paragraphs are converted into numerical vector representations using OpenAI's embedding models. These vectors capture the semantic meaning of the text.
3. Question Embedding: The user's question is also converted into an embedding vector.
4. Similarity Search: The system calculates the similarity between the question's embedding vector and the embedding vectors of each paragraph in your knowledge base using a dot product.
5. Context Retrieval: The paragraphs with the highest similarity scores (typically 3-5) are selected as the context for answering the question.
6. Completion: The selected paragraphs and the user's question are fed into OpenAI's completion model (e.g., text-davinci-003), along with a carefully crafted prompt.
7. Response Generation: The completion model generates an answer based on the provided context and its pre-existing knowledge.

Key Features & Benefits:

• Personalized Knowledge Base: Train your chatbot on your specific data for accurate and relevant answers.
• No Python Required: Built with NodeJS, eliminating the need for Python knowledge.
• Text File Support: Works directly with text files, simplifying data input.
• Embedding-Based Accuracy: Utilizes embeddings for semantic understanding and precise context retrieval.
• Customizable Prompts: Choose prompts that either prioritize answers from your knowledge base or allow the model to use its own knowledge when necessary.

How to use QueryGPT?

1. Prerequisites:

   • NodeJS
   • Basic Javascript knowledge
   • OpenAI API key

2. Setup:

   • Create a NodeJS project: mkdir QueryGPT && cd QueryGPT && npm init -y
   • Install dependencies: npm install @types/node dotenv openai
   • Create necessary folders: mkdir sourceData embeddedData utils
   • Create a .env file and add your OpenAI API key: OPENAI_API_KEY = YOUR_API_KEY

3. Configuration:

   • Create a utils/helper.js file to configure the OpenAI API.

4. Embedding Data:

   • Prepare your data by splitting it into small paragraphs and save it in ./embeddedData/sourceData.txt.
   • Run the embedding.js file to generate embeddings: node embedding.js

5. Generating Responses:

   • Run the completion.js file with your question: node completion.js generateCompletion("Who is acting dean of the Faculty of Business Studies");

Who is QueryGPT for?

QueryGPT is ideal for:

• Businesses: Create chatbots for product documentation and customer support.
• Researchers: Build tools for analyzing scientific papers and research data.
• Educators: Develop interactive learning resources based on course materials.
• Anyone who wants a personalized AI assistant that learns from their own data.

Why choose QueryGPT?

• Control over Data: You have complete control over the knowledge base used by the chatbot.
• Accuracy: Embeddings ensure semantic understanding and precise context retrieval.
• Customization: Adapt the chatbot to your specific needs with customizable prompts.
• Open Source: Free to use and modify.

QueryGPT offers a powerful and flexible way to build AI-powered Q&A systems. By combining the power of NodeJS and OpenAI, you can create intelligent chatbots that provide accurate and personalized answers from your own data.