1. Aggiungi la documentazione pubblica e prova domande reali
Free è permanente: un sito, fino a 10 pagine e 100 messaggi al mese, senza carta di credito. Controlla risposte e fonti, poi incorpora il widget quando sei pronto.
Inizia dalla documentazione pubblica, prova domande tecniche reali e controlla le pagine sorgente collegate prima di aggiungere il widget al tuo sito.
Free è permanente: un sito, fino a 10 pagine e 100 messaggi al mese, senza carta di credito. Controlla risposte e fonti, poi incorpora il widget quando sei pronto.
I chatbot AI generalisti cercano di fare conversazione. Senza un ancoraggio alle fonti, possono rispondere con sicurezza usando il contesto sbagliato.
Usiamo la generazione aumentata dal recupero sui tuoi docs pubblicati e sui contenuti del sito, poi mostriamo i link alle fonti da cui provengono le risposte.
Per i team che richiedono prove visibili in ogni risposta, confronta il workflow di un chatbot IA con fonti citate che mantiene il traffico della documentazione collegato alle pagine di supporto.
Usa le domande che ricevi già nei canali di supporto e della community. Controlla ogni risposta e la pagina sorgente collegata prima di pubblicare il widget.
"Come posso iniziare, autenticarmi ed effettuare la mia prima richiesta?"
"Che cosa significa questo errore e dove è documentata la correzione?"
"Quali sono i limiti del piano, i limiti di tariffa e i prezzi per questa funzionalità?"
"Devo migrare la mia piattaforma di documenti o questa può essere affiancata al mio sito attuale?"
Usa il chatbot per aiutare gli sviluppatori a trovare endpoint, passaggi di autenticazione, parametri, metodi SDK ed errori noti, poi torna alla documentazione di riferimento per il contesto completo. Un esempio di codice plausibile o una citazione visibile non dimostra che il comportamento dell’API sia corretto.
Crea il set di test a partire da attività reali sulla documentazione, associa una fonte di riferimento e i fatti attesi a ogni domanda a cui è possibile rispondere e includi domande che l'assistente deve rifiutare. Valuta ogni categoria separatamente, affinché un buon risultato sulle API non nasconda indicazioni carenti sulla migrazione o sull'autenticazione.
Esegui nuovamente la suite prima del lancio, dopo modifiche sostanziali alla documentazione o al recupero e, dopo il lancio, su un campione mensile pianificato.
| Area della domanda | Fixture di test | Condizione di superamento |
|---|---|---|
Area della domanda API | Fixture di test Endpoint, campi obbligatori, struttura della risposta e limite di frequenza. | Condizione di superamento Usa il metodo e il percorso documentati; i valori obbligatori e la citazione corrispondono al riferimento. |
Area della domanda SDK | Fixture di test Installa e inizializza una versione supportata dell'SDK. | Condizione di superamento Pacchetto, importazione, inizializzazione e sintassi del codice corrispondono al linguaggio e alla versione. |
Area della domanda CLI | Fixture di test Installa, esegui l'autenticazione, avvia un comando e interpretane l'output. | Condizione di superamento I flag e l'ordine sono validi; la risposta non inventa prompt interattivi. |
Area della domanda Autenticazione | Fixture di test Posizione delle credenziali, formato dell'header, ambiti e un flusso vietato. | Condizione di superamento Non espone mai un segreto, distingue l'uso sul client da quello sul server e cita il requisito di sicurezza. |
Area della domanda Impaginazione | Fixture di test Prima pagina, continuazione, pagina finale e dimensione massima della pagina. | Condizione di superamento Usa il modello documentato basato su cursore o offset e indica solo i limiti documentati. |
Area della domanda Errori | Fixture di test Codice di errore noto, causa probabile, passaggio di ripristino e codice sconosciuto. | Condizione di superamento Associa correttamente gli errori noti e usa il fallback per le cause non documentate. |
Area della domanda Migrazioni | Fixture di test Modifica incompatibile, prerequisito, passaggi ordinati e nota sul rollback. | Condizione di superamento Preserva la sequenza e gli avvisi senza mescolare procedure vecchie e nuove. |
Area della domanda Documentazione con versioni | Fixture di test Poni la stessa domanda sul comportamento per la versione corrente, quella precedente e una versione non specificata. | Condizione di superamento Risponde per la versione indicata, chiede chiarimenti in caso di ambiguità e cita quella versione. |
Pubblica le regole prima dei test. I revisori devono giungere allo stesso risultato in base alla risposta, ai fatti attesi e alla fonte citata, senza basarsi su quanto la risposta sembri convincente.
| Dimensione | Accetta solo quando |
|---|---|
Dimensione Qualità della risposta | Accetta solo quando Tutti i fatti richiesti sono corretti, pertinenti, non contraddittori e usano la versione richiesta dell'API, dell'SDK, della CLI o della documentazione. |
Dimensione Accuratezza delle citazioni | Accetta solo quando Ogni affermazione sostanziale ha una citazione accessibile che la supporta direttamente nella pagina della versione corretta. |
Dimensione Comportamento di fallback | Accetta solo quando Evidenze mancanti, ambigue, contrastanti o non autorizzate producono una limitazione chiara e un passaggio successivo utile anziché un'ipotesi. |
Dimensione Criterio di lancio | Accetta solo quando Nessuna affermazione critica non supportata sull'autenticazione o sulla migrazione, superamento del 100% dei casi critici, almeno il 90% di accettazione complessiva e almeno il 95% di accuratezza delle citazioni. |
Metodo: scrivi 24 domande prima di eseguire l'assistente, tre per ogni area della matrice. Per ogni domanda, registra la versione prevista, la pagina di riferimento, i fatti richiesti, le affermazioni vietate e se è previsto il fallback. Due revisori valutano in modo indipendente le risposte congelate, risolvono le divergenze confrontandole con la fonte e conservano i prompt e gli output per i test di regressione.
Ogni dato riportato di seguito è un esempio ipotetico per uno scenario di 24 domande, non un risultato misurato di ChattyBox, una media di produzione o una promessa di prestazioni future.
| Risultato di esempio, non misurato | Come usare l'esempio |
|---|---|
Risultato di esempio, non misurato Esempio: 22 risposte accettate su 24 (91.7%) | Come usare l'esempio Interpretazione di esempio: 20 risposte supportate e due fallback corretti. |
Risultato di esempio, non misurato Esempio: 20 risposte sostanziali su 22 citavano direttamente pagine di supporto (90.9%) | Come usare l'esempio Interpretazione di esempio: al di sotto del criterio di lancio del 95%, quindi è necessario correggere il ranking della versione. |
Risultato di esempio, non misurato Esempio: i 2 fallback previsti su 2 erano corretti (100%) | Come usare l'esempio Interpretazione di esempio: in questo piccolo scenario di test, nessun caso a cui si poteva rispondere ha attivato erroneamente il fallback. |
Risultato di esempio, non misurato Esempio: 1 risposta su 24 conteneva un dettaglio di paginazione non supportato (4.2%) | Come usare l'esempio Interpretazione di esempio: blocca il lancio finché l'affermazione non supportata non viene rimossa e il test di regressione non viene superato. |
Workflow progettati per mantenere le risposte tracciabili, basate sulle fonti e utili per gli utenti tecnici.
Inserisci l'URL della documentazione, del sito o della sitemap. ChattyBox esegue la scansione e indicizza le pagine che gli utenti già leggono.
Il flusso di risposta è configurato per usare il contesto recuperato ed evitare affermazioni non supportate su API, funzionalità, prezzi o policy.
Le risposte possono includere link alle pagine della documentazione dove si trovano le informazioni rilevanti.
Tratta il lancio come una release della documentazione, con responsabili, criteri, osservabilità e un percorso di rollback.
Segmenta ogni metrica per argomento, versione della documentazione, lingua e pubblico quando la dimensione del campione lo consente. Le tendenze e i campioni esaminati sono più utili di un singolo punteggio aggregato.
| Metrica | Definizione e azione |
|---|---|
Metrica Tasso di risposta | Definizione e azione Quota di domande che ricevono una risposta sostanziale. Esamina gli argomenti con un tasso basso per individuare contenuti mancanti; non migliorare il dato indebolendo il fallback. |
Metrica Domande irrisolte | Definizione e azione Domande con fallback, feedback negativo, riformulazioni ripetute o escalation. Esaminane un campione settimanale per rilevare difetti nelle risposte e nel recupero. |
Metrica Lacune nei contenuti | Definizione e azione Gruppi irrisolti per i quali non esiste una pagina autorevole. Inseriscili nel backlog della documentazione indicando frequenza e impatto sugli utenti. |
Metrica Tasso di supporto delle citazioni | Definizione e azione Affermazioni sostanziali esaminate con una citazione di supporto diretto. Analizza i cali per fonte e versione. |
Metrica Riduzione dei ticket | Definizione e azione Sessioni idonee risolte senza un ticket di assistenza, misurate in un intervallo definito e confrontate con un valore di riferimento. Indica una correlazione, a meno che un esperimento non dimostri la causalità. |
Usa la guida all'architettura e alla valutazione RAG per diagnosticare il recupero, il flusso di lavoro delle citazioni per esaminare le evidenze, la verifica della documentazione API per i casi d'uso specifici di ingegneria e la checklist tecnica di lancio per i passaggi di distribuzione.
Queste risposte riassumono il modo in cui ChattyBox legge il contenuto originale, cita le pagine della documentazione, gestisce le informazioni mancanti e si installa insieme a uno stack di documenti esistente.
Sì, quando riferimenti agli endpoint, parametri, guide all’autenticazione, esempi SDK e dettagli sugli errori sono presenti in contenuti pubblici indicizzati. Non esegue chiamate API né ispeziona account privati. Il contesto recuperato e le citazioni non eliminano comportamenti API inventati: verifica le affermazioni importanti con la documentazione di riferimento.
No. Free è una prova permanente e di portata ridotta: un sito, fino a 10 pagine e 100 messaggi al mese, senza carta di credito.
Inizia dalle pagine pubbliche che rispondono alle domande comuni su configurazione, risoluzione dei problemi, prezzi e prodotto. Puoi ampliare l'insieme delle fonti dopo aver controllato le prime risposte.
Aggiungi altre pagine quando il primo set di test è utile e le fonti di supporto sono aggiornate. Escludi dal chatbot le pagine private, obsolete e non pertinenti.
Sì. Esegui il crawl della documentazione pubblica selezionata, poni domande tecniche reali e apri le pagine sorgente citate per verificare le risposte prima di installare il widget.
L'assistente dovrebbe indicare il limite o offrire un utile passo successivo invece di indovinare. Tratta le risposte non supportate come un caso di test e una possibile lacuna documentale da rivedere.
Inizia con il piano Free permanente per provare pagine pubbliche selezionate, testa domande tecniche e controlla le fonti prima di incorporare il widget.
Utilizziamo strumenti facoltativi di analisi e gestione dei tag per capire come viene utilizzato il sito. Scegli se consentire Ahrefs Web Analytics, PostHog e Google Tag Manager. Se disattivi l’analisi, questa pagina verrà ricaricata affinché la modifica venga applicata correttamente. Le funzionalità essenziali del sito e il monitoraggio degli errori non dipendono da questa scelta. Leggi la nostra informativa sulla privacy.