Assistant

Ajoutez un assistant de chat alimenté par l’IA à votre site de documentation qui répond aux questions des utilisateurs, cite les sources et génère des exemples de code à la demande.

L’assistant est inclus dans les plans Pro et Enterprise et est activé par défaut sur ces plans. Les utilisateurs du plan Hobby peuvent acheter un pack de crédits pour ajouter l’assistant à leur site.

​

À propos de l’assistant

L’assistant répond aux questions sur votre documentation par des requêtes en langage naturel. Les utilisateurs accèdent à l’assistant sur votre site de documentation, afin de trouver des réponses rapidement et d’utiliser votre produit avec succès même s’ils ne savent pas où chercher.

L’assistant utilise l’appel d’outils pour répondre aux questions. 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.
• Construit le contexte à partir de la page que l’utilisateur consulte lorsqu’il pose des questions.
• Cite les sources et fournit des liens navigables pour amener les utilisateurs directement aux pages référencées.
• Renvoie des informations détaillées sur l’API lorsqu’il répond à des questions sur votre API, y compris les méthodes, paramètres, corps de requête et schémas de réponse de vos spécifications OpenAPI.
• Génère des exemples de code copiables pour aider les utilisateurs à implémenter des solutions à partir de votre documentation.
• Prend en charge plusieurs modalités en permettant aux utilisateurs d’ajouter du texte, des images et d’autres fichiers comme contexte.

​

Fonctionnement de l’indexation

L’assistant indexe votre documentation publiée et vos spécifications d’API pour répondre aux questions avec précision. Lorsque vous publiez des modifications, l’assistant indexe immédiatement le contenu nouveau, mis à jour ou supprimé. L’assistant n’indexe pas les branches de brouillon ni les déploiements de prévisualisation.

Par défaut, l’assistant n’indexe pas les pages masquées. Pour inclure les pages masquées dans l’index de l’assistant, définissez seo.indexing: "all" dans votre docs.json. Consultez Pages masquées pour plus d’informations.

​

Comment l’assistant gère les questions inconnues

L’assistant répond uniquement aux questions en se basant sur les informations de votre documentation. S’il ne trouve pas d’informations pertinentes après avoir effectué une recherche, il répond qu’il ne dispose pas de suffisamment d’informations pour répondre.

Vous pouvez définir un e-mail de redirection pour que l’assistant fournisse votre e-mail de support aux utilisateurs dont il ne peut pas répondre aux questions. Cela offre aux utilisateurs une solution de recours, même si la documentation ne traite pas leur question spécifique.

​

Statistiques de l’assistant

Utilisez les statistiques de l’assistant pour comprendre comment les utilisateurs interagissent avec votre documentation et identifier des opportunités d’amélioration.

La page de l’assistant affiche les tendances d’utilisation du mois en cours. Consultez des statistiques plus détaillées sur la page analytiques.

​

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 aussi bien aux lecteurs humains qu’à la compréhension par 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 un formatage cohérent dans toute votre documentation.
• Incluez des métadonnées complètes dans le frontmatter des pages.
• Découpez 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 suffisamment de contenu conceptuel sur les fonctionnalités et les procédures.
• Incluez des exemples et des cas d’utilisation.
• Faites des références croisées vers les sujets connexes.
• Ajoutez des pages masquées avec du contexte supplémentaire dont les utilisateurs n’ont pas besoin, mais que l’assistant peut consulter.