diff --git a/README.md b/README.md index e69de29..b65e7cf 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,109 @@ +# Právny AI Asistent – integrácia s API + +## POPIS + +Právny AI Asistent je inteligentný asistent integrovaný s oficiálnymi verejnými API Ministerstva spravodlivosti +Slovenskej republiky. Systém poskytuje užívateľom prístup k štruktúrovaným právnym informáciám prostredníctvom +prirodzeného jazyka. + +![PROFILE](public/img/project.png) + +**Hlavné funkcie:** +- Interpretácia užívateľských otázok v prirodzenom jazyku +- Automatická extrakcia a validácia parametrov +- Načítavanie dát výlučne cez oficiálne API +- Prezentácia výsledkov v zrozumiteľnom formáte v slovenskom jazyku + +## POUŽITÉ KNIŽNICE A TECHNOLÓGIE + +- **Python** – hlavný programovací jazyk +- **openai-agent** – tvorba AI agentov od OpenAI +- **httpx** – asynchrónna komunikácia s API +- **Chainlit** – framework pre chat rozhranie +- **Ollama** – lokálne používanie AI modelov +- **Docker** – kontajnerizácia aplikácie +- a **iné** + +## ŠTRUKTÚRA PROJEKTU +``` +ai-lawyer-agent/ +├── api/ # API logika +│ └── tools/ # API nástroje +│ ├── __init__.py +│ ├── fetch_api_data.py # Spracovanie API +│ └── schemas.py # Pydantic schémy +├── core/ +│ ├── __init__.py +│ ├── initialize_agent.py # Inicializácia AI agenta +│ ├── stream_response.py # Streamovanie odpovedí +│ └── system_prompt.py # Systémový prompt +├── public/ # Verejné zdroje +│ ├── icon/ # Ikony a logá +│ │ ├── favicon.png +│ │ ├── logo_dark.png +│ │ └── logo_light.png +│ ├── img/ +│ ├── styles.css # Štýly rozhrania +│ └── theme.json # Nastavenia témy +├── .chainlit/ # Markdown pre Chainlit +└── app.py # Hlavný súbor aplikácie (Сhainlit + spracovanie API) +``` + +## INŠTRUKCIA PRE INŠTALÁCIU + +### **Inštalácia cez Git** + +### 1. **Naklonovanie repozitára** + +```bash +git clone git@git.kemt.fei.tuke.sk:od059jr/ai-lawyer-agent.git +``` + +### 2. **Vytvorenie virtuálneho prostredia** + +#### Pre Windows +```bash +python -m venv venv + +venv\Scripts\activate +``` + +#### Pre macOS/Linux +``` +python3 -m venv venv + +source venv/bin/activate +``` + +### 3. **Inštalácia závislostí** +```bash +pip install -r requirements.txt +``` + +### 4. **Sťahovanie inštalátora Ollama** + +https://ollama.com/download + + +### 5. **Sťahovanie modelov** + +```bash +ollama pull qwen3-next:80b-cloud +``` + +```bash +ollama pull gpt-oss:20b-cloud +``` + +```bash +ollama pull deepseek-v3.1:671b-cloud +``` + +### **Inštalácia cez DOCKER** + +### 1. Inštalácia Docker a Docker Desktop + +### 2. Nainštalujte a spustite aplikáciu + +https://hub.docker.com/r/alexgott0616/ai-lawyer-agent +