Skip to content

BotirBakhtiyarov/Filefinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

41 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

AI File Finder v2πŸ“‚

GitHub stars GitHub forks GitHub license Python version Flask License

Smart File Finder & Chat Assistant v2 is a powerful Python-based desktop application designed to streamline file management and information retrieval for Chinese-speaking users. With a sleek, Chinese-localized interface, this tool leverages advanced AI to search, summarize, and interact with documents and images.

Built with customtkinter for a modern GUI and Flask for a robust API backend, it’s perfect for professionals, researchers, and teams handling large file collections in Chinese environments. πŸš€


Install Setup File

Download FileFinderSetup.exe from Releases.

✨ Features

  • Semantic File Search πŸ”: Find documents (DOCX, PDF, TXT) and images (JPG, PNG) using natural language queries in Chinese.
  • AI-Driven Insights πŸ€–: Generate embeddings for text and images with models optimized for Chinese content, powered by SentenceTransformers and ChineseCLIP.
  • OCR Excellence πŸ“Έ: Extract and summarize text from images and PDFs using Tesseract OCR, tailored for Chinese characters.
  • Smart Chat Assistant πŸ’¬: Engage in contextual conversations or summarize files with a Chinese-focused AI, supporting both Normal and RAG modes.
  • Chinese Interface πŸ‡¨πŸ‡³: Fully localized UI with intuitive navigation, designed for native Chinese speakers.
  • Dark/Light Mode πŸŒ—: Toggle themes for comfortable use in any lighting.
  • System Tray Integration πŸ–₯️: Minimize to tray with Alt+Q hotkey to restore.
  • Continuous Indexing πŸ”„: Automatically updates file indexes for monitored directories.

πŸ“Έ Screenshots

To be updated with v2’s Chinese interface.

  • Search Tab: Search Tab
  • Chat Assistant: Chat Assistant
  • OCR Summary: OCR Summary

πŸš€ Installation

Prerequisites

  • Python 🐍: 3.10 or higher
  • Tesseract OCR πŸ“–: For Chinese text extraction
    • Windows: Download, add to PATH, ensure chi_sim data is installed
    • Linux: sudo apt install tesseract-ocr tesseract-ocr-chi-sim
    • macOS: brew install tesseract
  • Poppler πŸ“„: For PDF processing
    • Windows: Download, add to PATH
    • Linux: sudo apt install poppler-utils
    • macOS: brew install poppler

Setup Steps

# Clone the Repository πŸ“₯
git clone https://github.com/BotirBakhtiyarov/Filefinder.git
cd Filefinder

# Set Up Virtual Environment πŸ› οΈ
python -m venv .venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

# Install Dependencies πŸ“¦
pip install -r requirements.txt

Configure AI Models βš™οΈ

Update MODEL_DIR in api_server.py:

MODEL_DIR = "models/"  # Path to Chinese-optimized models

Make sure models like:

  • paraphrase-multilingual-MiniLM-L12-v2
  • chinese-clip-vit-base-patch16

are available or downloaded.

Launch the App

# Start the API server 🌐
python api_server.py

# Run the main application πŸŽ‰
python app.py

πŸ–±οΈ Usage

First Launch πŸš€

A Chinese-language setup wizard will guide you to:

  • Enter API keys/URLs
  • Set document/image directories
  • Choose theme (Dark/Light)

Search Files πŸ”Ž

  • Go to the β€œζœη΄’β€ tab.
  • Enter Chinese queries (e.g., εΉ΄εΊ¦ζŠ₯ε‘Šζ¦‚θΏ°).
  • View results and:
    • 打开: Open file
    • ζ‘˜θ¦: AI-generated summary
    • OCR ζ‘˜θ¦: OCR-based summary for images

Chat Assistant πŸ’¬

  • Go to the β€œθŠε€©β€ tab
  • Select:
    • Normal Mode: For general chat
    • RAG Mode: Upload and ask about specific files
  • Ask questions in Chinese and get summarized answers

System Tray πŸ–₯️

  • Minimize to tray by closing window
  • Press Alt+Q to restore

πŸ“ Project Structure

FileFinder_v2/
β”œβ”€β”€ .venv/              # Virtual environment
β”œβ”€β”€ assets/
β”‚   β”œβ”€β”€ ui/             # Chinese-localized GUI
β”‚   β”‚   β”œβ”€β”€ chat_frame.py
β”‚   β”‚   β”œβ”€β”€ main_app.py
β”‚   β”‚   β”œβ”€β”€ search_frame.py
β”‚   β”‚   β”œβ”€β”€ setup_wizard.py
β”‚   β”‚   └── summary_window.py
β”‚   └── utils/
β”‚       └── file_utils.py
β”œβ”€β”€ app.py              # App entry point
β”œβ”€β”€ api_server.py       # Flask backend
β”œβ”€β”€ requirements.txt    # Dependencies
└── myicon.ico          # App icon

🌐 API Endpoints

api_server.py includes:

  • /embed_text: Embed Chinese text
  • /embed_image: Embed image
  • /embed_clip_text: CLIP-based text-image embedding
  • /extract_pdf_with_ocr: OCR for Chinese PDFs
  • /extract_image_ocr: OCR for Chinese images

🀝 Contributing

We welcome contributions! 🌟

# Fork and branch
git checkout -b feature/YourFeature

# Commit and push
git commit -m "Add YourFeature"
git push origin feature/YourFeature
  • Follow PEP 8
  • Maintain Chinese localization

⚠️ Troubleshooting

  • File Access Errors: Verify file paths and network drives.
  • OCR Issues: Make sure Tesseract is installed with chi_sim support.
  • API Failures: Confirm api_server.py is running and keys are set.
  • UI Bugs: Check customtkinter compatibility.

Open an issue on GitHub with logs if needed.


πŸ“œ License

MIT License – see LICENSE for details.


πŸ™Œ Acknowledgments

  • CustomTkinter: Modern GUI framework
  • SentenceTransformers: Chinese text embeddings
  • Transformers: ChineseCLIP integration
  • Tesseract OCR: Robust OCR engine

Built with ❀️ for Chinese-speaking users, AI File Finder v2 is your ultimate file management companion!

About

FileFinder: AI-powered file search & chat app with OCR, embeddings, and summaries. Supports docs & images.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages