Passer au contenu principal
L’Assistant est activé automatiquement 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 (génération augmentée par récupération) 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 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 forfait. Si vous dépassez cette allocation, 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 allocation de messages. 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ête afin d’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 formules Pro et Custom. Gérez l’Assistant depuis votre Dashboard. Cliquez sur Configuration pour activer ou désactiver l’Assistant, configurer la gestion des réponses, ajouter des questions par défaut et définir une limite de dépenses.
La barre d’outils de l’Assistant dans le Dashboard. Le bouton Configuration est mis en évidence par un rectangle orange.

​
Activer ou désactiver l’Assistant

Activez ou désactivez l’Assistant pour votre site de documentation à l’aide de l’interrupteur dédié.
L’interrupteur d’état de l’Assistant dans le Dashboard.

​
Définir l’adresse e‑mail de redirection

Dans la section de gestion des réponses, activez l’Assistant pour rediriger vers votre équipe d’assistance les questions restées sans réponse. Indiquez l’adresse e‑mail que l’Assistant communiquera aux utilisateurs lorsqu’il ne peut pas répondre à leur question.
Le panneau de redirection de l’Assistant dans le Dashboard. La redirection de l’Assistant est activée et support@mintlify.com est défini comme adresse e‑mail de redirection.

​
Recherche sur des sites

La recherche sur site est en bêta. Pour l’activer sur votre site de documentation, contactez notre équipe commerciale.
Dans la section de gestion des réponses, configurez les sites que l’Assistant peut explorer pour obtenir du contexte supplémentaire lorsqu’il répond aux questions.
  • Les sites doivent être accessibles publiquement.
  • Les sites qui nécessitent JavaScript pour se charger ne sont pas pris en charge.
Le panneau de recherche de sites de l’Assistant dans le Dashboard. L’Assistant est configuré pour rechercher les domaines mintlify.com et mintlify.com/blog.
Utilisez la syntaxe de filtrage suivante pour contrôler plus précisément ce que l’Assistant peut rechercher :
  • 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
  • Modèles multiples
    • Ajoutez plusieurs entrées pour cibler différentes sections de sites

​
Ajouter des exemples de questions

Aidez vos utilisateurs à lancer leurs questions avec l’Assistant en ajoutant des exemples. Dans la section Suggestions de recherche, ajoutez jusqu’à trois exemples de questions.
Le panneau Suggestions de recherche dans le Dashboard. « What is an OpenAPI spec? » est configuré comme exemple de question.

​
Définir une limite de dépenses

Définissez une limite de dépenses pour contrôler ce qui se passe si 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 de messages, ce qui génère des dépassements. Lorsque vous atteignez votre limite de dépenses, l’Assistant est désactivé jusqu’à la réinitialisation de votre quota de messages.
  1. Sélectionnez l’onglet Billing.
L’onglet Billing sur la page Assistant Configurations. L’onglet Billing est mis en évidence par un rectangle orange.
  1. Définissez une limite de dépenses pour les messages de l’Assistant au-delà de votre quota.
  2. Configurez des alertes d’utilisation 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 Barre de recherche et bouton Assistant en mode clair.
  • Les URL avec ?assistant=open ajouté ouvrent l’Assistant au chargement de la page. Par exemple, https://mintlify.com/docs?assistant=open.
Chaque méthode ouvre un panneau de conversation sur le côté droit de votre documentation. Les utilisateurs peuvent poser n’importe quelle question et l’Assistant recherche une réponse dans votre documentation. Si aucune information pertinente n’est trouvée, l’Assistant indique 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 descriptifs pour les sections.
  • 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 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 des sujets connexes.
  • Ajoutez des pages cachées avec du contexte supplémentaire dont les utilisateurs n’ont pas besoin, mais auquel l’Assistant peut se référer.

​
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 façons dont l’analyse des requêtes peut vous aider à améliorer votre documentation :
  • Repérer les lacunes de contenu lorsque des requêtes fréquentes reçoivent des réponses insuffisantes.
  • Mettre en évidence des comportements utilisateurs 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 la précision et la qualité.
Vous pouvez explorer les requêtes depuis votre Dashboard, mais pour obtenir des insights plus approfondis, 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ésumez les thèmes les plus fréquents des requêtes.
  • Listez les requêtes pour lesquelles aucune source n’a été citée.
  • Identifiez des motifs dans les interactions infructueuses.

​
Dépannage

Si l’interface de l’Assistant n’est pas visible dans certains navigateurs, vous devrez peut-être signaler un faux positif à EasyList. Les navigateurs qui utilisent la EasyList Cookies List, comme Brave et Comet, bloquent parfois l’Assistant ou d’autres éléments de l’interface. La EasyList Cookies List contient une règle spécifique à certains domaines qui masque les éléments fixes pour bloquer les bannières de cookies. Cette règle affecte par inadvertance des composants d’interface légitimes.Signalez un faux positif à EasyList pour demander la suppression de cette règle. Le problème sera alors résolu pour tous les utilisateurs une fois la liste de filtres mise à jour.
⌘I