Assistant

Aidez vos utilisateurs à réussir avec votre produit et à trouver des réponses plus rapidement

L’Assistant est automatiquement activé avec les formules Pro et Custom.

​

À propos de l’Assistant

L’Assistant répond aux questions sur votre documentation via des requêtes en langage naturel. Il est intégré directement à votre site de documentation, offrant aux utilisateurs un accès immédiat à une aide contextuelle.

L’Assistant utilise un RAG agentique (retrieval-augmented generation) avec appels d’outils, propulsé par Claude Sonnet 4. Lorsque les utilisateurs posent des questions, l’Assistant :

• Recherche et récupère le contenu pertinent de votre documentation pour fournir des réponses précises.
• Cite ses sources et fournit des liens permettant d’accéder directement aux pages référencées.
• Génère des exemples de code prêts à copier pour aider les utilisateurs à mettre en œuvre des solutions à partir de votre documentation.

Chaque message envoyé à l’Assistant est décompté du quota de messages de votre offre. Si vous dépassez ce quota, des frais de dépassement s’appliquent. Vous pouvez définir des limites de dépenses ou désactiver l’Assistant si vous atteignez votre quota.

Vous pouvez consulter l’utilisation de l’Assistant dans votre Dashboard pour comprendre le comportement des utilisateurs et l’efficacité de la documentation. Exportez et analysez les données de requêtes pour identifier :

• Les questions fréquemment posées qui pourraient nécessiter une meilleure couverture.
• Les lacunes de contenu où les utilisateurs peinent à trouver des réponses.
• Les sujets populaires qui pourraient bénéficier de contenu supplémentaire.

​

Configurer l’Assistant

L’Assistant est activé par défaut pour les plans Pro et Custom. Vous pouvez gérer l’Assistant depuis votre Dashboard, notamment l’activer ou le désactiver, configurer le traitement des réponses et définir une limite de dépenses.

​

Statut de l’Assistant

Basculez le statut de l’Assistant pour activer ou désactiver l’Assistant sur votre site de documentation.

​

Délestage par l’Assistant

Activez l’Assistant pour rediriger les questions restées sans réponse vers votre équipe de support. Indiquez une adresse e‑mail que l’Assistant communiquera aux utilisateurs lorsqu’il ne peut pas répondre à leurs questions.

​

Rechercher des sites

La recherche de site est en bêta. Pour l’activer sur votre site de documentation, contactez notre équipe commerciale.

Configurez les sites que l’Assistant peut explorer pour fournir du contexte supplémentaire lorsqu’il répond aux questions.

• Les sites doivent être accessibles publiquement.
• Les sites nécessitant JavaScript pour se charger ne sont pas pris en charge.

Vous pouvez utiliser la syntaxe de filtrage suivante lors de la configuration de sites externes :

• Filtrage au niveau du domaine
  • example.com : Rechercher uniquement le domain example.com
  • docs.example.com : Rechercher uniquement le sous-domaine docs.example.com
  • *.example.com : Rechercher tous les sous-domaines de example.com
• Filtrage au niveau du chemin
  • docs.example.com/api : Rechercher toutes les pages sous le sous-chemin /api
• Modèles multiples
  • Ajoutez plusieurs entrées pour cibler différentes sections d’un site

​

Limite de dépenses

Définissez une limite de dépenses pour contrôler ce qui se passe lorsque vous atteignez votre quota de messages. Par défaut, l’Assistant continue de répondre aux questions des utilisateurs après l’atteinte de votre quota, ce qui génère des dépassements.

Dans l’onglet Billing de la page Assistant Configurations, vous pouvez définir une limite de dépenses pour les messages de l’Assistant au-delà de votre quota. Lorsque vous atteignez votre limite de dépenses, l’Assistant est désactivé jusqu’à la réinitialisation de votre quota de messages.

Vous pouvez également configurer des alertes d’usage pour recevoir un e-mail lorsque vous atteignez un certain pourcentage de votre limite de dépenses.

​

Utiliser l’Assistant

Les utilisateurs peuvent accéder à l’Assistant de trois manières :

• Raccourci clavier : Command + I (Ctrl + I sous Windows)
• Bouton Assistant à côté de la barre de recherche
• Les URL avec ?assistant=open ajouté ouvrent l’Assistant au chargement de la page. Par exemple, https://mintlify.com/docs?assistant=open.

Ces méthodes ouvrent un panneau de conversation sur le côté droit de votre documentation. Les utilisateurs peuvent poser n’importe quelle question et l’Assistant cherchera la réponse dans votre documentation. Si aucune information pertinente n’est trouvée, l’Assistant indiquera qu’il ne peut pas répondre à la question.

​

Rendre le contenu exploitable par l’IA

Structurez votre documentation pour aider l’Assistant à fournir des réponses précises et pertinentes. Une organisation claire et un contexte complet profitent autant aux lecteurs qu’à la compréhension de l’IA.

Structure et organisation

• Utilisez un balisage sémantique.
• Rédigez des titres de section descriptifs.
• Créez une hiérarchie de l’information logique.
• Utilisez une mise en forme cohérente dans toute votre documentation.
• Incluez des metadata complètes dans le frontmatter de la page.
• Scindez les longs blocs de texte en paragraphes plus courts.

Contexte

• Définissez les termes et acronymes spécifiques lors de leur première apparition.
• Fournissez un contenu conceptuel suffisant sur les fonctionnalités et les procédures.
• Incluez des exemples et des cas d’usage.
• Faites des renvois vers les sujets connexes.
• Ajoutez des pages cachées avec du contexte supplémentaire dont les utilisateurs n’ont pas besoin, mais que l’Assistant peut consulter.

​

Exporter et analyser les requêtes

Examinez et exportez les requêtes depuis votre Dashboard pour comprendre comment les utilisateurs interagissent avec votre documentation et identifier des pistes d’amélioration. Voici quelques manières dont l’analyse des requêtes peut vous aider à améliorer votre documentation :

• Identifier les lacunes de contenu lorsque des requêtes fréquentes reçoivent des réponses insuffisantes.
• Mettre en évidence des tendances de comportement et des besoins d’information récurrents à partir des thèmes et motifs présents dans les requêtes.
• Prioriser les pages à fort trafic pour améliorer l’exactitude et la qualité.

Vous pouvez explorer les requêtes depuis votre Dashboard, mais pour obtenir des analyses plus poussées, nous recommandons d’exporter un fichier CSV de vos requêtes, réponses et sources afin de l’analyser avec votre outil d’IA préféré.

1. Accédez à la page Assistant dans votre Dashboard.
2. Sélectionnez Export to CSV.
3. Analysez les données exportées avec votre outil préféré.

Exemples d’invites d’analyse

• Résumer les thèmes les plus fréquents des requêtes.
• Lister les requêtes sans sources citées.
• Identifier des motifs dans les interactions infructueuses.