docs: reorganize README with improved documentation links
Reorganize documentation section in README.md: - Add direct link to integration guide in Panoramica section - Remove duplicate documentation references - Organize docs into logical categories: * Guide Principali (integration guide, API overview) * NotebookLM Agent (SKILL.md, PRD, AGENTS.md) * DocuMente (prd-v2, frontend-plan, test coverage) * Generale (contributing, changelog, license) - Add table format for better readability - Update provider list to include Ollama and LM Studio - Add emojis for visual organization - Include Local LLM provider config in .env example Improves discoverability of documentation and provides clear navigation for users.
This commit is contained in:
101
README.md
101
README.md
@@ -17,6 +17,7 @@ Questo repository contiene **due sistemi AI complementari**:
|
|||||||
## Indice
|
## Indice
|
||||||
|
|
||||||
- [Panoramica](#panoramica)
|
- [Panoramica](#panoramica)
|
||||||
|
- [Integrazione NotebookLM + RAG](#integrazione-notebooklm--rag)
|
||||||
- [Componenti](#componenti)
|
- [Componenti](#componenti)
|
||||||
- [Requisiti](#requisiti)
|
- [Requisiti](#requisiti)
|
||||||
- [Installazione](#installazione)
|
- [Installazione](#installazione)
|
||||||
@@ -31,9 +32,6 @@ Questo repository contiene **due sistemi AI complementari**:
|
|||||||
|
|
||||||
## Panoramica
|
## Panoramica
|
||||||
|
|
||||||
### Integrazione
|
|
||||||
- [docs/integration.md](./docs/integration.md) - Guida integrazione NotebookLM + RAG
|
|
||||||
|
|
||||||
### NotebookLM Agent
|
### NotebookLM Agent
|
||||||
|
|
||||||
Interfaccia API e webhook per **Google NotebookLM** che permette:
|
Interfaccia API e webhook per **Google NotebookLM** che permette:
|
||||||
@@ -47,10 +45,11 @@ Interfaccia API e webhook per **Google NotebookLM** che permette:
|
|||||||
### DocuMente (Agentic RAG)
|
### DocuMente (Agentic RAG)
|
||||||
|
|
||||||
Sistema **Retrieval-Augmented Generation** standalone con:
|
Sistema **Retrieval-Augmented Generation** standalone con:
|
||||||
- Supporto per 8 provider LLM diversi
|
- Supporto per 8+ provider LLM (cloud e locali)
|
||||||
- Upload e indicizzazione documenti (PDF, DOCX, TXT, MD)
|
- Upload e indicizzazione documenti (PDF, DOCX, TXT, MD)
|
||||||
- Chat conversazionale con i tuoi documenti
|
- Chat conversazionale con i tuoi documenti
|
||||||
- Interfaccia web moderna (React + TypeScript)
|
- Interfaccia web moderna (React + TypeScript)
|
||||||
|
- **Integrazione con NotebookLM** - Ricerca semantica sui notebook
|
||||||
|
|
||||||
**Ideale per:** Knowledge management, Document analysis, Research assistant
|
**Ideale per:** Knowledge management, Document analysis, Research assistant
|
||||||
|
|
||||||
@@ -70,9 +69,9 @@ Ora puoi sincronizzare i tuoi notebook di NotebookLM nel sistema RAG di DocuMent
|
|||||||
```
|
```
|
||||||
NotebookLM → NotebookLMIndexerService → Qdrant Vector Store
|
NotebookLM → NotebookLMIndexerService → Qdrant Vector Store
|
||||||
↓
|
↓
|
||||||
RAGService (query con filtri)
|
RAGService (query con filtri)
|
||||||
↓
|
↓
|
||||||
Multi-Provider LLM Response
|
Multi-Provider LLM Response
|
||||||
```
|
```
|
||||||
|
|
||||||
### Come funziona
|
### Come funziona
|
||||||
@@ -82,17 +81,12 @@ NotebookLM → NotebookLMIndexerService → Qdrant Vector Store
|
|||||||
3. **Ricerca**: Le query RAG possono filtrare per notebook_id specifici
|
3. **Ricerca**: Le query RAG possono filtrare per notebook_id specifici
|
||||||
4. **Risposta**: Il LLM riceve contesto dai notebook selezionati
|
4. **Risposta**: Il LLM riceve contesto dai notebook selezionati
|
||||||
|
|
||||||
---
|
📚 **[Guida Completa Integrazione](./docs/integration.md)** - API, esempi, best practices
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Componenti
|
## Componenti
|
||||||
|
|
||||||
### Integrazione
|
|
||||||
- [docs/integration.md](./docs/integration.md) - Guida integrazione NotebookLM + RAG
|
|
||||||
|
|
||||||
### NotebookLM Agent
|
### NotebookLM Agent
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -140,12 +134,12 @@ src/agentic_rag/
|
|||||||
│ ├── query.py # Query RAG
|
│ ├── query.py # Query RAG
|
||||||
│ ├── chat.py # Chat conversazionale
|
│ ├── chat.py # Chat conversazionale
|
||||||
│ ├── providers.py # Gestione provider LLM
|
│ ├── providers.py # Gestione provider LLM
|
||||||
│ └── notebooklm_sync.py # [NUOVO] Sync NotebookLM
|
│ └── notebooklm_sync.py # Sync NotebookLM
|
||||||
├── services/ # Business logic
|
├── services/ # Business logic
|
||||||
│ ├── rag_service.py # Core RAG logic
|
│ ├── rag_service.py # Core RAG logic
|
||||||
│ ├── vector_store.py # Qdrant integration
|
│ ├── vector_store.py # Qdrant integration
|
||||||
│ ├── document_service.py
|
│ ├── document_service.py
|
||||||
│ └── notebooklm_indexer.py # [NUOVO] Indexing service
|
│ └── notebooklm_indexer.py # Indexing service
|
||||||
└── core/ # Configurazioni
|
└── core/ # Configurazioni
|
||||||
├── config.py # Multi-provider config
|
├── config.py # Multi-provider config
|
||||||
└── llm_factory.py # LLM factory pattern
|
└── llm_factory.py # LLM factory pattern
|
||||||
@@ -181,16 +175,18 @@ POST /api/v1/query/notebooks
|
|||||||
|
|
||||||
**Provider LLM Supportati:**
|
**Provider LLM Supportati:**
|
||||||
|
|
||||||
| Provider | Modelli Principali | Stato |
|
| Provider | Tipo | Modelli Principali |
|
||||||
|----------|-------------------|-------|
|
|----------|------|-------------------|
|
||||||
| **OpenAI** | GPT-4o, GPT-4, GPT-3.5 | ✅ |
|
| **OpenAI** | Cloud | GPT-4o, GPT-4, GPT-3.5 |
|
||||||
| **Z.AI** | zai-large, zai-medium | ✅ |
|
| **Anthropic** | Cloud | Claude 3.5, Claude 3 |
|
||||||
| **OpenCode Zen** | zen-1, zen-lite | ✅ |
|
| **Google** | Cloud | Gemini 1.5 Pro/Flash |
|
||||||
| **OpenRouter** | Multi-model access | ✅ |
|
| **Mistral** | Cloud | Mistral Large/Medium |
|
||||||
| **Anthropic** | Claude 3.5, Claude 3 | ✅ |
|
| **Azure** | Cloud | GPT-4, GPT-4o |
|
||||||
| **Google** | Gemini 1.5 Pro/Flash | ✅ |
|
| **Z.AI** | Cloud | zai-large, zai-medium |
|
||||||
| **Mistral** | Mistral Large/Medium | ✅ |
|
| **OpenCode Zen** | Cloud | zen-1, zen-lite |
|
||||||
| **Azure** | GPT-4, GPT-4o | ✅ |
|
| **OpenRouter** | Cloud | Multi-model access |
|
||||||
|
| **Ollama** | 🏠 Locale | llama3.2, mistral, qwen |
|
||||||
|
| **LM Studio** | 🏠 Locale | Any loaded model |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -261,6 +257,10 @@ MISTRAL_API_KEY=...
|
|||||||
AZURE_API_KEY=...
|
AZURE_API_KEY=...
|
||||||
AZURE_ENDPOINT=https://your-resource.openai.azure.com
|
AZURE_ENDPOINT=https://your-resource.openai.azure.com
|
||||||
|
|
||||||
|
# Local LLM Providers (no API key needed)
|
||||||
|
OLLAMA_BASE_URL=http://localhost:11434
|
||||||
|
LMSTUDIO_BASE_URL=http://localhost:1234
|
||||||
|
|
||||||
# Vector Store (Qdrant)
|
# Vector Store (Qdrant)
|
||||||
QDRANT_HOST=localhost
|
QDRANT_HOST=localhost
|
||||||
QDRANT_PORT=6333
|
QDRANT_PORT=6333
|
||||||
@@ -285,9 +285,6 @@ DEBUG=false
|
|||||||
|
|
||||||
## Avvio
|
## Avvio
|
||||||
|
|
||||||
### Integrazione
|
|
||||||
- [docs/integration.md](./docs/integration.md) - Guida integrazione NotebookLM + RAG
|
|
||||||
|
|
||||||
### NotebookLM Agent
|
### NotebookLM Agent
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -363,7 +360,9 @@ curl -X POST http://localhost:8000/api/v1/query \
|
|||||||
"provider": "openai",
|
"provider": "openai",
|
||||||
"model": "gpt-4o-mini"
|
"model": "gpt-4o-mini"
|
||||||
}'
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Integrazione NotebookLM + RAG
|
### Integrazione NotebookLM + RAG
|
||||||
|
|
||||||
@@ -382,7 +381,9 @@ curl -X DELETE http://localhost:8000/api/v1/notebooklm/sync/{notebook_id}
|
|||||||
**Query sui notebook:**
|
**Query sui notebook:**
|
||||||
```bash
|
```bash
|
||||||
# Query solo sui notebook (senza documenti locali)
|
# Query solo sui notebook (senza documenti locali)
|
||||||
curl -X POST http://localhost:8000/api/v1/query/notebooks -H "Content-Type: application/json" -d '{
|
curl -X POST http://localhost:8000/api/v1/query/notebooks \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{
|
||||||
"question": "Quali sono le conclusioni principali?",
|
"question": "Quali sono le conclusioni principali?",
|
||||||
"notebook_ids": ["uuid-del-notebook"],
|
"notebook_ids": ["uuid-del-notebook"],
|
||||||
"k": 10,
|
"k": 10,
|
||||||
@@ -390,7 +391,9 @@ curl -X POST http://localhost:8000/api/v1/query/notebooks -H "Content-Type: ap
|
|||||||
}'
|
}'
|
||||||
|
|
||||||
# Query mista (documenti + notebook)
|
# Query mista (documenti + notebook)
|
||||||
curl -X POST http://localhost:8000/api/v1/query -H "Content-Type: application/json" -d '{
|
curl -X POST http://localhost:8000/api/v1/query \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{
|
||||||
"question": "Confronta le informazioni tra i documenti e i notebook",
|
"question": "Confronta le informazioni tra i documenti e i notebook",
|
||||||
"notebook_ids": ["uuid-1", "uuid-2"],
|
"notebook_ids": ["uuid-1", "uuid-2"],
|
||||||
"include_documents": true,
|
"include_documents": true,
|
||||||
@@ -455,22 +458,36 @@ documente/
|
|||||||
|
|
||||||
## Documentazione
|
## Documentazione
|
||||||
|
|
||||||
### Integrazione
|
### 📚 Guide Principali
|
||||||
- [docs/integration.md](./docs/integration.md) - Guida integrazione NotebookLM + RAG
|
|
||||||
|
|
||||||
### NotebookLM Agent
|
| Documento | Descrizione |
|
||||||
- [SKILL.md](./SKILL.md) - Skill definition per agenti AI
|
|-----------|-------------|
|
||||||
- [prd.md](./prd.md) - Product Requirements Document
|
| **[docs/integration.md](./docs/integration.md)** | Guida completa integrazione NotebookLM + RAG - API, esempi, best practices |
|
||||||
- [AGENTS.md](./AGENTS.md) - Linee guida per sviluppo
|
| **[docs/README.md](./docs/README.md)** | Panoramica documentazione API e endpoint |
|
||||||
|
|
||||||
### DocuMente
|
### 🤖 NotebookLM Agent
|
||||||
- [prd-v2.md](./prd-v2.md) - Product Requirements Document
|
|
||||||
- [frontend-plan.md](./frontend-plan.md) - Piano sviluppo frontend
|
|
||||||
- [TEST_COVERAGE_REPORT.md](./TEST_COVERAGE_REPORT.md) - Report coverage
|
|
||||||
|
|
||||||
### Generale
|
| Documento | Descrizione |
|
||||||
- [CONTRIBUTING.md](./CONTRIBUTING.md) - Come contribuire
|
|-----------|-------------|
|
||||||
- [CHANGELOG.md](./CHANGELOG.md) - Cronologia modifiche
|
| **[SKILL.md](./SKILL.md)** | Skill definition per agenti AI - API reference completo |
|
||||||
|
| **[prd.md](./prd.md)** | Product Requirements Document |
|
||||||
|
| **[AGENTS.md](./AGENTS.md)** | Linee guida per sviluppo |
|
||||||
|
|
||||||
|
### 🧠 DocuMente (Agentic RAG)
|
||||||
|
|
||||||
|
| Documento | Descrizione |
|
||||||
|
|-----------|-------------|
|
||||||
|
| **[prd-v2.md](./prd-v2.md)** | Product Requirements Document v2 |
|
||||||
|
| **[frontend-plan.md](./frontend-plan.md)** | Piano sviluppo frontend |
|
||||||
|
| **[TEST_COVERAGE_REPORT.md](./TEST_COVERAGE_REPORT.md)** | Report coverage test |
|
||||||
|
|
||||||
|
### 📝 Generale
|
||||||
|
|
||||||
|
| Documento | Descrizione |
|
||||||
|
|-----------|-------------|
|
||||||
|
| **[CONTRIBUTING.md](./CONTRIBUTING.md)** | Come contribuire al progetto |
|
||||||
|
| **[CHANGELOG.md](./CHANGELOG.md)** | Cronologia modifiche e release |
|
||||||
|
| **[LICENSE](./LICENSE)** | Termini di licenza |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user