10000 GitHub - dianewalls/weaviate-appliance-docs: A Streamlit application that stores and searches appliance related documents (manuals, reviews, FAQs) in Weaviate. Optimized for washing machines, refrigerators, and monitors with metadata driven search
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

A Streamlit application that stores and searches appliance related documents (manuals, reviews, FAQs) in Weaviate. Optimized for washing machines, refrigerators, and monitors with metadata driven search

License

Notifications You must be signed in to change notification settings

dianewalls/weaviate-appliance-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Appliance Document Manager

A Streamlit application that allows users to store and search PDF documents (manuals, reviews, FAQs) for home appliances (washing machines, refrigerators, monitors) using Weaviate as a vector database.

🚀 Features

  • Upload appliance PDFs and extract text automatically.
  • Store metadata (product type, model, brand, document type) in Weaviate.
  • Perform semantic search on stored documents using vectorization.
  • Authentication support with API key.

🛠️ Prerequisites

1️⃣ Install Python

Ensure you have Python 3.8+ installed. You can check your version with:

python --version

If not installed, download it from Python's official website.

2️⃣ Create a Virtual Environment

Run the following commands to set up a virtual environment:

python -m venv venv
source venv/bin/activate  # MacOS/Linux
venv\Scripts\activate    # Windows

3️⃣ Install Dependencies

pip install -r requirements.txt

🏗️ Setup Weaviate

4️⃣ Create a Weaviate Cloud Instance (WCD)

  1. Go to Weaviate Cloud Console.
  2. Sign up and create a free sandbox instance.
  3. Copy the Weaviate URL and API Key from the instance details.

More details: Weaviate Documentation

Alternatively, you can run Weaviate locally using Docker:

docker run -d --name weaviate -p 8080:8080 semitechnologies/weaviate:latest \
  --env OPENAI_APIKEY=your_openai_key

More on Weaviate Docker setup: Weaviate Quickstart

5️⃣ Configure Environment Variables

Copy the provided .env.sample file and rename it to .env:

cp .env.sample .env

Then, update the .env file with your Weaviate URL and API key.


🔧 Running the Application

6️⃣ Start the Streamlit App

Once everything is set up, run:

source venv/bin/activate 
streamlit run app.py

This will launch the application in your browser.


🔍 Searching Documents

  • Enter a search query to find relevant documents based on semantic similarity.
  • Results include document type, product details, and a preview of the text.

🛑 Stopping the Application

To stop the app, press CTRL + C in the terminal. To deactivate the virtual environment, run:

deactivate

📌 Future Enhancements

  • 🔥 Improve document classification using AI.
  • 📂 Support for more file types.
  • 📊 Visualization of stored documents.

📜 License

This project is licensed under the MIT License.


🙌 Contributions

Pull requests are welcome! Open an issue for feature requests or bugs.

🔗 Useful Links

Happy Coding! 🚀

About

A Streamlit application that stores and searches appliance related documents (manuals, reviews, FAQs) in Weaviate. Optimized for washing machines, refrigerators, and monitors with metadata driven search

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

0