> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/fr/automatisation/runbooks/runbook-references/org/devices/report-realmjoin-agent-contact_scheduled.md). # Rapport de contact de l’agent RealmJoin planifié Signalez les appareils dont l’agent RealmJoin a cessé de communiquer {% hint style="info" %} Il s'agit d'un runbook planifié. Il est conçu pour s'exécuter selon une planification récurrente plutôt que d'être déclenché pour un seul objet. Voir [Planification](/fr/automatisation/runbooks/scheduling.md) pour plus de détails sur la configuration des planifications de runbook. {% endhint %} ### Description Compare, pour les appareils Windows, quand RealmJoin a vu l'appareil pour la dernière fois avec quand il s'est synchronisé pour la dernière fois avec Intune. Un appareil qu'Intune a vu bien après la dernière fois où RealmJoin l'a fait indique un agent RealmJoin manquant, bloqué ou défectueux. Les appareils que RealmJoin n'a jamais vus et les appareils connus d'un seul côté peuvent également être listés. Le rapport peut être envoyé par e-mail ou fourni via un lien de téléchargement. ### Fonctionnement Le runbook lit deux listes et les associe par l’ID d’appareil Entra (avec l’ID d’appareil Intune en solution de secours) : * **Intune**: tous les appareils Windows qui ont effectué une synchronisation au cours des derniers *Dernière synchronisation Intune dans (jours)*. Les appareils qui ont cessé de se synchroniser avec Intune sont laissés de côté volontairement ; ils relèvent du **Rapporter les appareils obsolètes (planifié)** runbook. * **RealmJoin**: la liste des appareils de l’API client RealmJoin. Pour chaque appareil, elle contient les utilisateurs que l’agent RealmJoin a signalés comme connectés, chacun avec un *dernière activité* horodatage. RealmJoin écrit le même horodatage sur l'utilisateur et sur l'appareil à chaque rapport de l'agent, donc la plus récente de ces valeurs correspond au dernier contact de l'agent avec l'appareil. Pour chaque appareil Intune, le runbook calcule l' **écart** : combien de jours Intune a continué à voir l'appareil après le dernier rapport de l'agent RealmJoin. Chaque appareil reçoit un statut : | Statut | Signification | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Synchronisé` | L'agent a remonté un rapport suffisamment récemment ; l'écart est inférieur à la valeur autorisée. | | `Agent périmé` | Intune a vu l'appareil au moins *Écart autorisé depuis la dernière observation par RealmJoin (jours)* après le dernier rapport de l'agent. L'appareil était utilisé alors que l'agent ne remonte pas de rapport : l'agent est manquant, bloqué par un proxy ou un pare-feu, ne s'exécute pas ou est défectueux. | | `Jamais vu` | RealmJoin connaît l'appareil mais l'agent n'y a jamais signalé d'utilisateur connecté, par exemple un appareil inscrit et jamais utilisé, ou un kiosque. | | `MissingInRealmJoin` | L'appareil existe dans Intune mais pas dans RealmJoin : l'agent ne l'a jamais enregistré. | | `MissingInIntune` | L'appareil existe dans RealmJoin mais n'a pas été synchronisé avec Intune dans la fenêtre de synchronisation. Non disponible en même temps qu'un préfixe de nom d'appareil, car les appareils RealmJoin ne portent pas de nom d'appareil à faire correspondre. | `Agent périmé` fait toujours partie du rapport. Les autres catégories sont activées avec les *Inclure ...* choix. L'onglet Données de sortie de l'exécution affiche un résumé et un tableau par catégorie ; les fichiers de rapport contiennent les mêmes lignes. Savoir si les utilisateurs principaux d'un appareil concordent et savoir qui s'y connecte sont deux questions différentes ; le **Rapporter une discordance d’utilisateur principal (planifié)** runbook y répond. #### Pourquoi l'écart et non l'ancienneté Comparer l'horodatage RealmJoin avec aujourd'hui listerait tous les appareils simplement éteints, par exemple pendant les vacances. L'écart compare les deux sources entre elles : un appareil qu'Intune n'a pas vu non plus n'est pas un problème de l'agent RealmJoin. Seul un appareil qui continue à parler à Intune alors que RealmJoin ne reçoit rien pointe vers l'agent. La valeur par défaut de 14 jours correspond au point auquel le portail RealmJoin marque un appareil comme périmé. #### Ce que signifie l'horodatage RealmJoin L'agent RealmJoin s'exécute dans le contexte de l'utilisateur connecté et remonte un rapport toutes les 15 minutes tant qu'une personne est connectée. Chaque rapport met à jour l' *dernière activité* horodatage de cet utilisateur sur cet appareil et de l'appareil lui-même. Un appareil sans utilisateur connecté, par exemple un appareil kiosque, un appareil partagé sans compte connecté ou un appareil uniquement allumé pour les mises à jour, ne produit pas un nouvel horodatage et peut apparaître comme `Agent périmé` bien que l'agent fonctionne correctement. Excluez ces appareils avec *Exclure les appareils du groupe* , ou augmentez l'écart autorisé. Le *Dernière observation* la colonne du portail RealmJoin n'a pas la même valeur : le portail affiche la plus récente des activités de contact de l'agent, de synchronisation Intune et de connexion Entra ID. Ce rapport n'utilise volontairement que le contact de l'agent, car c'est ce qui indique si l'agent fonctionne. #### Vérification de plausibilité Le runbook lit aussi les statistiques clientes propres à RealmJoin et affiche combien de clients RealmJoin compte comme actifs. Le seuil derrière ce comptage est un paramètre du Tenant RealmJoin (90 jours par défaut), donc le nombre est généralement supérieur au nombre d'appareils synchronisés ici ; une grande différence dans l'autre sens signifie que la fenêtre de synchronisation ou l'écart autorisé est réglé trop strictement pour le Tenant. ### Configuration concernant les identifiants de l’API RealmJoin Le runbook interroge l’API client RealmJoin et nécessite un identifiant dédié stocké dans le Azure Automation Account. Le même identifiant sert à tous les runbooks qui utilisent l’API, donc il s’agit d’une configuration unique par Automation Account. 1. **Obtenir les identifiants de l’API** - Si vous ne disposez pas encore des identifiants de l’API RealmJoin, demandez-les à . Le nom d’utilisateur a la forme `t-`, le mot de passe est le secret de l’API. Une connexion au portail ne fonctionne pas ici. 2. **Demandez la fonctionnalité des utilisateurs d’appareil** - La liste des appareils de l’API client est une fonctionnalité que RealmJoin active par tenant. Demandez au support de l’activer en même temps que les identifiants ; sans elle, l’API répond avec HTTP 403 et le runbook s’arrête avec ce message. 3. **Ouvrez le Automation Account** - Dans Azure Portal, ouvrez le Automation Account utilisé pour les runbooks. 4. **Accédez à Shared Resources > Credentials** - Dans le menu de gauche, sous *Ressources partagées*, cliquez sur *Identifiants*. 5. **Ajoutez un nouvel identifiant** - Cliquez sur *Ajouter un identifiant*. 6. **Nommez-le exactement `RJAPI`** - Le runbook recherche ce nom ; tout autre nom fait échouer la recherche de l’identifiant. 7. **Entrez le nom d’utilisateur et le secret de l’API** - Utilisez les valeurs de l’étape 1. 8. **Enregistrer** - Cliquez sur *Créer* et exécutez à nouveau le runbook. L'API autorise 30 requêtes par minute et par Tenant et répond avec HTTP 429 au-delà. Le runbook a besoin de deux requêtes par exécution et répète une requête limitée après un court délai, jusqu'à cinq fois, avant d'abandonner. ### Livraison du rapport Les résultats apparaissent toujours sous forme de tableaux nommés dans l’onglet Output Data de l’exécution dans le portail RealmJoin. Les fichiers de rapport ne sont générés que lorsque l’ **Livraison du rapport** option inclut un e-mail et/ou un lien de téléchargement ; *Uniquement les données de sortie* ne crée aucun fichier de rapport. La livraison par e-mail et la génération du lien de téléchargement sont indépendantes et peuvent être combinées. Pour le lien de téléchargement, les fichiers du rapport sont téléversés vers le Storage Account Azure configuré dans les `RJReport.StorageAccount.*` paramètres du Tenant, et des liens de téléchargement SAS à durée limitée sont renvoyés. Le téléversement vers le Storage Account s’authentifie avec l’identité managée du compte Automation ; cette identité nécessite le **Reader and Data Access** rôle RBAC sur le Storage Account cible (il s’agit d’une attribution Azure RBAC, pas d’une autorisation d’application Graph). ### Configuration de l’envoi d’e-mails L’envoi du rapport par e-mail est facultatif et ne se produit que lorsque *Envoyer aussi le rapport par e-mail* ou *Envoyer aussi par e-mail et lien de téléchargement* est sélectionné comme mode de livraison du rapport ; un destinataire est alors requis. L’adresse de l’expéditeur est prise à partir de la `RJReport.EmailSender` paramètre Tenant. Ce runbook envoie des e-mails à l’aide de l’API Microsoft Graph. Pour envoyer des e-mails via l’API Graph, vous devez configurer une adresse e-mail existante dans la personnalisation du runbook. Voir la [documentation des paramètres de rapport RealmJoin](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings) pour plus de détails sur tous les paramètres disponibles. #### Branding des e-mails L’e-mail du rapport prend en compte l’optionnel `RJReport.Branding.*` paramètres Tenant : * **Image d’en-tête et de pied de page** - URL HTTPS publiques, PNG/JPEG/GIF, max. 200 Ko chacune * **Lien de pied de page** - cible de l’image de pied de page * **Couleur d’accent et de texte** - valeurs hexadécimales à 6 chiffres, par ex. `#0052cc` Lorsque ces paramètres ne sont pas configurés, les graphismes et couleurs par défaut de RealmJoin sont utilisés. Une image qui ne peut pas être téléchargée ou validée, ou une valeur de couleur invalide, n’empêche jamais l’e-mail du rapport - le défaut correspondant est utilisé à la place. Instructions de configuration et exigences relatives aux images : [Branding des e-mails](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings#email-branding-optional). ### Planification Exécutez le rapport chaque semaine. Commencez avec la valeur par défaut de 14 jours pour l'écart autorisé et une fenêtre de synchronisation de 30 jours ; réduisez l'écart une fois la liste propre, ou augmentez-le lorsque des appareils avec de longues périodes d'inactivité continuent d'apparaître. Une personnalisation qui fixe les deux valeurs et envoie le rapport par e-mail : ```json "rjgit-org_devices_report-realmjoin-agent-contact_scheduled": { "parameters": { "SyncThresholdDays": { "Default": 30 }, "AgentContactThresholdDays": { "Default": 14 }, "EmailTo": { "Default": "endpoint-team@contoso.com" } } } ``` Voir la [Guide de personnalisation du runbook](https://docs.realmjoin.com/automation/runbooks/runbook-customization) pour la syntaxe. ### Notes et limites * Seuls les appareils Windows sont comparés, car l'agent RealmJoin s'exécute sur Windows. * L'API client de RealmJoin n'expose ni la version de l'agent ni l'heure de synchronisation Intune par appareil ; la comparaison repose sur le contact de l'agent décrit ci-dessus. * L'utilisateur principal Intune affiché dans les tableaux est l'utilisateur enregistré dans Intune, pas nécessairement celui que l'agent a vu en dernier ; les deux sont listés pour les `Agent périmé` lignes. ### Emplacement Organisation → Appareils → Rapport du contact de l’agent RealmJoin (planifié) **Nom complet du runbook** rjgit-org\_devices\_report-realmjoin-agent-contact\_scheduled ### Détails | Propriété | Valeur | | -------------- | ------------------------------------------------------------------------------------------------------------------ | | Version | 1.0.0 | | Modules requis |

