Connexion à des outils personnalisés

Connectez l'assistant GitBook à n'importe quel outil que vous pouvez appeler depuis votre application — en particulier les workflows de support

Les outils personnalisés permettent à l'Assistant GitBook à l'intérieur du Docs Embed d'exécuter de vraies actions.

Vous pouvez le connecter à n'importe quel outil auquel votre application peut accéder. Cela inclut vos APIs backend, les SDK tiers et les systèmes internes.

Si votre application peut l'appeler, l'Assistant peut l'appeler.

Exemples courants :

• Créer ou mettre à jour des tickets de support au nom de l'utilisateur

• Transférer au support en ouvrant un chat de support avec un message prérempli

  Transfert au support est une excellente façon de commencer avec les outils personnalisés. C’est le moyen le plus rapide de débloquer les utilisateurs.

• Déclencher des actions produit (réinitialiser l'AMF, renvoyer une invitation, activer un feature flag)

• Consulter le statut du compte dans votre backend

• Lancer des workflows dans des outils comme Jira, Linear, Slack ou Zendesk

En plus des outils que vous définissez dans la configuration de l'Embed, l'Assistant peut aussi utiliser n'importe quel serveurs MCP que vous configurez dans Paramètres → IA & MCP.

Où les outils s'exécutent

La fonction execute de l'outil s'exécute dans le même environnement que votre intégration embed.

Cela signifie généralement qu'elle s'exécute dans le navigateur de l'utilisateur, à l'intérieur de votre application.

Ainsi, vous pouvez :

• Appeler vos propres endpoints backend

• Appeler n'importe quel SDK tiers déjà chargé dans votre application (par exemple, Intercom)

• Ouvrir des modales, des liens profonds ou l'UI intégrée au produit

Évitez de mettre des secrets dans le code côté client — appelez plutôt votre backend.

Ajouter un outil

Définir des outils :

• Via window.GitBook("configure", …) pour la balise script implémentation

• Via le prop tools pour le package Node.js/NPM et composants React Tools ne sont pas la même chose que les

actions embed Utilisez.

• pour les boutons sur lesquels l'utilisateur clique. Utilisez Utilisez des outils lorsque vous voulez que l'Assistant choisisse et exécute du code.

• Modèle d'outil (renvoyer un e-mail d'invitation)

Regardons un exemple :

Examinons un exemple :

window.GitBook("configure", {
  outils : [
    {
      // Enregistrez l’outil avec un nom et une description.
      nom : "resend_invite",
      description :
        "Renvoyer un e-mail d’invitation lorsque l’utilisateur ne le trouve pas ou dit qu’il a expiré.",

      // Le schéma d’entrée est les données accessibles dans la fonction execute.
      inputSchema : {
        type : "object",
        properties : {
          email : {
            type : "string",
            description :
              "L’adresse e-mail à laquelle renvoyer l’invitation. Si elle est inconnue, demandez d’abord à l’utilisateur.",
          },
        },
        required : ["email"],
      },

      // Un bouton de confirmation optionnel qui s’affiche avant l’exécution de la fonction execute.
      confirmation : { icon : "paper-plane", label : "Renvoyer l’invitation ?" },

      // La fonction execute est la fonction qui sera appelée lorsque l’outil est utilisé.
      execute : async (input) => {
        const { email } = input;

        const result = await fetch("/api/invites/resend", {
          method : "POST",
          headers : { "Content-Type" : "application/json" },
          body : JSON.stringify({ email }),
        }).then((r) => r.json());

        return {
          // La sortie est renvoyée à l’IA.
          output : {
            recipient : email,
            status : result.status ?? "success",
          },
          // Le résumé est affiché à l’utilisateur.
          summary : {
            icon : "check",
            text : "Invitation par e-mail renvoyée.",
          },
        };
      },
    },
  ],
});

Comment les outils sont utilisés

Une fois que vous enregistrez des outils, l’Assistant peut les choisir automatiquement — en fonction de la question de l’utilisateur et de votre outil description.

Si des champs obligatoires manquent, l’Assistant doit poser des questions de suivi.

Si vous ajoutez confirmation, l’utilisateur doit approuver avant que l’outil ne s’exécute.

Champs de l’outil

• nom: Identifiant unique.

• description: L’indication « quand utiliser ceci » pour l’Assistant.

• inputSchema: Schéma JSON pour les entrées de l’outil.

• confirmation (optionnel) : Un bouton de confirmation affiché avant l’exécution de l’outil.

• execute(input): Fonction asynchrone qui exécute l’action.

  • Retour { output, summary }.

  • sortie retourne à l’Assistant.

  • résumé affiche à l’utilisateur.

Confirmation

pour les boutons sur lesquels l'utilisateur clique. confirmation quand vous voulez que l’utilisateur approuve une action. Cela aide à prévenir des effets secondaires surprenants.

confirmation accepte :

• libellé (requis) : texte du bouton.

• icône (optionnel) : Un Font Awesome nom d’icône.

Support

Le support est le cas d’usage le plus à fort effet pour les outils.

Vous pouvez laisser l’Assistant :

• Collecter les détails manquants

• Créer un ticket dans votre système

• Ouvrir un canal de support humain avec le contexte prérempli

Modèle : ouvrir le chat de support avec un message prérempli

Utilisez ceci lorsque vous voulez un transfert propre vers un humain.

window.GitBook("configure", {
  outils : [
    {
      nom : "open_support_chat",
      description :
        "Ouvrir le chat de support avec un message prérempli afin que l’utilisateur puisse contacter le support rapidement.",
      inputSchema : {
        type : "object",
        properties : {
          message : {
            type : "string",
            description :
              "Le message à envoyer au support. S’il manque, demandez d’abord à l’utilisateur.",
          },
        },
      },
      confirmation : { icon: "circle-question", label: "Ouvrir le chat de support" },
      execute : (input) => {
        // Fermer GitBook Assistant
        window.GitBook('close');
     
        // Exemples :
        // - Intercom : Intercom('showNewMessage', input.message);
        // - Zendesk : zE('messenger', 'open');
        
        return {
          output : {
            statut : "succès",
          },
          résumé : { icon: 'check', text: "Transmis au support." },
        };
      },
    },
  ],
});

Associez ceci à une Contacter le support action toujours visible dans la barre latérale intégrée. Vous pouvez configurer des actions en suivant Personnaliser l’intégration.

Prochaines étapes

• Besoin de l’API complète de l’intégration ? Voir Référence API.

• Vous voulez plus de contrôles UI (accueil, suggestions, actions) ? Voir Personnaliser l’intégration.