Assistant

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

L’Assistant est automatiquement activé avec les offres 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 appel 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 copiables pour aider les utilisateurs à mettre en œuvre des solutions issues de votre documentation.

Chaque message envoyé à l’Assistant est décompté de l’allocation de messages de votre offre. Si vous dépassez cette allocation, des frais de dépassement s’appliquent aux messages supplémentaires. Vous pouvez définir des limites de dépenses ou désactiver l’Assistant lorsque vous atteignez votre allocation.

Vous pouvez consulter l’utilisation de l’Assistant dans votre tableau de bord 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 ont du mal à trouver des réponses.
• Les sujets populaires qui pourraient bénéficier de contenu supplémentaire.

​

Configuration de l’Assistant

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

​

Statut de l’Assistant

Activez ou désactivez l’Assistant pour votre site de documentation.

​

Délestage de l’Assistant

Permettez à l’Assistant de rediriger les questions restées sans réponse vers votre équipe de support. Indiquez une adresse e‑mail que l’Assistant fournira aux utilisateurs qui posent des questions auxquelles il ne peut pas répondre.

​

Sites de recherche

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

Configurez les sites que l’Assistant peut consulter pour fournir un contexte supplémentaire lors des réponses aux questions.

• Les sites doivent être accessibles publiquement.
• Les sites qui nécessitent 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 domaine 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
• Plusieurs modèles
  • Ajoutez plusieurs entrées pour cibler différentes sections de sites

​

Plafond de dépenses

Définissez un plafond 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 que vous avez atteint votre quota, ce qui génère des dépassements.

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

Vous pouvez également configurer des alertes d’utilisation pour recevoir un e‑mail lorsque vous atteignez un certain pourcentage de votre plafond de dépenses.

​

Utiliser l’Assistant

Les utilisateurs peuvent accéder à l’Assistant de trois façons :

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

Ces méthodes ouvrent un panneau de chat sur le côté droit de votre documentation. Les utilisateurs peuvent poser n’importe quelle question et l’Assistant cherchera une 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 à la fois aux lecteurs et à 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.
• Appliquez une mise en forme cohérente dans l’ensemble de la documentation.
• Ajoutez des métadonnées 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 lors de leur première occurrence.
• Fournissez suffisamment de contenu conceptuel sur les fonctionnalités et les procédures.
• Incluez des exemples et des cas d’usage.
• Faites des renvois aux sujets liés.
• Ajoutez des pages cachées avec du contexte supplémentaire inutile aux utilisateurs, mais que l’Assistant peut consulter.

​

Exportation et analyse des requêtes

Passez en revue et exportez les requêtes depuis votre tableau de bord pour comprendre comment les utilisateurs interagissent avec votre documentation et identifier des pistes d’amélioration. Voici quelques façons dont l’analyse des requêtes peut vous aider à améliorer votre documentation :

• Identifier les lacunes de contenu où des requêtes fréquentes obtiennent des réponses insuffisantes.
• Mettre au jour des tendances de comportement et des besoins d’information récurrents à partir des thèmes et motifs des requêtes.
• Prioriser les pages à fort trafic pour améliorer l’exactitude et la qualité.

Vous pouvez explorer les requêtes depuis votre tableau de bord, mais pour obtenir des analyses plus pertinentes, 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 tableau de bord.
2. Sélectionnez Exporter au format 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 source citée.
• Repérer des motifs dans les interactions infructueuses.