Skip to content

cyw233/vacuum-robot-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vacuum Robot Guide

A Streamlit chat assistant for vacuum robot buying advice, maintenance guidance, troubleshooting, and generated usage reports. The app combines a LangChain agent with a Chroma-backed RAG knowledge base and a small sample usage dataset.

What It Includes

  • Streamlit chat UI in app.py
  • LangChain agent and tool middleware in agent/
  • RAG retrieval and Chroma vector store setup in rag/
  • Knowledge source files in data/
  • Prompt templates in prompts/
  • YAML configuration in config/

Requirements

  • Python 3.12+
  • uv
  • An OpenAI-compatible API key for the configured chat and embedding models

The model names are configured in config/rag.yaml. Set the API key and base URL for your OpenAI-compatible endpoint before running the app:

export OPENAI_API_KEY="your-api-key"
export OPENAI_BASE_URL="https://your-resource.openai.azure.com/openai/v1/"

Setup

uv sync

Build or refresh the local vector store:

uv run python rag/vector_store.py

Run the Streamlit app:

uv run streamlit run app.py

Tests

uv run python -m unittest discover -s tests

Plain unittest discovery also works:

uv run python -m unittest

Runtime Files

Local runtime artifacts are intentionally ignored by git:

  • chroma_db/
  • logs/
  • md5.txt
  • Python cache files

About

AI assistant for vacuum robot buying advice, maintenance guidance, troubleshooting

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages