Utiliser l'assistant

Ouvrez l’assistant via raccourcis clavier, texte surligné, blocs de code, pièces jointes ou paramètres d’URL, et testez-le en prévisualisation locale.

Les utilisateurs disposent de plusieurs moyens pour démarrer une conversation avec l’assistant. Chaque méthode ouvre un panneau de chat 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 l’assistant ne parvient pas à récupérer des informations pertinentes, il répond qu’il ne peut pas répondre à la question.

​

Utiliser l’assistant en prévisualisation locale

L’assistant est disponible dans votre prévisualisation locale lorsque vous vous connectez avec la CLI. Cela vous permet de tester le comportement de l’assistant, les instructions personnalisées dans Assistant.md et les réponses pendant que vous développez votre documentation localement.

1. Si ce n’est pas déjà fait, installez la CLI avec npm i -g mint.
2. Exécutez mint login pour vous authentifier.
3. Exécutez mint dev pour démarrer la prévisualisation locale.

L’assistant en prévisualisation locale utilise le même contenu indexé que votre site de documentation déployé.

​

Emplacement dans l’interface

L’assistant apparaît à deux endroits : sous forme de bouton à côté de la barre de recherche et sous forme de barre en bas de la page.

​

Raccourci clavier

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

​

Paramètres d’URL

Ouvrez l’assistant depuis n’importe quelle page de votre site de documentation en ajoutant le paramètre de requête ?assistant à l’URL. Utilisez-le pour créer un lien direct vers l’assistant depuis du contenu externe comme des e-mails, des réponses de support, des bannières in-app ou des parcours d’intégration.

• ?assistant : Ouvre le panneau de chat de l’assistant sans envoyer de message.
• ?assistant=<message> : Ouvre le panneau de chat de l’assistant et envoie <message> comme premier message de l’utilisateur. Encodez la valeur en URL pour que les espaces et les caractères spéciaux soient préservés dans la requête.

Exemples

https://yourdocs.mintlify.site/quickstart?assistant
https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started%3F

​

Surligner du texte

Surlignez du texte sur une page et cliquez sur le bouton contextuel Add to assistant pour ouvrir le panneau de chat de l’assistant et ajouter le texte surligné comme contexte. Vous pouvez ajouter plusieurs extraits de texte ou blocs de code au contexte de l’assistant.

​

Blocs de code

Cliquez sur le bouton Demander à l’assistant dans un bloc de code pour ouvrir le panneau de chat de l’assistant et ajouter le bloc de code comme contexte. Vous pouvez ajouter plusieurs blocs de code ou extraits de texte au contexte de l’assistant.

​

Pièces jointes

Joignez des fichiers aux messages de l’assistant pour fournir un contexte supplémentaire.

Types de fichiers pris en charge :

• Images : JPEG, PNG, GIF, WebP, SVG
• Documents : PDF
• Fichiers de code et texte : JavaScript (.js, .jsx, .mjs, .cjs), TypeScript (.ts, .tsx), Python, HTML, CSS, Markdown, MDX, JSON, YAML, XML, SQL, CSV, texte brut, scripts shell (.sh, .bash, .env), GraphQL, TOML, Go, Rust, Ruby, Java, Kotlin, Swift, C (.c, .h), C++ (.cpp, .hpp), C#, PHP, Lua, R, Scala

Limites :

• Taille maximale du fichier : 5 Mo par pièce jointe
• Nombre maximal de pièces jointes par message : 10

​

Dépannage

La barre de chat de l'assistant n'est pas visible

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 inclut une règle spécifique au domaine qui masque les éléments fixes sur certains domaines 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 la règle. Cela résout le problème pour tous les utilisateurs une fois la liste de filtres mise à jour.

Assistant bloqué sur un réseau d'entreprise, un VPN ou un pare-feu

Si l’assistant se charge sur des réseaux personnels mais échoue sur un réseau professionnel, un VPN ou un autre réseau restreint, le blocage se produit au niveau du réseau et non sur le site de documentation lui-même. Les proxys d’entreprise, les VPN et les pare-feu bloquent parfois les requêtes sortantes dont l’assistant a besoin, de sorte que le panneau de chat ne peut pas se connecter même si le reste du site se charge normalement.

Pour les lecteurs : Demandez à votre équipe informatique d’autoriser les requêtes HTTPS sortantes vers les hôtes suivants depuis votre réseau. Si vous le pouvez, essayez l’assistant depuis un réseau personnel pour confirmer que le problème est spécifique au réseau.

• leaves.mintlify.com — API de l’assistant
• *.mintlify.dev — streaming de l’assistant et services associés
• *.mintlify.com — tableau de bord, API et analyses
• hcaptcha.com et *.hcaptcha.com — vérification CAPTCHA pour l’assistant

Pour les propriétaires de site : Si un lecteur signale que l’assistant ne se charge pas sur son réseau d’entreprise ou son VPN, il s’agit presque toujours d’un blocage réseau sortant et non d’un problème avec votre documentation. Indiquez-lui les hôtes ci-dessus et suggérez-lui de partager la liste avec son équipe informatique. Il s’agit d’une liste d’autorisation au niveau réseau qui s’applique à l’appareil ou au réseau du visiteur, et non de quelque chose que vous pouvez configurer depuis votre site. Si votre documentation est auto-hébergée derrière un proxy inverse qui écrase la CSP par défaut, consultez Configuration de la CSP pour les domaines à autoriser.