jglowa commited on
Commit
ddd0ebf
verified
1 Parent(s): f539820

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -3
README.md CHANGED
@@ -15,15 +15,15 @@ Prosty RAG to otwarto藕r贸d艂owy asystent AI oparty na polskim modelu j臋zykowym
15
 
16
  Zasada dzia艂ania:
17
  1. Umieszczamy pliki bazy wiedzy PDF, TXT, MD (Markdown) lub CSV w folderze `baza`,
18
- 2. Pliki s膮 indeksowane (PDF konwertowane na TXT za pomoc膮 [pdftotext](https://www.xpdfreader.com/pdftotext-man.html)), dzielone na fragmenty (po 200 s艂贸w, 20 s艂贸w nak艂ada si臋) i osadzane w wektorowej bazie danych [sqlite-vec](https://github.com/asg017/sqlite-vec),
19
  3. Dla danego zapytania pobierane s膮 najbardziej trafne fragmenty z bazy danych, kt贸re uzupe艂niaj膮 kontekst pytania,
20
  4. Model j臋zykowy generuje odpowied藕 na pytanie wykorzystuj膮c wzbogacone dane z bazy wiedzy.
21
 
22
  ### Uruchamianie
23
 
24
- Wystarczy pobra膰 plik [**prosty-rag.cmd**](https://huggingface.co/jglowa/prosty-rag/resolve/main/prosty-rag.cmd?download=true) (klikaj膮c prawym przyciskiem -> zapisz link jako...) i uruchomi膰 go (klikaj膮c dwukrotnie mysz膮 lub wpisuj膮c w wierszu polece艅 `./prosty-rag.cmd`). Skrypt sam pobierze pliki: `prosty-rag.llamafile` i `bge-m3.embedfile` (je艣li nie zosta艂y wcze艣niej pobrane), uruchomi indeksator (je艣li nie zosta艂 jeszcze uruchomiony), za艂aduje serwer z modelem osadzania (embedfile), serwer z modelem j臋zykowym (llamafile) i otworzy stron臋 [http://localhost:8080](http://localhost:8080) w przegl膮darce internetowej. Asystent dzia艂a off-line, a wszelkie dane pozostaj膮 lokalnie na urz膮dzeniu.
25
 
26
- W folderze `baza` nale偶y umie艣ci膰 wszystkie pliki PDF, TXT, MD i CSV do stworzenia bazy wiedzy. Nast臋pnie nale偶y uruchomi膰 skrypt `indeksator.cmd`, kt贸ry skonwertuje pliki PDF do TXT i zaindeksuje pliki tesktowe w wektorowej bazie danych SQLite `prosty-rag.db`, korzystaj膮c z modelu osadzania `bge-m3.embedfile`. Indeksator nale偶y uruchomi膰 po ka偶dej zmianie plik贸w w folderze `baza`.
27
 
28
  Aby zadawa膰 pytania dotycz膮ce zaindeksowanej bazy wiedzy, nale偶y uruchomi膰 skrypt `prosty-rag.cmd` i wpisa膰 pytanie w aplikacji czatu na [http://localhost:8080](http://localhost:8080). Najbardziej trafne fragmenty zostan膮 wyszukane w bazie danych `prosty-rag.db`, a nast臋pnie zostanie za艂adowany model j臋zykowy Bielik 4.5B v3.0, kt贸ry wygeneruje odpowied藕 w oparciu o kontekst z bazy wiedzy.
29
 
@@ -40,6 +40,7 @@ Aby zbudowa膰 w艂asn膮 wersj臋 asystenta AI, nale偶y 艣ci膮gn膮膰 skrypt `build.
40
  - 0.1 - pierwsza wersja wieloplatformowa
41
  - 0.2 - dodanie serwera embedfile z modelem osadzania BGE-M3
42
  - 0.3 - dodanie obs艂ugi CSV, logowania do pliku `prosty-rag.log`
 
43
 
44
  ### Licencja
45
 
 
15
 
16
  Zasada dzia艂ania:
17
  1. Umieszczamy pliki bazy wiedzy PDF, TXT, MD (Markdown) lub CSV w folderze `baza`,
18
+ 2. Pliki s膮 indeksowane (PDF konwertowane na TXT za pomoc膮 [pdftotext](https://www.xpdfreader.com/pdftotext-man.html)), dzielone na fragmenty (po 200 s艂贸w, 10 s艂贸w nak艂ada si臋) i osadzane w wektorowej bazie danych [sqlite-vec](https://github.com/asg017/sqlite-vec),
19
  3. Dla danego zapytania pobierane s膮 najbardziej trafne fragmenty z bazy danych, kt贸re uzupe艂niaj膮 kontekst pytania,
20
  4. Model j臋zykowy generuje odpowied藕 na pytanie wykorzystuj膮c wzbogacone dane z bazy wiedzy.
21
 
22
  ### Uruchamianie
23
 
24
+ Wystarczy pobra膰 plik [**prosty-rag.cmd**](https://huggingface.co/jglowa/prosty-rag/resolve/main/prosty-rag.cmd?download=true) (klikaj膮c prawym przyciskiem -> zapisz link jako...) i uruchomi膰 go (klikaj膮c dwukrotnie mysz膮 lub wpisuj膮c w wierszu polece艅 `./prosty-rag.cmd`). Skrypt sam pobierze pliki: `prosty-rag.llamafile` i `prosty-rag.embedfile` (je艣li nie zosta艂y wcze艣niej pobrane), uruchomi indeksator (je艣li nie zosta艂 jeszcze uruchomiony), za艂aduje serwer z modelem osadzania (embedfile), serwer z modelem j臋zykowym (llamafile) i otworzy stron臋 [http://localhost:8080](http://localhost:8080) w przegl膮darce internetowej. Asystent dzia艂a off-line, a wszelkie dane pozostaj膮 lokalnie na urz膮dzeniu.
25
 
26
+ W folderze `baza` nale偶y umie艣ci膰 wszystkie pliki PDF, TXT, MD i CSV do stworzenia bazy wiedzy. Nast臋pnie nale偶y uruchomi膰 skrypt `indeksator.cmd`, kt贸ry skonwertuje pliki PDF do TXT i zaindeksuje pliki tesktowe w wektorowej bazie danych SQLite `prosty-rag.db`, korzystaj膮c z modelu osadzania BGE-M3. Indeksator nale偶y uruchomi膰 po ka偶dej zmianie plik贸w w folderze `baza`.
27
 
28
  Aby zadawa膰 pytania dotycz膮ce zaindeksowanej bazy wiedzy, nale偶y uruchomi膰 skrypt `prosty-rag.cmd` i wpisa膰 pytanie w aplikacji czatu na [http://localhost:8080](http://localhost:8080). Najbardziej trafne fragmenty zostan膮 wyszukane w bazie danych `prosty-rag.db`, a nast臋pnie zostanie za艂adowany model j臋zykowy Bielik 4.5B v3.0, kt贸ry wygeneruje odpowied藕 w oparciu o kontekst z bazy wiedzy.
29
 
 
40
  - 0.1 - pierwsza wersja wieloplatformowa
41
  - 0.2 - dodanie serwera embedfile z modelem osadzania BGE-M3
42
  - 0.3 - dodanie obs艂ugi CSV, logowania do pliku `prosty-rag.log`
43
+ - 0.4 - wyszukiwanie hybrydowe za pomoc膮 FTS (BM25) i wektor贸w, oddzielne pobieranie modeli GGUF
44
 
45
  ### Licencja
46