docs: focus public documentation on product usage
This commit is contained in:
+27
-34
@@ -36,22 +36,22 @@ thoth-workspaces.yaml ← catalogo: elenco dei workspace
|
||||
```yaml
|
||||
schema_version: 1
|
||||
workspaces:
|
||||
- id: psd-clinical
|
||||
name: Policlinico San Donato
|
||||
description: DWH clinico del Policlinico San Donato
|
||||
- id: acme-ebikes
|
||||
name: ACME Limited
|
||||
description: DWH della produzione di biciclette elettriche
|
||||
```
|
||||
|
||||
- L'**id** deve essere minuscolo, senza spazi, es. `psd-clinical` (`[a-z][a-z0-9-]{2,62}`).
|
||||
- L'**id** deve essere minuscolo, senza spazi, es. `acme-ebikes` (`[a-z][a-z0-9-]{2,62}`).
|
||||
- Il **descrittore** `<id>/workspace.yaml` è lo schema v3. È l'unica descrizione valida.
|
||||
|
||||
### 1.2 Esempio di descrittore (Policlinico San Donato)
|
||||
### 1.2 Esempio di descrittore (ACME Limited)
|
||||
|
||||
```yaml
|
||||
workspace:
|
||||
schema_version: 3
|
||||
id: psd-clinical
|
||||
name: Policlinico San Donato
|
||||
description: DWH clinico — aritmologia
|
||||
id: acme-ebikes
|
||||
name: ACME Limited
|
||||
description: DWH industriale — produzione di biciclette elettriche
|
||||
language: it # le descrizioni/evidence sono in italiano
|
||||
|
||||
dwh:
|
||||
@@ -63,7 +63,7 @@ dwh:
|
||||
semantic_index:
|
||||
vector_store:
|
||||
engine: qdrant
|
||||
collection: psd-clinical
|
||||
collection: acme-ebikes
|
||||
dimensions: 1024
|
||||
distance: cosine
|
||||
embedding:
|
||||
@@ -84,7 +84,7 @@ diagnostics:
|
||||
evidence:
|
||||
source:
|
||||
type: filesystem
|
||||
uri: psd-clinical/evidence # percorso dentro il repository
|
||||
uri: acme-ebikes/evidence # percorso dentro il repository
|
||||
policy:
|
||||
max_chunk_chars: 4000
|
||||
retain_published_generations: 3
|
||||
@@ -186,10 +186,6 @@ selezione del workspace.
|
||||
configurato/mancante.
|
||||
- **Forget stored value** elimina dal vault cifrato il singolo secret indicato. Le sessioni o operazioni future
|
||||
che lo richiedono restano bloccate finché non viene inserito di nuovo.
|
||||
- **Test workspace connections** materializza temporaneamente i secret necessari, contatta i servizi dati
|
||||
configurati per quel workspace e rimuove i file temporanei alla fine. Non esporta né pubblica
|
||||
nulla.
|
||||
|
||||
Il repository Git remoto e le relative credenziali sono impostazioni di installazione. I secret
|
||||
runtime DWH/Evidence sono invece persistenti nel vault cifrato del backend e non nel local storage
|
||||
della GUI. La GUI è soltanto l'interfaccia: dopo l'invio cancella i valori dai campi e non può
|
||||
@@ -206,8 +202,8 @@ naturale (workspace, modello e provider sono impostazioni globali già configura
|
||||
|
||||
Esempio di domanda:
|
||||
|
||||
> «Estrai i pazienti che hanno eseguito un'ablazione nell'ultimo anno, con nome, cognome e data
|
||||
> dell'intervento.»
|
||||
> «Elenca le biciclette elettriche completate nell'ultimo anno, con modello, numero di telaio e
|
||||
> data di completamento.»
|
||||
|
||||
### 3.2 Il workflow a 8 fasi e i gate
|
||||
|
||||
@@ -235,41 +231,41 @@ verità: ciò che non è registrato non è avvenuto.
|
||||
|
||||
---
|
||||
|
||||
## Esempio pratico completo — Policlinico San Donato
|
||||
## Esempio pratico completo — ACME Limited
|
||||
|
||||
### Passo 0 — repository
|
||||
|
||||
Crea il repository Git del workspace (es. `tht-workspace-psd`):
|
||||
Crea il repository Git del workspace (es. `tht-workspace-acme`):
|
||||
|
||||
```text
|
||||
thoth-workspaces.yaml # catalogo con psd-clinical
|
||||
psd-clinical/workspace.yaml # descrittore v3 (vedi §1.2)
|
||||
psd-clinical/evidence/ # i documenti .md di contesto curati
|
||||
psd-clinical/schema/annotations.yaml # (quando ci sono join curate)
|
||||
thoth-workspaces.yaml # catalogo con acme-ebikes
|
||||
acme-ebikes/workspace.yaml # descrittore v3 (vedi §1.2)
|
||||
acme-ebikes/evidence/ # i documenti .md di contesto curati
|
||||
acme-ebikes/schema/annotations.yaml # (quando ci sono join curate)
|
||||
```
|
||||
|
||||
Fai `commit` e `push`. Nell'installazione, l'applicazione fa `Pull` e **attiva** il workspace:
|
||||
valida lo schema v3, materializza l'Evidence dal commit fissato e prepara la collection Qdrant
|
||||
Pubblica una nuova revisione Git. Nell'installazione, l'applicazione acquisisce e **attiva** il workspace:
|
||||
valida lo schema v3, materializza l'Evidence dalla revisione fissata e prepara la collection Qdrant
|
||||
(1024/cosine + indici).
|
||||
|
||||
### Passo 1 — preprocessing
|
||||
|
||||
```bash
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess dwh --workspace psd-clinical --json
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess run --workspace psd-clinical --json
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess dwh --workspace acme-ebikes --json
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess run --workspace acme-ebikes --json
|
||||
```
|
||||
|
||||
Se il run si ferma per le join (`manual_review_required`):
|
||||
|
||||
```bash
|
||||
# il curatore rivede i candidati e pubblica psd-clinical/schema/annotations.yaml, poi:
|
||||
tht --installation ~/thothii-installation.yaml workspace schema accept --workspace psd-clinical --run <run-id> --yes --json
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess run --workspace psd-clinical --resume <run-id> --json
|
||||
# il curatore rivede i candidati e pubblica acme-ebikes/schema/annotations.yaml, poi:
|
||||
tht --installation ~/thothii-installation.yaml workspace schema accept --workspace acme-ebikes --run RUN_ID --yes --json
|
||||
tht --installation ~/thothii-installation.yaml workspace preprocess run --workspace acme-ebikes --resume RUN_ID --json
|
||||
```
|
||||
|
||||
### Passo 2 — la domanda
|
||||
|
||||
Nell'applicazione seleziona il workspace `psd-clinical` e crea una sessione con la domanda. Segui
|
||||
Nell'applicazione seleziona il workspace `acme-ebikes` e crea una sessione con la domanda. Segui
|
||||
le fasi e conferma ai gate: il modello proporrà lo schema-linking (tabelle/colonne del DWH
|
||||
`datawarehouse`), i CTE e infine l'SQL finale, che potrai copiare/visualizzare ed eseguire.
|
||||
|
||||
@@ -277,11 +273,8 @@ le fasi e conferma ai gate: il modello proporrà lo schema-linking (tabelle/colo
|
||||
|
||||
## Dove trovare i dettagli tecnici
|
||||
|
||||
Per l'accesso DWH REST, la chiave è per installazione e vale solo per `rest_api`: il server PSD rimane `postgres_direct` e `ssh_tunnel` non usa questa chiave. Vedere [guida server DWH](install/dwh-auth-server.md), [enrollment client](install/dwh-auth-client-enrollment.md), [TLS](install/dwh-auth-tls.md) e [runbook PSD](operations/psd-dwh-auth-rollout.md).
|
||||
Per l'accesso DWH REST, la chiave è per installazione e vale solo per `rest_api`; `postgres_direct` e `ssh_tunnel` non usano questa chiave. Vedere [guida server DWH](install/dwh-auth-server.md), [enrollment client](install/dwh-auth-client-enrollment.md) e [TLS](install/dwh-auth-tls.md).
|
||||
|
||||
- Contratto CLI: `docs/contracts/workspace-preprocessing-cli.md`
|
||||
- Contratto `.tht-dwh`: `docs/contracts/tht-dwh.md`
|
||||
- Evidence v3: `docs/contracts/workspace-evidence-v3.md`
|
||||
- Installazione locale: `docs/install/local-workspace-registry.md`
|
||||
- Installazione server: `docs/install/server-workspace-registry.md`
|
||||
- Verifica manuale P2–P6: `docs/testing/p2-p6-manual-verification.md`
|
||||
|
||||
Reference in New Issue
Block a user