RealmJoin.RunbookHelper (>= 0.8.10)
Microsoft.Graph.Authentication (>= 2.41.2)
Az.Accounts (>= 5.5.2)

| | Planifiable | oui | ### Autorisations #### Autorisations d’application * **Type**: Microsoft Graph * DeviceManagementManagedDevices.Read.All * *Lit les appareils Windows dans Intune avec leur utilisateur principal et leur heure de dernière synchronisation pour la comparaison* * GroupMember.Read.All * *Lit les membres des appareils des groupes facultatifs d'inclusion et d'exclusion qui réduisent le périmètre* * Mail.Send *(facultatif — fonctionnalité : rapport par e-mail)* * *Envoie l’e-mail du rapport via Send-RjRbReportEmail lorsque la livraison par e-mail est sélectionnée* * Organization.Read.All *(facultatif — fonctionnalité : rapport par e-mail)* * *Lit le nom d’affichage du Tenant pour l’objet de l’e-mail, le corps du message et les noms de fichiers du rapport* #### Notes sur les autorisations API client RealmJoin : un identifiant de Automation Account nommé 'RJAPI' avec le nom d’utilisateur API du tenant (t-) et le secret, fournis par le support RealmJoin ; API client RealmJoin : la fonctionnalité des utilisateurs d’appareil de l’API doit être activée pour le tenant par le support RealmJoin (la liste des appareils répond avec HTTP 403 sinon) Azure Storage Account : rôle 'Reader and Data Access' pour l’identité managée du Automation Account sur le Storage Account cible - le téléversement récupère les clés du compte via listKeys (requis uniquement pour les options de lien de téléchargement) ### Paramètres #### SyncThresholdDays Seuls les appareils synchronisés avec Intune au cours de ce nombre de jours sont comparés. Les appareils qui ont complètement cessé de se synchroniser relèvent plutôt du rapport des appareils obsolètes. | Propriété | Valeur | | -------------------------- | -------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | 30 | | Type | Int32 | | Nom d’affichage du portail | Dernière synchronisation Intune dans (jours) | #### AgentContactThresholdDays Un appareil est considéré comme agent périmé lorsque Intune l'a vu au moins ce nombre de jours après que RealmJoin l'a vu pour la dernière fois. De courts écarts sont normaux, car l'agent ne remonte des rapports que lorsqu'un utilisateur est connecté. | Propriété | Valeur | | -------------------------- | ------------------------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | 14 | | Type | Int32 | | Nom d’affichage du portail | Écart autorisé depuis la dernière observation par RealmJoin (jours) | #### DeviceNamePrefix Seuls les appareils dont le nom commence par ce texte. Laissez vide pour tous. | Propriété | Valeur | | -------------------------- | ---------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Nom d’affichage du portail | Préfixe du nom de l’appareil | #### IncludeAgentStale Répertorie les appareils qu'Intune a vus bien après la dernière fois où RealmJoin les a vus, signe d'un agent qui ne remonte plus de rapports. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | Vrai | | Type | Booléen | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### IncludeNeverSeen Répertorie les appareils que RealmJoin connaît mais sur lesquels il n'a jamais vu d'utilisateur connecté, par exemple des appareils qui ont été inscrits mais pas encore utilisés. | Propriété | Valeur | | -------------------------- | ---------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | Vrai | | Type | Booléen | | Nom d’affichage du portail | Inclure les appareils que RealmJoin n'a jamais vus ? | **Options du portail** | Option du portail | Valeur | | ----------------- | ------ | | Oui | vrai | | Non | faux | #### IncludeMissingInRealmJoin Répertorie les appareils qui existent dans Intune mais pas dans RealmJoin. | Propriété | Valeur | | -------------------------- | ------------------------------------------------ | | Obligatoire | faux | | Valeur par défaut | Faux | | Type | Booléen | | Nom d’affichage du portail | Inclure les appareils manquants dans RealmJoin ? | **Options du portail** | Option du portail | Valeur | | ----------------- | ------ | | Oui | vrai | | Non | faux | #### IncludeMissingInIntune Répertorie les appareils qui existent dans RealmJoin mais n'ont pas été synchronisés avec Intune dans la fenêtre de synchronisation. Non disponible en même temps qu'un préfixe de nom d'appareil. | Propriété | Valeur | | -------------------------- | --------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | Faux | | Type | Booléen | | Nom d’affichage du portail | Inclure les appareils manquants dans Intune ? | **Options du portail** | Option du portail | Valeur | | ----------------- | ------ | | Oui | vrai | | Non | faux | #### IncludeDeviceGroup Seulement les appareils de ce groupe Entra ID. Laissez vide pour tous les appareils. | Propriété | Valeur | | -------------------------- | ------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Nom d’affichage du portail | Inclure les appareils du groupe | #### ExcludeDeviceGroup Ignore les appareils de ce groupe Entra ID, par exemple les kiosques ou les appareils partagés qui ont rarement un utilisateur connecté. Laisser vide pour n'en ignorer aucun. | Propriété | Valeur | | -------------------------- | ------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Nom d’affichage du portail | Exclure les appareils du groupe | #### EmailFrom Adresse de l’expéditeur de l’e-mail du rapport. Prise dans le paramètre Tenant RJReport.EmailSender. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### BrandingHeaderImageUrl Image d’en-tête de l’e-mail du rapport (URL HTTPS, PNG/JPEG/GIF, 200 Ko max.). Prise dans le paramètre Tenant RJReport.Branding.HeaderImageUrl ; l’en-tête RealmJoin par défaut est utilisé si vide. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### BrandingFooterImageUrl Image de pied de page de l’e-mail du rapport (URL HTTPS, PNG/JPEG/GIF, 200 Ko max.). Prise dans le paramètre Tenant RJReport.Branding.FooterImageUrl ; le pied de page RealmJoin par défaut est utilisé si vide. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### BrandingFooterLink Lien derrière l’image de pied de page de l’e-mail du rapport. Pris dans le paramètre Tenant RJReport.Branding.FooterLink ; realmjoin.com est utilisé si vide. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### BrandingAccentColor Couleur d’accent de l’e-mail du rapport sous forme de valeur hexadécimale à 6 chiffres. Prise dans le paramètre Tenant RJReport.Branding.AccentColor ; la valeur par défaut RealmJoin est utilisée si vide ou non valide. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### BrandingTextColor Couleur du texte de l’e-mail du rapport sous forme de valeur hexadécimale à 6 chiffres. Prise dans le paramètre Tenant RJReport.Branding.TextColor ; la valeur par défaut RealmJoin est utilisée si vide ou non valide. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### SendEmailReport Envoyer le rapport à l’adresse e-mail du destinataire. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | Faux | | Type | Booléen | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### EmailTo Envoyez le rapport à ces adresses. Séparez-en plusieurs par des virgules ; chaque destinataire reçoit un e-mail distinct. | Propriété | Valeur | | -------------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Nom d’affichage du portail | Adresse(s) e-mail du destinataire | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### ReportFileFormat Distribuez le rapport en CSV, en classeur Excel ou dans les deux formats. | Propriété | Valeur | | -------------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | CSV et XLSX | | Type | Chaîne | | Nom d’affichage du portail | Format du fichier de rapport | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | **Options du portail** | Option du portail | Valeur | | ----------------- | --------------- | | CSV et XLSX | CSV et XLSX | | CSV uniquement | CSV uniquement | | XLSX uniquement | XLSX uniquement | #### Créer un lien de téléchargement Télécharge également le rapport et renvoie un lien de téléchargement qui expire après quelques jours. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | Faux | | Type | Booléen | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### Nom du conteneur Conteneur de stockage vers lequel les fichiers du rapport sont téléversés. À définir par runbook. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | report-realmjoin-agent-contact | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### Nom du groupe de ressources Groupe de ressources du compte de stockage pour les téléversements du rapport. Pris à partir du paramètre du tenant RJReport.StorageAccount.ResourceGroup. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### Nom du Storage Account Compte de stockage pour les téléversements du rapport. Pris à partir du paramètre du tenant RJReport.StorageAccount.StorageAccountName. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | | | Type | Chaîne | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | #### LinkExpiryDays Nombre de jours pendant lesquels un lien de téléchargement reste valide. Pris à partir du paramètre du tenant RJReport.StorageAccount.LinkExpiryDays. | Propriété | Valeur | | ---------------------- | -------------------------------------------------- | | Obligatoire | faux | | Valeur par défaut | 6 | | Type | Int32 | | Masqué dans le portail | oui (prédéfini via la personnalisation du runbook) | [Retour à l’aperçu de la référence du runbook](/fr/automatisation/runbooks/runbook-references.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.realmjoin.com/fr/automatisation/runbooks/runbook-references/org/devices/report-realmjoin-agent-contact_scheduled.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.