summaryrefslogtreecommitdiff
path: root/README.md
blob: 3f6a7314794e46b4bac436cf8dc5912a7efd36bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# πŸ›οΈ AI Genealogy / ИИ ГСнСалогия

**Local AI assistant for genealogical research**  
**Π›ΠΎΠΊΠ°Π»ΡŒΠ½Ρ‹ΠΉ ИИ-ΠΏΠΎΠΌΠΎΡ‰Π½ΠΈΠΊ для гСнСалогичСских исслСдований**

---

## πŸ‡¬πŸ‡§ 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 освобоТдаСтся)

Π’Π΅Π±-интСрфСйс: http://localhost:3000
API докумСнтация: http://localhost:8000/docs

----------------------------------------------------------------------------------------------

πŸ”“ License / ЛицСнзия

All components are open-source (MIT, Apache 2.0, AGPLv3).
ВсС ΠΊΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚Ρ‹ с ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚Ρ‹ΠΌ исходным ΠΊΠΎΠ΄ΠΎΠΌ (MIT, Apache 2.0, AGPLv3).