diff options
| -rw-r--r-- | README.md | 81 |
1 files changed, 71 insertions, 10 deletions
@@ -1,18 +1,79 @@ -# Documentation +# ποΈ AI Genealogy / ΠΠ ΠΠ΅Π½Π΅Π°Π»ΠΎΠ³ΠΈΡ -### Russia -**ΠΠ΄Π΅ΡΡ Ρ
ΡΠ°Π½ΡΡΡΡ ΠΌΠΎΠΈ Π»ΠΈΡΠ½ΡΠ΅ Π·Π°ΠΌΠ΅ΡΠΊΠΈ, ΠΈΠ½ΡΡΡΡΠΊΡΠΈΠΈ, Π³Π°ΠΉΠ΄Ρ ΠΈ Π΄ΡΡΠ³ΠΈΠ΅ Π²ΡΠΏΠΎΠΌΠΎΠ³Π°ΡΠ΅Π»ΡΠ½ΡΠ΅ ΠΌΠ°ΡΠ΅ΡΠΈΠ°Π»Ρ - ΠΏΡΠΎΡΡΠΎ ΡΡΠΎΠ±Ρ Π½Π΅ Π·Π°Π±ΡΡΡ ΠΈ Π²ΡΠ΅Π³Π΄Π° ΠΈΠΌΠ΅ΡΡ ΠΏΠΎΠ΄ ΡΡΠΊΠΎΠΉ.** +**Local AI assistant for genealogical research** +**ΠΠΎΠΊΠ°Π»ΡΠ½ΡΠΉ ΠΠ-ΠΏΠΎΠΌΠΎΡΠ½ΠΈΠΊ Π΄Π»Ρ Π³Π΅Π½Π΅Π°Π»ΠΎΠ³ΠΈΡΠ΅ΡΠΊΠΈΡ
ΠΈΡΡΠ»Π΅Π΄ΠΎΠ²Π°Π½ΠΈΠΉ** -Π Π΅ΠΏΠΎΠ·ΠΈΡΠΎΡΠΈΠΉ Π½Π΅ ΠΏΡΠΈΠ²ΡΠ·Π°Π½ ΠΊ ΠΎΡΠ΄Π΅Π»ΡΠ½ΠΎΠΌΡ ΡΠ°ΠΉΡΡ, ΡΡΠΎ ΠΊΠΎΠ»Π»Π΅ΠΊΡΠΈΡ ΠΏΠΎΠ»Π΅Π·Π½ΡΡ
Π·Π°ΠΏΠΈΡΠ΅ΠΉ. +--- -* π Π Π΅ΠΏΠΎΠ·ΠΈΡΠΎΡΠΈΠΉ: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git) +## π¬π§ What is this? ---- +A fully local, open-source AI toolkit for genealogical research. It runs entirely on your computer β no cloud services, no subscriptions, no data leaks. + +### Capabilities +- π **Semantic search** through your archive of digitized documents +- π **OCR recognition** of old metric books, scans, and manuscripts (Russian, Polish, Belarusian) +- π **Private web search** via SearXNG meta-search engine +- πΈοΈ **Website scraping** of genealogy forums and archives +- π¬ **AI chat** with context from your documents (RAG) +- π§ **Analysis** of surnames, dates, places, family connections + +### Tech Stack +| Component | Purpose | +|-----------|---------| +| Open WebUI | Web interface | +| Ollama + Qwen2.5/Mistral | LLM | +| Qdrant + BGE-M3 | Vector search | +| EasyOCR + Tesseract | OCR | +| SearXNG | Web search | +| Crawl4AI | Web scraping | +| FastAPI | Integration API | + +### Quick Start +```bash +ai-genealogy start # Launch +ai-genealogy stop # Shutdown (GPU freed) + +Web UI: http://localhost:3000 +API Docs: http://localhost:8000/docs + +---------------------------------------------------------------------------------------------- + +ΠΠΎΠ»Π½ΠΎΡΡΡΡ Π»ΠΎΠΊΠ°Π»ΡΠ½ΡΠΉ, ΠΎΡΠΊΡΡΡΡΠΉ AI-ΠΈΠ½ΡΡΡΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΉ Π΄Π»Ρ Π³Π΅Π½Π΅Π°Π»ΠΎΠ³ΠΈΡΠ΅ΡΠΊΠΈΡ
ΠΈΡΡΠ»Π΅Π΄ΠΎΠ²Π°Π½ΠΈΠΉ. ΠΡΡ ΡΠ°Π±ΠΎΡΠ°Π΅Ρ Π½Π° Π²Π°ΡΠ΅ΠΌ ΠΊΠΎΠΌΠΏΡΡΡΠ΅ΡΠ΅ β Π±Π΅Π· ΠΎΠ±Π»Π°ΠΊΠΎΠ², ΠΏΠΎΠ΄ΠΏΠΈΡΠΎΠΊ ΠΈ ΡΡΠ΅ΡΠ΅ΠΊ Π΄Π°Π½Π½ΡΡ
. +ΠΠΎΠ·ΠΌΠΎΠΆΠ½ΠΎΡΡΠΈ + + π Π‘Π΅ΠΌΠ°Π½ΡΠΈΡΠ΅ΡΠΊΠΈΠΉ ΠΏΠΎΠΈΡΠΊ ΠΏΠΎ Π²Π°ΡΠ΅ΠΌΡ Π°ΡΡ
ΠΈΠ²Ρ ΠΎΡΠΈΡΡΠΎΠ²Π°Π½Π½ΡΡ
Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠΎΠ² + + π Π Π°ΡΠΏΠΎΠ·Π½Π°Π²Π°Π½ΠΈΠ΅ (OCR) ΡΡΠ°ΡΡΡ
ΠΌΠ΅ΡΡΠΈΡΠ΅ΡΠΊΠΈΡ
ΠΊΠ½ΠΈΠ³, ΡΠΊΠ°Π½ΠΎΠ², ΡΡΠΊΠΎΠΏΠΈΡΠ΅ΠΉ (ΡΡΡΡΠΊΠΈΠΉ, ΠΏΠΎΠ»ΡΡΠΊΠΈΠΉ, Π±Π΅Π»ΠΎΡΡΡΡΠΊΠΈΠΉ) + + π ΠΡΠΈΠ²Π°ΡΠ½ΡΠΉ Π²Π΅Π±-ΠΏΠΎΠΈΡΠΊ ΡΠ΅ΡΠ΅Π· ΠΌΠ΅ΡΠ°-ΠΏΠΎΠΈΡΠΊΠΎΠ²ΠΈΠΊ SearXNG + + πΈοΈ Π‘ΠΊΡΠ°ΠΏΠΈΠ½Π³ ΡΠ°ΠΉΡΠΎΠ² β Π³Π΅Π½Π΅Π°Π»ΠΎΠ³ΠΈΡΠ΅ΡΠΊΠΈΡ
ΡΠΎΡΡΠΌΠΎΠ² ΠΈ Π°ΡΡ
ΠΈΠ²ΠΎΠ² + + π¬ AI-ΡΠ°Ρ Ρ ΠΊΠΎΠ½ΡΠ΅ΠΊΡΡΠΎΠΌ ΠΈΠ· Π²Π°ΡΠΈΡ
Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠΎΠ² (RAG) + + π§ ΠΠ½Π°Π»ΠΈΠ· ΡΠ°ΠΌΠΈΠ»ΠΈΠΉ, Π΄Π°Ρ, ΠΌΠ΅ΡΡ, ΡΠΎΠ΄ΡΡΠ²Π΅Π½Π½ΡΡ
ΡΠ²ΡΠ·Π΅ΠΉ + +Π’Π΅Ρ
Π½ΠΎΠ»ΠΎΠ³ΠΈΡΠ΅ΡΠΊΠΈΠΉ ΡΡΠ΅ΠΊ +ΠΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ ΠΠ°Π·Π½Π°ΡΠ΅Π½ΠΈΠ΅ +Open WebUI ΠΠ΅Π±-ΠΈΠ½ΡΠ΅ΡΡΠ΅ΠΉΡ +Ollama + Qwen2.5/Mistral Π―Π·ΡΠΊΠΎΠ²Π°Ρ ΠΌΠΎΠ΄Π΅Π»Ρ (LLM) +Qdrant + BGE-M3 ΠΠ΅ΠΊΡΠΎΡΠ½ΡΠΉ ΠΏΠΎΠΈΡΠΊ +EasyOCR + Tesseract Π Π°ΡΠΏΠΎΠ·Π½Π°Π²Π°Π½ΠΈΠ΅ ΡΠ΅ΠΊΡΡΠ° +SearXNG ΠΠ΅Π±-ΠΏΠΎΠΈΡΠΊ +Crawl4AI Π‘ΠΊΡΠ°ΠΏΠΈΠ½Π³ ΡΠ°ΠΉΡΠΎΠ² +FastAPI API-ΠΈΠ½ΡΠ΅Π³ΡΠ°ΡΠΈΡ +ΠΡΡΡΡΡΠΉ ΡΡΠ°ΡΡ +bash + +ai-genealogy start # ΠΠ°ΠΏΡΡΠΊ +ai-genealogy stop # ΠΡΠΊΠ»ΡΡΠ΅Π½ΠΈΠ΅ (GPU ΠΎΡΠ²ΠΎΠ±ΠΎΠΆΠ΄Π°Π΅ΡΡΡ) -### English +ΠΠ΅Π±-ΠΈΠ½ΡΠ΅ΡΡΠ΅ΠΉΡ: http://localhost:3000 +API Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΡ: http://localhost:8000/docs -**This is where I keep my personal notes, howβto guides, instructions and other reference materials - so I donβt forget them and always have them at hand.** +---------------------------------------------------------------------------------------------- -The repository is not linked to a dedicated website; it is just a collection of useful writings. +π License / ΠΠΈΡΠ΅Π½Π·ΠΈΡ -* π Repository: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git) +All components are open-source (MIT, Apache 2.0, AGPLv3). +ΠΡΠ΅ ΠΊΠΎΠΌΠΏΠΎΠ½Π΅Π½ΡΡ Ρ ΠΎΡΠΊΡΡΡΡΠΌ ΠΈΡΡ
ΠΎΠ΄Π½ΡΠΌ ΠΊΠΎΠ΄ΠΎΠΌ (MIT, Apache 2.0, AGPLv3). |
