Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rakeshkanneeswaran/contextualconnect-pro
ContextualConnect Pro is a web-based application designed for advanced document searching and retrieval. This repository contains the source code for the application, which leverages various natural language processing and machine learning techniques to provide users with the ability to interactively search for information within upload.
https://github.com/rakeshkanneeswaran/contextualconnect-pro
Last synced: 1 day ago
JSON representation
ContextualConnect Pro is a web-based application designed for advanced document searching and retrieval. This repository contains the source code for the application, which leverages various natural language processing and machine learning techniques to provide users with the ability to interactively search for information within upload.
- Host: GitHub
- URL: https://github.com/rakeshkanneeswaran/contextualconnect-pro
- Owner: rakeshkanneeswaran
- Created: 2023-11-08T21:11:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-17T05:09:36.000Z (9 months ago)
- Last Synced: 2024-08-21T16:06:43.951Z (3 months ago)
- Language: Python
- Size: 267 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ContextualConnect-Pro
## Introduction
------------
ContextualConnect Pro is a web-based application designed for advanced document searching and retrieval. This repository contains the source code for the application, which leverages various natural language processing and machine learning techniques to provide users with the ability to interactively search for information within upload.
## How It Works
------------
The application follows these steps to provide responses to your questions:
1. PDF Loading: The app reads multiple PDF documents and extracts their text content.
2. Text Chunking: The extracted text is divided into smaller chunks that can be processed effectively.
3. Language Model: The application utilizes a language model to generate vector representations (embeddings) of the text chunks.
4. Similarity Matching: When you ask a question, the app compares it with the text chunks and identifies the most semantically similar ones.
5. Response Generation: The selected chunks are passed to the language model, which generates a response based on the relevant content of the PDFs.
## Dependencies and Installation
----------------------------
To install the ContextualConnect-Pro App, please follow these steps:
1. Clone the repository to your local machine.
2. Install the required dependencies by running the following command:
```
pip install -r requirements.txt
```
3. Obtain an API key from OpenAI and add it to the `.env` file in the project directory.
```commandline
OPENAI_API_KEY=your_secrit_api_key
```
## Usage
-----
To use the ContextualConnect-Pro App, follow these steps:
1. Ensure that you have installed the required dependencies and added the OpenAI API key to the `.env` file.
2. Run the `main.py` file using the Streamlit CLI. Execute the following command:
```
streamlit run app.py
```
3. The application will launch in your default web browser, displaying the user interface.
4. Load multiple PDF documents into the app by following the provided instructions.
5. Ask questions in natural language about the loaded PDFs using the chat interface.
## Contributing
------------
This repository is intended for educational purposes and does not accept further contributions. Feel free to utilize and enhance the app based on your own requirements.
## Colaborators
------------
Rakesh Kanneeswaran Maravar
Aagam Chhajer
## License
-------
ContextualConnect-Pro App is released under the [MIT License](https://opensource.org/licenses/MIT).