​

Examples

This section contains practical examples and demonstrations of using Quivr in various scenarios. Each example is designed to showcase different capabilities and integration possibilities.

​

Core Examples

​

Chatbot Applications

1. Chainlit Chatbot

   • Create an interactive chatbot using Quivr and Chainlit
   • Upload and process text files up to 20MB
   • Real-time question answering based on document content
   • Easy setup with Rye package manager
   • View source code

2. Voice-Enabled Assistant

   • Build a voice interface using OpenAI’s Whisper model
   • Features audio input and speech synthesis
   • Flask-based web application
   • Complete audio processing pipeline
   • View implementation

​

RAG Workflows

1. Basic RAG Implementation

   • Simple retrieval-augmented generation setup
   • Configurable via YAML
   • Step-by-step implementation guide
   • Perfect for getting started with RAG

2. Advanced RAG with Web Search

   • Includes web search capabilities
   • Dynamic chunk retrieval
   • User intention detection
   • Advanced routing and tool integration

​

Additional Examples

Find more examples in our GitHub repository:

​

Document Processing

• PDF Document Handling
  • Process and analyze PDF files
  • Extract structured information
  • Handle complex document layouts

​

Voice Integration

• Quivr-Whisper Integration
  • Speech-to-text processing
  • Voice command handling
  • Audio response synthesis

​

Storage Solutions

• Custom Storage Implementation
  • Build custom storage backends
  • Integrate with different databases
  • Optimize for specific use cases

​

Simple Applications

• Question Processing Demo
  • Basic Q&A implementation
  • Document chunking examples
  • Memory management patterns

Each example includes:

• Detailed setup instructions
• Code snippets and explanations
• Configuration examples
• Best practices and tips

​

Getting Started

To run any of these examples:

1. Clone the repository:

   Copy

   git clone https://github.com/QuivrHQ/quivr.git
   cd quivr/examples/<example-name>
   

2. Follow the specific README instructions in each example directory

3. Make sure to set up your environment variables (API keys, etc.) as specified in the example documentation

For more detailed workflows and configurations, check out our Workflows section.