1. Ajoutez des docs publiques et testez de vraies questions
L'offre Free est permanente : un site, jusqu'à 10 pages et 100 messages par mois, sans carte bancaire. Vérifiez les réponses et les sources, puis intégrez le widget lorsque vous êtes prêt.
Commencez par vos docs publiques, testez de vraies questions techniques et vérifiez les sources liées avant d'ajouter le widget à votre site.
L'offre Free est permanente : un site, jusqu'à 10 pages et 100 messages par mois, sans carte bancaire. Vérifiez les réponses et les sources, puis intégrez le widget lorsque vous êtes prêt.
Les chatbots IA à usage général essaient de converser avec l'utilisateur. Lorsqu'ils ne connaissent pas la réponse, ils l'inventent.
Nous utilisons la génération augmentée par récupération sur vos docs publiées et le contenu de votre site, puis nous affichons les liens sources d'où viennent les réponses.
Pour les équipes qui ont besoin de preuves visibles dans chaque réponse, comparez le workflow d’un chatbot IA avec sources citées qui relie le trafic de documentation aux pages de référence.
Utilisez les questions que vos équipes de support et vos canaux communautaires reçoivent déjà. Vérifiez chaque réponse et sa page source liée avant de publier le widget.
« Comment puis-je démarrer, m'authentifier et faire ma première demande ? »
« Que signifie cette erreur et où le correctif est-il documenté ? »
« Quelles sont les limites du forfait, les limites de tarif et les tarifs de cette fonctionnalité ? »
« Dois-je migrer ma plate-forme de documents ou celle-ci peut-elle être placée à côté de mon site actuel ? »
Utilisez le chatbot pour aider les développeurs à trouver les endpoints, les étapes d’authentification, les paramètres, les méthodes du SDK et les erreurs connues, puis revenez à la référence pour le contexte complet. Un exemple de code plausible ou une citation visible ne prouve pas que le comportement de l’API est correct.
Constituez le jeu de tests à partir de tâches documentaires réelles, associez une source de référence et les faits attendus à chaque question traitable, et incluez des questions auxquelles l'assistant doit refuser de répondre. Évaluez chaque catégorie séparément afin qu'un bon résultat sur les API ne masque pas des consignes insuffisantes sur les migrations ou l'authentification.
Relancez la suite avant la mise en ligne, après toute modification importante de la documentation ou de la récupération, puis chaque mois sur un échantillon planifié après le lancement.
| Domaine de la question | Cas de test | Condition de réussite |
|---|---|---|
Domaine de la question API | Cas de test Point de terminaison, champs obligatoires, structure de la réponse et limite de débit. | Condition de réussite Utilise la méthode et le chemin documentés ; les valeurs requises et la citation concordent avec la référence. |
Domaine de la question SDK | Cas de test Installer et initialiser une version prise en charge du SDK. | Condition de réussite Le paquet, l'importation, l'initialisation et la syntaxe du code correspondent au langage et à la version concernés. |
Domaine de la question CLI | Cas de test Installer, s'authentifier, exécuter une commande et interpréter sa sortie. | Condition de réussite Les options et leur ordre sont valides ; la réponse n'invente aucune invite interactive. |
Domaine de la question Authentification | Cas de test Emplacement des identifiants, format de l'en-tête, portées et exemple de flux interdit. | Condition de réussite N'expose jamais de secret, distingue les usages côté client et côté serveur, et cite l'exigence de sécurité. |
Domaine de la question Pagination | Cas de test Première page, continuation, dernière page et taille maximale d'une page. | Condition de réussite Utilise le modèle documenté de curseur ou de décalage et ne mentionne que les limites documentées. |
Domaine de la question Erreurs | Cas de test Code d'erreur connu, cause probable, étape de résolution et code inconnu. | Condition de réussite Associe correctement les erreurs connues et adopte un comportement de repli pour les causes non documentées. |
Domaine de la question Migrations | Cas de test Rupture de compatibilité, prérequis, étapes ordonnées et note de retour arrière. | Condition de réussite Respecte l'ordre et les avertissements sans mélanger les anciennes et les nouvelles procédures. |
Domaine de la question Documentation versionnée | Cas de test Poser la même question de comportement pour la version actuelle, la version précédente et une version non précisée. | Condition de réussite Répond pour la version indiquée, demande une précision en cas d'ambiguïté et cite cette version. |
Publiez les règles avant les tests. Les réviseurs doivent parvenir au même résultat à partir de la réponse, des faits attendus et de la source citée, sans se laisser influencer par le caractère convaincant de la formulation.
| Dimension | Accepter uniquement si |
|---|---|
Dimension Qualité de la réponse | Accepter uniquement si Tous les faits requis sont exacts, pertinents, non contradictoires et utilisent la version demandée de l'API, du SDK, de la CLI ou de la documentation. |
Dimension Exactitude des citations | Accepter uniquement si Toute affirmation importante comporte une citation accessible qui l'étaye directement sur la bonne page versionnée. |
Dimension Comportement de repli | Accepter uniquement si Des éléments manquants, ambigus, contradictoires ou non autorisés entraînent l'indication claire d'une limite et d'une prochaine étape utile, plutôt qu'une supposition. |
Dimension Critère de mise en ligne | Accepter uniquement si Aucune affirmation critique non étayée sur l'authentification ou les migrations, 100 % de réussite sur les cas critiques, au moins 90 % d'acceptation globale et au moins 95 % d'exactitude des citations. |
Méthode : rédigez 24 questions avant d'exécuter l'assistant, soit trois par domaine de la matrice. Pour chaque question, consignez la version visée, la page de référence, les faits requis, les affirmations interdites et le comportement de repli attendu. Deux réviseurs évaluent indépendamment les réponses figées, tranchent leurs désaccords à partir de la source et conservent les invites et les sorties pour les tests de régression.
Chaque chiffre ci-dessous est un exemple hypothétique pour un jeu de 24 questions, et non un résultat mesuré de ChattyBox, une moyenne de production ou une promesse de performances futures.
| Résultat d'exemple, non mesuré | Comment utiliser l'exemple |
|---|---|
Résultat d'exemple, non mesuré Exemple : 22 réponses acceptées sur 24 (91.7%) | Comment utiliser l'exemple Interprétation de l'exemple : 20 réponses étayées et deux replis corrects. |
Résultat d'exemple, non mesuré Exemple : 20 des 22 réponses substantielles citaient directement des pages d'appui (90.9%) | Comment utiliser l'exemple Interprétation de l'exemple : en dessous du seuil de mise en ligne de 95%, le classement des versions doit être corrigé. |
Résultat d'exemple, non mesuré Exemple : les 2 replis attendus sur 2 étaient corrects (100%) | Comment utiliser l'exemple Interprétation de l'exemple : aucun cas auquel il était possible de répondre n'a déclenché un repli incorrect dans ce petit jeu de test. |
Résultat d'exemple, non mesuré Exemple : 1 réponse sur 24 contenait un détail de pagination non étayé (4.2%) | Comment utiliser l'exemple Interprétation de l'exemple : bloquez la mise en ligne jusqu'à la suppression de l'affirmation non étayée et à la réussite du test de régression. |
Des workflows conçus pour maintenir des réponses traçables, fondées sur les sources et utiles pour les utilisateurs techniques.
Entrez l’URL de vos docs, de votre site ou de votre sitemap. ChattyBox explore et indexe les pages que vos utilisateurs consultent déjà.
Le flux de réponse est configuré pour utiliser le contexte récupéré et éviter les affirmations non étayées sur les API, les fonctionnalités, les prix ou les politiques.
Les réponses peuvent inclure des liens vers les pages de documentation où se trouve l'information pertinente.
Traitez la mise en ligne comme une publication de documentation, avec des responsables, des critères, de l'observabilité et une procédure de retour arrière.
Segmentez chaque indicateur par sujet, version de documentation, langue et public lorsque la taille de l'échantillon le permet. Les tendances et les échantillons examinés sont plus utiles qu'un score global unique.
| Indicateur | Définition et action |
|---|---|
Indicateur Taux de réponse | Définition et action Part des questions recevant une réponse substantielle. Recherchez les contenus manquants pour les sujets à faible taux ; n'améliorez pas ce chiffre en assouplissant le comportement de repli. |
Indicateur Questions non résolues | Définition et action Questions ayant entraîné un repli, un retour négatif, des reformulations répétées ou une escalade. Examinez-en un échantillon chaque semaine pour détecter les défauts de réponse et de récupération. |
Indicateur Lacunes dans le contenu | Définition et action Groupes non résolus pour lesquels aucune page de référence n'existe. Ajoutez-les au carnet de la documentation avec leur fréquence et leur impact sur les utilisateurs. |
Indicateur Taux d'étaiement par les citations | Définition et action Part des affirmations importantes examinées qui disposent d'une citation directe à l'appui. Analysez les baisses par source et par version. |
Indicateur Déviation des tickets | Définition et action Sessions admissibles résolues sans ticket d'assistance, mesurées sur une période définie et comparées à une référence. Signalez une association, sauf si une expérience établit un lien de causalité. |
Utilisez le guide d'architecture et d'évaluation RAG pour diagnostiquer la récupération, le processus de citation pour examiner les éléments probants, le contrôle de la documentation API pour les cas d'usage propres à l'ingénierie, ainsi que la liste de contrôle technique avant la mise en ligne pour les étapes de déploiement.
Ces réponses résument la façon dont ChattyBox lit le contenu source, cite les pages de documentation, gère les informations manquantes et s'installe avec une pile de documents existante.
Oui, lorsque les références d’endpoints, paramètres, guides d’authentification, exemples de SDK et détails d’erreur figurent dans le contenu public indexé. Il n’exécute pas d’appels API et n’inspecte pas les comptes privés. Le contexte récupéré et les citations n’éliminent pas les comportements d’API inventés ; testez les affirmations importantes avec la référence.
Non. Free est une preuve permanente à petite échelle : un site, jusqu'à 10 pages et 100 messages par mois, sans carte bancaire.
Commencez par les pages publiques qui répondent aux questions courantes sur la configuration, le dépannage, les tarifs et le produit. Vous pourrez élargir l'ensemble de sources après avoir vérifié les premières réponses.
Ajoutez des pages lorsque le premier jeu de tests est utile et que les sources associées sont à jour. Excluez du chatbot les pages privées, obsolètes et sans rapport.
Oui. Explorez les docs publics sélectionnés, posez de vraies questions techniques et ouvrez les pages sources citées pour vérifier les réponses avant d'installer le widget sur votre site de docs.
L'assistant doit indiquer la limite ou proposer une prochaine étape utile plutôt que de deviner. Traitez les réponses non prises en charge comme un cas de test et comme une éventuelle lacune documentaire à examiner.
Commencez avec l’offre Free permanente sur quelques pages publiques, testez des questions techniques et examinez les sources avant d’intégrer le widget.
Nous utilisons des outils facultatifs d’analyse et de gestion des balises pour comprendre l’utilisation du site. Choisissez d’autoriser ou non Ahrefs Web Analytics, PostHog et Google Tag Manager. La désactivation des outils d’analyse recharge cette page afin que la modification soit appliquée proprement. Les fonctionnalités essentielles du site et la surveillance des erreurs ne sont pas régies par ce choix. Lire notre politique de confidentialité.