File size: 2,151 Bytes
0bf8a2d
965ac15
 
0bf8a2d
 
 
965ac15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
0bf8a2d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
---
title: sehatech-demo
app_file: chat_app.py
sdk: gradio
sdk_version: 5.6.0
---
# RAG Voice Boilerplate

A production-ready Python boilerplate for building RAG (Retrieval Augmented Generation) applications with voice processing capabilities.

## πŸš€ Features

- πŸ“š RAG Engine Integration
- 🎀 Voice Processing Pipeline
- πŸ—„οΈ Vector Store Support
- πŸ‹ Docker Containerization
- πŸ§ͺ Testing Infrastructure
- πŸ”§ Modular Architecture

## πŸ—οΈ Project Structure
```
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ __init__.py
β”‚   β”œβ”€β”€ main.py
β”‚   β”œβ”€β”€ config.py
β”‚   β”œβ”€β”€ api/
β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   └── routes.py
β”‚   β”œβ”€β”€ core/
β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”œβ”€β”€ rag_engine.py
β”‚   β”‚   β”œβ”€β”€ voice_processor.py
β”‚   β”‚   └── document_processor.py
β”‚   β”œβ”€β”€ database/
β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”œβ”€β”€ vector_store.py
β”‚   β”‚   └── db.py
β”‚   └── utils/
β”‚       β”œβ”€β”€ __init__.py
β”‚       └── helpers.py
β”œβ”€β”€ tests/
β”‚   └── __init__.py
β”œβ”€β”€ docker/
β”‚   β”œβ”€β”€ Dockerfile
β”‚   └── docker-compose.yml
β”œβ”€β”€ requirements.txt
└── README.md
```

## 🚦 Quick Start


#### Prerequisie

This project is only tested on python3.11
some points to consider:
langchain-pinecone works only between versions python3.8   and python3.13 exclusively 

1. Clone the repository:
```bash
git clone https://github.com/yourusername/rag-voice-boilerplate.git
```

2. Install dependencies:
```bash
pip install -r requirements.txt
```

3. Run with Docker:
```bash
docker-compose up -d
```

## πŸ“š Documentation

### Core Components

- `rag_engine.py`: Handles retrieval augmented generation operations
- `voice_processor.py`: Processes audio input/output
- `document_processor.py`: Manages document parsing and preprocessing
- `vector_store.py`: Manages vector embeddings and similarity search

## 🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.