L’Assistente è abilitato automaticamente nei piani Pro e Custom.

Informazioni sull’assistente

L’Assistente risponde alle domande sulla tua documentazione tramite richieste in linguaggio naturale. È integrato direttamente nel tuo sito di documentazione, offrendo agli utenti accesso immediato a un aiuto contestuale. L’Assistente utilizza RAG agentico (retrieval-augmented generation) con tool calling, basato su Claude Sonnet 4. Quando gli utenti pongono domande, l’Assistente:
  • Cerca e recupera contenuti pertinenti dalla tua documentazione per fornire risposte accurate.
  • Cita le fonti e fornisce link navigabili per portare gli utenti direttamente alle pagine di riferimento.
  • Genera esempi di codice copiabili per aiutare gli utenti a implementare soluzioni basate sulla tua documentazione.
Ogni messaggio inviato all’Assistente viene conteggiato nel limite di messaggi del tuo piano. Se superi il limite, i messaggi aggiuntivi comportano costi eccedenti. Puoi impostare limiti di spesa o disattivare l’Assistente al raggiungimento del limite. Puoi visualizzare l’utilizzo dell’Assistente dalla tua dashboard per comprendere il comportamento degli utenti e l’efficacia della documentazione. Esporta e analizza i dati delle query per identificare:
  • Domande frequenti che potrebbero richiedere una copertura migliore.
  • Lacune nei contenuti in cui gli utenti faticano a trovare risposte.
  • Argomenti popolari che potrebbero beneficiare di contenuti aggiuntivi.

Configurare l’assistente

L’Assistente è abilitato per impostazione predefinita nei piani Pro e Custom. Puoi gestirlo dal tuo dashboard, inclusi attivazione o disattivazione, configurazione della gestione delle risposte e impostazione di un limite di spesa.

Stato dell’Assistente

Attiva o disattiva l’Assistente per abilitare o disabilitare l’assistente nel tuo sito di documentazione.

Deviazione dell’Assistente

Consenti all’Assistente di reindirizzare le domande a cui non può rispondere al tuo team di supporto. Fornisci un indirizzo email che l’Assistente fornirà agli utenti che pongono domande a cui non può rispondere.

Ricerca nei siti

La ricerca nel sito è in beta. Per abilitarla nel tuo sito di documentazione, contatta il nostro team commerciale.
Configura i siti che l’Assistente può consultare per ottenere ulteriore contesto quando risponde alle domande.
  • I siti devono essere pubblicamente accessibili.
  • I siti che richiedono JavaScript per il caricamento non sono supportati.
Puoi utilizzare la seguente sintassi di filtraggio quando configuri siti esterni:
  • Filtraggio a livello di dominio
    • example.com: Cerca solo nel dominio example.com
    • docs.example.com: Cerca solo nel sottodominio docs.example.com
    • *.example.com: Cerca tutti i sottodomini di example.com
  • Filtraggio a livello di percorso
    • docs.example.com/api: Cerca tutte le pagine nel sottopercorso /api
  • Pattern multipli
    • Aggiungi più voci per coprire sezioni diverse dei siti

Limite di spesa

Imposta un limite di spesa per controllare cosa accade se raggiungi la tua quota di messaggi. Per impostazione predefinita, l’Assistente continuerà a rispondere alle domande degli utenti anche dopo aver raggiunto la quota, generando costi extra. Nella scheda Billing della pagina Assistant Configurations puoi impostare un limite di spesa per i messaggi dell’Assistente oltre la tua quota. Quando raggiungi il limite, l’Assistente viene disabilitato finché la quota di messaggi non viene ripristinata. Puoi anche configurare avvisi di utilizzo per ricevere un’email quando raggiungi una certa percentuale del tuo limite di spesa.

Utilizzo dell’assistente

Gli utenti possono accedere all’assistente in tre modi:
  • Scorciatoie da tastiera: ? oppure Command + I (Ctrl + I su Windows)
  • Pulsante Assistente accanto alla barra di ricerca Barra di ricerca e pulsante Assistente in modalità chiara.
  • URL con ?assistant=open aggiunto apriranno l’assistente al caricamento della pagina. Ad esempio, https://mintlify.com/docs?assistant=open.
Tutte le modalità aprono un pannello di chat sul lato destro della documentazione. Gli utenti possono porre qualsiasi domanda e l’Assistente cercherà nella documentazione una risposta. Se non trova informazioni pertinenti, l’Assistente risponderà che non può rispondere alla domanda.

Rendere i contenuti fruibili dall’IA

Struttura la documentazione per aiutare l’Assistente a fornire risposte accurate e pertinenti. Un’organizzazione chiara e un contesto completo favoriscono sia i lettori sia la comprensione da parte dell’IA.

Struttura e organizzazione

  • Usa markup semantico.
  • Scrivi intestazioni descrittive per le sezioni.
  • Crea una gerarchia informativa logica.
  • Mantieni una formattazione coerente in tutta la documentazione.
  • Includi metadati completi nel frontmatter della pagina.
  • Suddividi i blocchi di testo lunghi in paragrafi più brevi.

Contesto

  • Definisci termini e acronimi specifici alla prima occorrenza.
  • Fornisci un adeguato contenuto concettuale su funzionalità e procedure.
  • Includi esempi e casi d’uso.
  • Rimanda ad argomenti correlati.
  • Aggiungi Pagine nascoste con contesto aggiuntivo che agli utenti non serve, ma che l’Assistente può consultare.

Esportazione e analisi delle query

Esamina ed esporta le query dalla dashboard per capire come gli utenti interagiscono con la tua documentazione e individuare opportunità di miglioramento. Ecco alcuni modi in cui l’analisi delle query può aiutarti a migliorare la documentazione:
  • Individuare lacune nei contenuti in cui le query frequenti ricevono risposte insufficienti.
  • Scoprire schemi di comportamento degli utenti e esigenze informative comuni dai temi e dai modelli presenti nelle query.
  • Dare priorità alle pagine con alto traffico per miglioramenti in accuratezza e qualità.
Puoi esplorare le query dalla dashboard, ma per ottenere insight più approfonditi consigliamo di esportare un file CSV con query, risposte e fonti da analizzare con il tuo strumento di AI preferito.
  1. Vai alla pagina dell’Assistente nella dashboard.
  2. Seleziona Esporta in CSV.
  3. Analizza i dati esportati utilizzando il tuo strumento preferito.

Esempi di prompt di analisi

  • Riassumi i temi più comuni delle query.
  • Elenca le query senza fonti citate.
  • Individua modelli nelle interazioni non riuscite.