Add integration with Chat-GPT APIs.

Author: Muawiya-contact

SearchEngine/.gitignore

@@ -0,0 +1 @@
+.env

SearchEngine/README.md

@@ -1,10 +1,11 @@
-# 🔍 Mini Search Engine with Stack  
+# 🔍 Mini Search Engine with Stack 
 
 A **Mini Search Engine project** developed as part of my **2nd Semester DSA Lab Project (BS AI, NFC IET Multan)**.  
 It demonstrates **core Data Structures and Algorithms (DSA)** concepts such as:  
 - **Stack** (for search history navigation)  
 - **Inverted Index / Hash Map** (for efficient keyword-based searching)  
 - **String processing & searching algorithms**  
+- **GPT Integration** → fallback when no local documents match  
 
 ---
 
@@ -15,6 +16,7 @@ It demonstrates **core Data Structures and Algorithms (DSA)** concepts such as:
 - ✅ **Search History (REDO)** → supports `next` command just like a browser  
 - ✅ **Document Viewer** → open `.txt` files directly from search results  
 - ✅ **Automatic Crawler** → indexes all `.txt` files in the `documents/` folder  
+- ✅ **GPT Fallback** → uses OpenAI GPT-3.5-Turbo when no local results found, saves responses in `gpt_docs/gpt.txt`  
 - ✅ **Clean modular structure** for GitHub  
 
 ---
@@ -25,34 +27,51 @@ Mini-Search-Engine/
 │
 ├── stack.py          # Stack implementation (push, pop, peek, empty)
 ├── index.py          # Inverted Index implementation
-├── search.py         # Search Engine logic
+├── search.py         # Search Engine logic + GPT integration
 ├── main.py           # Entry point for running the project
 │
 ├── documents/        # Folder containing sample text files
 │   ├── doc1.txt
 │   ├── doc2.txt
 │   └── ...
 │
+├── gpt_docs/         # Folder storing GPT responses
+│   └── gpt.txt
+│
+├── .env              # Stores OPENAI_API_KEY
+├── requirements.txt  # Required Python packages
 └── README.md         # Project documentation
 ```
-## ⚡ How It Works
-- The program scans the `documents/` folder and builds an **inverted index**.  
-- When the user searches, queries are **cleaned** (lowercased, punctuation removed, split into words).  
-- Matching documents are **ranked by query word frequency**.  
-- The query is **pushed onto the Stack (history)**.  
-- If the user types **back**, the last query is **popped** and the previous one is shown again.  
-- The user can open a result to see the **full content of the file**.  
+### ⚡ How It Works
 
----
++ The program scans the `documents/` folder and builds an inverted index.
+
++ When the user searches, queries are cleaned (lowercased, punctuation removed, split into words).
+
++ Matching documents are ranked by query word frequency.
+
++ The query is pushed onto the Stack (history).
+
++ If the user types `back`, the last query is popped and the previous one is shown again.
+
++ If no local document matches, the engine calls GPT, saves the result in `gpt_docs/gpt.txt`, indexes it, and shows it.
+
++ Users can open a result to see the full content of the file.
 
 ## ▶️ Usage
 
-### Run the program:
-```bash
+1. Go to base Dir:
+```batch
+cd SearchEngine
+```
+2. Run 
+```batch
 python main.py
 ```
-### Example Session:
-```Loading index...
+
+***Example Session:***
+```py
+Loading index...
 Index built with 5 documents.
 
 Enter search query, 'back','next', 'show', or 'quit': ai
@@ -68,10 +87,16 @@ Enter search query, 'back','next', 'show', or 'quit': cs
 [Stack] Pushed: cs
 
 Searching for: 'cs'
-Found 1 document(s):
-1. doc2.txt | Score: 1
+No matches found in local documents. Using ChatGPT...
+--- GPT Answer ---
+CS is the study of computers and computational systems...
+------------------
+1. gpt.txt | Score: 1
 
-Enter document number to open, or 'continue': continue
+Enter document number to open, or 'continue': 1
+--- gpt.txt ---
+CS is the study of computers and computational systems...
+------------------
 
 Enter search query, 'back','next', 'show', or 'quit': back
 [Stack] Popped: cs
@@ -80,41 +105,42 @@ Enter search query, 'back','next', 'show', or 'quit': back
 Back to: 'ai'
 1. doc5.txt | Score: 2
 
-Enter document number to open, or 'continue': next
-Please enter a valid number or 'continue'.
+Enter search query, 'back','next', 'show', or 'quit': next
+Redo: 'cs'
+1. gpt.txt | Score: 1
 
 Enter document number to open, or 'continue': continue
 Enter search query, 'back','next', 'show', or 'quit': quit
 Goodbye!
 ```
----
+
 ## 🏫 Academic Info
 
-+ 📖 Course: Data Structures & Algorithms (DSA)
+📖 Course: Data Structures & Algorithms (DSA)
 
-+ 🎓 Semester: 2nd Semester, BS Artificial Intelligence
+🎓 Semester: 2nd Semester, BS Artificial Intelligence
 
-+ 🏛️ University: NFC IET Multan
+🏛️ University: NFC IET Multan
 
-+ 👨‍💻 Student: Muawiya Amir
+👨‍💻 Student: Muawiya Amir
 
-----
-### 👥 Team Members
+---
+## 👥 Team Members
 
-+ 👨‍💻 Muawiya (Team Leader)
+👨‍💻 Muawiya (Team Leader)
 
-+ 👨‍💻 M. Umar
+👨‍💻 M. Umar
 
 ---
 
-### 🚀 Future Improvements
+## 🚀 Future Improvements
 
-> + Add ***synonym & fuzzy*** matching for queries 
+> Add synonym & fuzzy matching for queries
 
-> + Implement ***OR / NOT*** search operators
+> Implement OR / NOT search operators
 
-> + Enhance ranking with ***TF-IDF instead*** of simple counts
+> Enhance ranking with TF-IDF instead of simple    counts
 
-> + Build a ***GUI or Web-based*** interface
+> Build a GUI or Web-based interface
 
-------
+> Maintain multiple GPT files (gpt_1.txt, gpt_2.txt, ...) to fully integrate undo/redo

SearchEngine/__pycache__/search.cpython-312.pyc

@@ -0,0 +1 @@
+AI, or artificial intelligence, is the simulation of human intelligence processes by machines, especially computer systems. It encompasses activities such as learning, reasoning, problem-solving, perception, and language understanding. AI technologies are used in a wide range of applications, from virtual assistants like Siri and Alexa to self-driving cars and advanced medical diagnostics.

SearchEngine/gpt_docs/gpt_1.txt

@@ -0,0 +1 @@
+Islam is a monotheistic religion founded by the Prophet Muhammad in the 7th century in the Arabian Peninsula. It is based on the belief in one god, Allah, and the teachings of the Quran, which is considered the holy book of Islam. Followers of Islam are called Muslims and they follow the Five Pillars of Islam, which are the declaration of faith, prayer, fasting during the month of Ramadan, giving to charity, and making pilgrimage to Mecca at least once in a lifetime if possible. Islam is the second largest religion in the world, with over 1.8 billion followers.

SearchEngine/gpt_docs/gpt_2.txt

@@ -0,0 +1,13 @@
+openai>=1.0.0
+python-dotenv>=1.0.0
+# Python version
+python>=3.12
+# Core libraries
+openai>=1.0.0
+python-dotenv>=1.0.0
+
+# Optional but useful
+rich>=13.0.0        # for pretty console output
+typing-extensions>=4.5.0  # extra type hints if needed
+# Development and testing
+pytest>=7.0.0       # for testing