Passer au contenu principal
L’Assistant est automatiquement activé sur 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, afin que les utilisateurs puissent trouver rapidement des réponses et réussir avec votre produit. L’Assistant utilise un RAG agentique (retrieval-augmented generation) avec appel d’outils, propulsé par Claude Opus 4.5. Lorsque les utilisateurs posent des questions, l’Assistant :
  • Recherche et extrait le contenu pertinent de votre documentation pour fournir des réponses précises.
  • Cite ses sources et fournit des liens navigables pour amener les utilisateurs directement aux pages référencées.
  • Génère des exemples de code copiables pour aider les utilisateurs à mettre en œuvre des solutions à partir 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, les messages supplémentaires entraînent des frais de dépassement. 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 depuis votre Dashboard pour comprendre le comportement des utilisateurs et l’efficacité de votre documentation. Exportez et analysez les données de requête pour vous aider à 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 offres Pro et Custom. Gérez l’assistant depuis votre Dashboard à l’adresse suivante : 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 un plafond 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.

​
Emplacement des contrôles

Sélectionnez où l’Assistant apparaît sur votre site de documentation. Choisissez entre une bulle de discussion flottante en bas de page ou un bouton à côté de la barre de recherche.
Le panneau d’emplacement de l’Assistant dans le Dashboard avec l’option « bas de page » sélectionnée.

​
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.

​
Rechercher sur des sites

La recherche sur le site est en version bêta. Pour l’activer pour votre site de documentation, contactez notre équipe commerciale.
Dans la section de traitement des réponses, configurez les sites que l’Assistant peut explorer pour fournir un contexte supplémentaire lorsqu’il répond aux questions.
  • Les sites doivent être publiquement accessibles.
  • 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 sur 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 sur le domaine example.com
    • docs.example.com : Rechercher uniquement sur le sous-domaine docs.example.com
    • *.example.com : Rechercher sur tous les sous-domaines de example.com
  • Filtrage au niveau du chemin
    • docs.example.com/api : Rechercher sur 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 disposent de plusieurs manières de démarrer une conversation avec l’Assistant. Chaque méthode ouvre un panneau de discussion 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.

​
Emplacement dans l’interface

Selon la manière dont vous configurez l’emplacement de votre Assistant, celui-ci apparaît soit sous la forme d’un bouton à côté de la barre de recherche, soit sous la forme d’une barre en bas de la page.
Barre de recherche et bouton de l’Assistant en mode clair.

Bouton de l’Assistant à côté de la barre de recherche.

Barre de l’Assistant en mode clair.

Bouton de l’Assistant en bas de la page.

​
Raccourci clavier

Ouvrez le panneau de discussion de l’Assistant avec le raccourci clavier Command + I sur macOS et Ctrl + I sur Windows.

​
Mettre du texte en surbrillance

Mettez du texte en surbrillance sur une page, puis cliquez sur le bouton contextuel Ajouter à l’Assistant pour ouvrir le panneau de discussion de l’Assistant et ajouter le texte mis en surbrillance en tant que contexte. Vous pouvez ajouter plusieurs extraits de texte ou blocs de code au contexte de l’Assistant.
Le bouton « Ajouter à l’Assistant » au-dessus du texte surligné en mode clair.

​
Code blocks

Cliquez sur le bouton Ask AI dans un code block pour ouvrir le panneau de discussion de l’Assistant et ajouter le code block comme contexte. Vous pouvez ajouter plusieurs code blocks ou extraits de texte au contexte de l’Assistant.
Le bouton Ask AI dans un code block en mode clair.

​
URL

Ajoutez ?assistant=open à une URL pour ouvrir l’Assistant lors du chargement de la page. Par exemple, https://mintlify.com/docs?assistant=open.

​
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 humains 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 logique de l’information.
  • Utilisez une mise en forme cohérente dans toute votre documentation.
  • Incluez 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 spécifiques et les 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 les 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

Passez en revue et exportez les requêtes depuis votre Dashboard pour comprendre comment les utilisateurs interagissent avec votre documentation et identifier des opportunités 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 lorsque des requêtes fréquentes reçoivent des réponses insuffisantes.
  • Découvrir des schémas de comportement utilisateur et des besoins d’information courants à partir des thèmes récurrents dans les requêtes.
  • Prioriser les pages à fort trafic pour en améliorer la précision et la qualité.
Vous pouvez explorer les requêtes depuis votre Dashboard, mais pour obtenir des analyses plus approfondies, nous vous recommandons d’exporter un fichier CSV contenant vos requêtes, réponses et sources afin de l’analyser avec votre outil d’IA préféré.
  1. Accédez à la page de l’Assistant dans votre Dashboard.
  2. Cliquez sur Chat history.
  3. Cliquez sur Export to CSV.
  4. Analysez les données exportées avec votre outil préféré.

Exemples de prompts d'analyse

  • Résumez les thèmes les plus fréquents des requêtes.
  • Dressez la liste des requêtes pour lesquelles aucune source n’a été citée.
  • Identifiez des schémas dans les interactions infructueuses.

​
Informations de l’Assistant

Utilisez les insights de l’Assistant pour comprendre comment les utilisateurs interagissent avec votre documentation, au travers de deux vues : catégories et historique de conversation.

​
Catégories

L’onglet Catégories utilise des LLM pour classer automatiquement les conversations. Les catégories affichent un résumé du sujet ou du thème, la date de la dernière question posée sur la catégorie, ainsi que le nombre de questions qui ont été posées sur cette catégorie au fil du temps. Utilisez les catégories pour identifier les sujets récurrents, les tendances des besoins et comportements des utilisateurs, ainsi que les domaines où la documentation pourrait nécessiter un enrichissement ou des clarifications. Cliquez sur une catégorie pour afficher les conversations spécifiques à cette catégorie. Vous pouvez ensuite cliquer sur une conversation pour voir l’intégralité du fil de discussion, incluant la question de l’utilisateur, la réponse de l’Assistant, ainsi que toutes les sources citées.

​
Historique des conversations

L’onglet Historique des conversations affiche l’enregistrement chronologique de toutes les conversations avec l’Assistant. Cliquez sur n’importe quel message pour afficher l’intégralité du fil de discussion, y compris la question de l’utilisateur, la réponse de l’Assistant et toutes les sources citées.

​
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.