Vineetiitg commited on
Commit
7aad172
·
0 Parent(s):

init: scaffold support docs copilot backend and project structure

Browse files
.gitignore ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ venv/
2
+ .venv/
3
+ __pycache__/
4
+ *.py[cod]
5
+ .pytest_cache/
6
+ .ragas_cache/
7
+ qdrant_data/
8
+ .env
9
+ .env.*
10
+ !.env.example
11
+ .python/
12
+ *.log
13
+ *.err.log
14
+ frontend.log
15
+ backend.log
16
+ fastembed_cache/
17
+ .cache/
18
+ model files
19
+ Hugging Face cache
20
+ Ollama models
21
+
README.md ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Support Docs Copilot
2
+
3
+ Python-only advanced RAG support copilot using Ollama, Qdrant hybrid retrieval, local reranking, LangGraph Self-RAG, Guardrails AI, Ragas evaluation, FastAPI, and Streamlit.
4
+
5
+ ## Quick Start
6
+
7
+ 1. Start Ollama and pull the model:
8
+
9
+ ```bash
10
+ ollama run llama3
11
+ ```
12
+
13
+ 2. Create and activate a virtual environment:
14
+
15
+ ```bash
16
+ python -m venv venv
17
+ venv\Scripts\activate
18
+ pip install -r requirements.txt
19
+ ```
20
+
21
+ 3. Ingest the sample docs:
22
+
23
+ ```bash
24
+ python app/engine/ingestion.py
25
+ ```
26
+
27
+ 4. Start the backend:
28
+
29
+ ```bash
30
+ uvicorn app.main:app --reload
31
+ ```
32
+
33
+ 5. Start the UI in another terminal:
34
+
35
+ ```bash
36
+ streamlit run ui/app.py
37
+ ```
38
+
39
+ Backend docs run at `http://127.0.0.1:8000/docs`; the Streamlit app runs at `http://localhost:8501`.
40
+
41
+ ## Docker
42
+
43
+ ```bash
44
+ docker-compose up --build -d
45
+ docker exec -it $(docker-compose ps -q ollama) ollama run llama3
46
+ docker exec -it $(docker-compose ps -q backend) python app/engine/ingestion.py
47
+ ```
48
+
49
+ ## Suggested Commit Roadmap
50
+
51
+ 1. `init: setup fastapi boilerplate and environment config for ollama and qdrant`
52
+ 2. `feat: implement hybrid search ingestion pipeline with qdrant and fastembed`
53
+ 3. `feat: integrate cross-encoder reranking for context refinement`
54
+ 4. `feat: build self-rag decision graph with evaluation nodes`
55
+ 5. `feat: add input validation and output verification guardrails`
56
+ 6. `test: implement automated ragas evaluation pipeline`
57
+ 7. `feat: complete streamlit chat interface and integrate backend streaming api`
58
+ 8. `deploy: containerize complete architecture with docker compose for production`
59
+
data/docs/product_guide.txt ADDED
@@ -0,0 +1 @@
 
 
1
+ An AI engineer is a specialized software professional who bridges the gap between theoretical data science and functional, real-world applications. Rather than focusing entirely on foundational model research or training algorithms from scratch, these engineers utilize pre-trained models—such as Large Language Models (LLMs) and neural networks—to build scalable, intelligent software. Their core responsibility involves creating production-ready systems, which means connecting AI capabilities to APIs, databases, user interfaces, and external tools. This highly technical role demands a strong foundation in software engineering, cloud platforms, and data management. They actively design Retrieval-Augmented Generation (RAG) pipelines, build AI agents, and implement monitoring and deployment frameworks (like Docker) to ensure models function reliably at scale. Across industries ranging from healthcare and finance to manufacturing and autonomous driving, AI engineers are essential for transforming theoretical machine learning models into robust, efficient, and user-centric products that solve complex business problems.
data/docs/sample_error.txt ADDED
@@ -0,0 +1 @@
 
 
1
+ Error Code 404: The requested server resource was not found. Check the network router configuration in section 3.