> 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/pt/automatizacao/runbooks/runbook-references/org/devices/report-primary-user-mismatch_scheduled.md). # Relatório de discrepância do utilizador principal agendado Comparar utilizadores principais e inícios de sessão entre o Intune e o RealmJoin {% hint style="info" %} Este é um runbook agendado. Ele foi projetado para ser executado em um agendamento recorrente, em vez de ser acionado para um único objeto. Veja [Agendamento](/pt/automatizacao/runbooks/scheduling.md) para obter detalhes sobre como configurar os agendamentos do runbook. {% endhint %} ### Descrição Compara, para dispositivos Windows, o utilizador principal registado no Intune com o registado no RealmJoin e lista todos os dispositivos em que diferem. Também verifica quem inicia sessão efetivamente em cada dispositivo, usando os logons que o Intune e o agente do RealmJoin registaram, e lista os dispositivos cujo utilizador principal já não o faz. As categorias listadas são definidas na personalização do runbook. Apenas são considerados dispositivos que sincronizaram recentemente com o Intune. O relatório pode ser enviado por e-mail ou disponibilizado através de uma ligação de download. ### Como funciona O runbook lê duas listas e faz a correspondência entre elas pelo ID do dispositivo do Entra ID (com o ID do dispositivo do Intune como alternativa): * **Intune**: todos os dispositivos Windows que concluíram uma sincronização nos últimos *Última sincronização do Intune dentro de (dias)*, com o respetivo utilizador principal e os logons que o Intune registou no dispositivo. Os dispositivos que deixaram de sincronizar com o Intune são omitidos de propósito; pertencem ao **Reportar dispositivos obsoletos (agendado)** runbook. * **RealmJoin**: a lista de dispositivos da API do cliente do RealmJoin. Para cada dispositivo, inclui os utilizadores que o agente do RealmJoin reportou como com sessão iniciada, cada um com um *última vez visto* carimbo de data e hora, e qual deles o RealmJoin trata como o utilizador principal. Para cada dispositivo, o runbook responde a duas perguntas: os utilizadores principais coincidem e o utilizador principal continua a iniciar sessão? Cada resposta é uma categoria; um dispositivo pode estar em várias. Se o próprio agente do RealmJoin ainda reporta é uma questão diferente e é respondida pelo **Reportar contacto do agente RealmJoin (agendado)** runbook. ### Categorias | Categoria | Significado | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Divergência` | O utilizador principal do Intune e o utilizador principal do RealmJoin diferem. | | `PrimaryUserDeleted` | O utilizador principal do Intune foi eliminado do Entra ID. O Intune escreve então o ID do objeto do utilizador antes do nome principal do utilizador; o runbook reconhece isso e não o conta como uma divergência. | | `PrimaryUserNotLoggingOn` | Outra pessoa iniciou sessão no dispositivo, e o utilizador principal não o fez dentro de *O utilizador principal deve ter iniciado sessão dentro de (dias)*. O dispositivo é provavelmente utilizado por uma pessoa diferente da registada. | | `MissingInRealmJoin` | O dispositivo existe no Intune mas o RealmJoin não o conhece, ou conhece-o sem um utilizador principal. | | `MissingInIntune` | O RealmJoin conhece o dispositivo mas este não sincronizou com o Intune dentro da janela de sincronização. | As categorias listadas são definidas na personalização do runbook; por predefinição, apenas `Divergência` está ativado. Cada categoria tem a sua própria tabela no separador Output Data da execução, com as colunas que explicam a ocorrência. Os ficheiros do relatório contêm uma linha por dispositivo nas categorias ativadas, com todas as colunas, incluindo uma `Ocorrências` coluna que nomeia todas as categorias em que o dispositivo se encontra. #### De onde provêm os logons São combinadas duas fontes: * **Intune** regista os logons mais recentes num dispositivo com o ID do objeto do utilizador e um carimbo de data e hora. O runbook resolve os IDs para nomes principais de utilizador; um utilizador que já não existe é mostrado como eliminado. * **O agente do RealmJoin** é executado no contexto do utilizador com sessão iniciada e reporta ao RealmJoin a cada 15 minutos enquanto alguém tem sessão iniciada. Cada relatório atualiza a *última vez visto* desse utilizador nesse dispositivo, pelo que os utilizadores do RealmJoin de um dispositivo são as pessoas que o agente viu com sessão iniciada, cada uma com a respetiva última vez. O utilizador principal conta como tendo iniciado sessão quando qualquer uma das fontes o viu dentro da janela de início de sessão. `PrimaryUserNotLoggingOn` requer ambos: alguém diferente foi visto e o utilizador principal não esteve dentro da janela. Um dispositivo no qual ninguém foi visto de todo é mostrado como `Desconhecido` na `PrimaryUserLogon` coluna e nunca é contado como não tendo iniciado sessão. Os dispositivos partilhados em que várias pessoas iniciam sessão por conceção geram esta ocorrência para o respetivo utilizador principal; exclua-os com *Excluir dispositivos do grupo*. #### Âmbito do dispositivo *Incluir dispositivos do grupo* limita a comparação aos dispositivos desse grupo do Entra ID, *Excluir dispositivos do grupo* omite os dispositivos de um grupo. Ambos são opcionais e podem ser combinados; um filtro aplica-se assim que o respetivo grupo é selecionado. ### Ativar categorias Os interruptores das categorias estão ocultos no portal e são definidos na personalização do runbook, pelo que uma agenda relata sempre o mesmo conjunto. Uma personalização que ativa a verificação de início de sessão além das divergências: ```json "rjgit-org_devices_report-primary-user-mismatch_scheduled": { "parameters": { "IncludeMismatches": { "Default": true }, "IncludePrimaryUserDeleted": { "Default": true }, "IncludePrimaryUserNotLoggingOn": { "Default": true }, "PrimaryUserLogonDays": { "Default": 30 } } } ``` Consulte a [Guia de Personalização de Runbooks](https://docs.realmjoin.com/automation/runbooks/runbook-customization) para a sintaxe. ### Entrega do relatório Os ficheiros do relatório só são gerados quando um método de entrega é selecionado através da **Entrega do relatório** opção (email e/ou ligação de transferência). Com *Apenas dados de saída* selecionado, os resultados são lidos diretamente na aba Output Data do portal RealmJoin, onde cada tabela também pode ser exportada para o Excel. A entrega por e-mail e a geração de link de download são independentes e podem ser combinadas. Para a ligação de transferência, os ficheiros do relatório são carregados para a Storage Account do Azure configurada nas `RJReport.StorageAccount.*` definições de Tenant, e são devolvidos links de download SAS com prazo limitado. O carregamento para o armazenamento autentica-se com a identidade gerida da conta de Automação; essa identidade precisa da **Leitor e acesso aos dados** função RBAC na Storage Account de destino (isto é uma atribuição de Azure RBAC, não uma permissão de aplicação do Graph). Os agendamentos criados antes da **Entrega do relatório** opção existir continuam a enviar o respetivo email: um destinatário guardado por si só ainda ativa o email para eles. Quando esse agendamento é aberto para edição, a opção mostra *Apenas dados de saída*; selecione novamente a entrega antes de guardar, caso contrário o agendamento deixa de enviar o relatório. ### Resultado sem ocorrências Não é enviado nenhum e-mail e não é criado nenhum ficheiro quando nenhum dispositivo entra numa categoria ativada. Uma execução sem ocorrências conclui normalmente e não é um erro; o separador Output Data ainda mostra o resumo. ### Configuração relativa às credenciais da API do RealmJoin O runbook consulta a API do cliente do RealmJoin e precisa de uma credencial dedicada guardada na Azure Automation Account. A mesma credencial serve para todos os runbooks que usam a API, pelo que esta é uma configuração única por Automation Account. 1. **Obter credenciais da API** - Se ainda não tiver credenciais da API do RealmJoin, solicite-as em . O nome de utilizador tem o formato `t-`, a palavra-passe é o segredo da API. Um início de sessão no portal não funciona aqui. 2. **Peça a funcionalidade de utilizadores de dispositivos** - A lista de dispositivos da API do cliente é uma funcionalidade que o RealmJoin ativa por Tenant. Peça ao suporte para a ativar juntamente com as credenciais; sem ela, a API responde com HTTP 403 e o runbook termina com essa mensagem. 3. **Abra a Automation Account** - No Azure Portal, abra a Automation Account usada para runbooks. 4. **Vá para Shared Resources > Credentials** - No menu à esquerda, em *Shared Resources*, clique em *Credentials*. 5. **Adicione uma nova credencial** - Clique em *Adicionar uma credencial*. 6. **Dê-lhe exatamente o nome `RJAPI`** - O runbook procura este nome; qualquer outro nome faz falhar a pesquisa da credencial. 7. **Introduza o nome de utilizador e o segredo da API** - Use os valores do passo 1. 8. **Guardar** - Clique em *Criar* e execute o runbook novamente. A API permite 30 pedidos por minuto por Tenant e responde com HTTP 429 além disso. O runbook precisa de um pedido por execução e repete um pedido limitado após um curto atraso, até cinco vezes, antes de desistir. ### Configuração relativa ao envio de emails O envio de um relatório por email é opcional e só acontece quando *Enviar também o relatório por email* ou *Enviar também email e ligação de transferência* é selecionado como entrega do relatório; nesse caso é necessário um destinatário. O endereço do remetente é obtido de `RJReport.EmailSender` Tenant. Este runbook envia emails utilizando a API do Microsoft Graph. Para enviar emails através da Graph API, é necessário configurar um endereço de email existente na personalização do runbook. Este processo é descrito em detalhe no [documentação das definições de relatório do RealmJoin](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings). #### Branding do email O email do relatório respeita as definições opcionais de `RJReport.Branding.*` do Tenant: * **Imagem do cabeçalho e do rodapé** - URLs HTTPS públicas, PNG/JPEG/GIF, máx. 200 KB cada * **Ligação no rodapé** - destino da imagem de rodapé * **Cor de destaque e do texto** - valores hexadecimais de 6 dígitos, por exemplo `#0052cc` Quando estas definições não estão configuradas, são usadas as imagens e cores predefinidas de RealmJoin. Uma imagem que não possa ser transferida ou validada, ou um valor de cor inválido, nunca impede o email do relatório - em vez disso, é usada a predefinição correspondente. Instruções de configuração e requisitos da imagem: [Branding do email](https://docs.realmjoin.com/automation/runbooks/runbook-report-settings#email-branding-optional). ### Notas e limitações * Apenas dispositivos Windows são comparados: o agente do RealmJoin é executado no Windows, pelo que o RealmJoin não tem dados de utilizador principal nem de inícios de sessão para outras plataformas. * O relatório é um instantâneo por execução. Não conserva a execução anterior e, por isso, não reporta que um utilizador principal *mudou* entre duas execuções; para isso, compare dois ficheiros de relatório. * Os logons que o Intune regista abrangem apenas os inícios de sessão mais recentes, e o agente do RealmJoin só vê utilizadores que estavam com sessão iniciada enquanto era executado. Um utilizador que inicia sessão raramente pode, portanto, aparecer como não tendo iniciado sessão. * O utilizador principal apresentado para o RealmJoin é aquele que o RealmJoin determinou a partir dos relatórios do agente; não é o proprietário do dispositivo registado no Entra ID. ### Localização Organization → Devices → Report Primary User Mismatch (Scheduled) **Nome completo do Runbook** rjgit-org\_devices\_report-primary-user-mismatch\_scheduled ### Detalhes | Propriedade | Valor | | ------------------- | ------------------------------------------------------------------------------------------------------------------ | | Versão | 1.8.0 | | Módulos necessários |

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

| | Agendável | sim | ### Permissões #### Permissões da aplicação * **Tipo**: Microsoft Graph * DeviceManagementManagedDevices.Read.All * *Lê os dispositivos Windows no Intune com o respetivo utilizador principal, a hora da última sincronização e os utilizadores que iniciaram sessão* * Directory.Read.All * *Resolve os IDs de utilizador dos registos de inícios de sessão do Intune para nomes principais de utilizador e lê os dispositivos membros dos grupos opcionais de inclusão e exclusão* * Mail.Send *(opcional — funcionalidade: Relatório por email)* * *Envia o e-mail do relatório através de Send-RjRbReportEmail quando um destinatário está configurado* * Organization.Read.All *(opcional — funcionalidade: Relatório por email)* * *Lê o nome de exibição do Tenant para o assunto do e-mail, o corpo do e-mail e os nomes dos arquivos do relatório* #### Notas de permissão API do cliente do RealmJoin: uma credencial da Automation Account chamada 'RJAPI' com o nome de utilizador e o segredo da API do Tenant (t-), emitidos pelo suporte do RealmJoin API do cliente do RealmJoin: a funcionalidade de utilizadores de dispositivos da API tem de estar ativada para o Tenant pelo suporte do RealmJoin (caso contrário, a lista de dispositivos responde com HTTP 403) Azure Storage Account: função 'Reader and Data Access' para a identidade gerida da Automation Account na Azure Storage Account de destino - o carregamento obtém as chaves da conta através de listKeys (apenas necessário para as opções de ligação de download) ### Parâmetros #### SyncThresholdDays Só são comparados os dispositivos que sincronizaram com o Intune há menos de este número de dias. Os dispositivos que deixaram de sincronizar por completo pertencem antes ao relatório de dispositivos obsoletos. | Propriedade | Valor | | -------------------------- | ----------------------------------------------- | | Obrigatório | falso | | Valor predefinido | 30 | | Tipo | Int32 | | Nome de exibição do portal | Última sincronização do Intune dentro de (dias) | #### DeviceNamePrefix Apenas dispositivos cujo nome começa com este texto. Deixe em branco para todos. | Propriedade | Valor | | -------------------------- | ------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Nome de exibição do portal | Prefixo do nome do dispositivo | #### PrimaryUserLogonDays O utilizador principal conta como não tendo iniciado sessão quando outra pessoa iniciou sessão no dispositivo e o utilizador principal não o fez dentro de este número de dias. | Propriedade | Valor | | -------------------------- | ---------------------------------------------------------------- | | Obrigatório | falso | | Valor predefinido | 30 | | Tipo | Int32 | | Nome de exibição do portal | O utilizador principal deve ter iniciado sessão dentro de (dias) | #### IncludeMismatches Lista os dispositivos cujo utilizador principal difere entre o Intune e o RealmJoin. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Verdadeiro | | Tipo | Booleano | | Nome de exibição do portal | Incluir divergências? | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### IncludeMissingInRealmJoin Lista os dispositivos que existem no Intune mas não no RealmJoin, ou que o RealmJoin conhece sem um utilizador principal. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Nome de exibição do portal | Incluir dispositivos em falta no RealmJoin? | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### IncludeMissingInIntune Lista os dispositivos que existem no RealmJoin mas não sincronizaram com o Intune dentro da janela de sincronização. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Nome de exibição do portal | Incluir dispositivos em falta no Intune? | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### IncludePrimaryUserDeleted Lista os dispositivos cujo utilizador principal do Intune foi eliminado do Entra ID. Sem isto, pareceriam divergências, porque o Intune reescreve o nome de um utilizador eliminado. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Nome de exibição do portal | Incluir utilizadores principais eliminados? | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### IncludePrimaryUserNotLoggingOn Lista os dispositivos em que outros utilizadores iniciam sessão, mas o utilizador principal não o fez dentro de "Primary user must have logged on within (days)". Usa os logons que o Intune e o agente do RealmJoin registaram. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------- | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Nome de exibição do portal | Incluir utilizadores principais que não iniciam sessão? | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### IncludeDeviceGroup Apenas dispositivos neste grupo do Entra ID. Deixe em branco para todos os dispositivos. | Propriedade | Valor | | -------------------------- | ----------------------------- | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Nome de exibição do portal | Incluir dispositivos do grupo | #### ExcludeDeviceGroup Omite dispositivos neste grupo do Entra ID, por exemplo dispositivos partilhados em que várias pessoas iniciam sessão por conceção. Deixe em branco para não omitir nenhum. | Propriedade | Valor | | -------------------------- | ----------------------------- | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Nome de exibição do portal | Excluir dispositivos do grupo | #### SendEmailReport Envia o relatório para o endereço de email do destinatário. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### EmailTo Enviar o relatório para estes endereços. Separe vários com vírgulas; cada destinatário recebe um email separado. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Nome de exibição do portal | Endereço(s) de email do(s) destinatário(s) | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### EmailFrom Endereço do remetente do email do relatório. Obtido da definição do Tenant RJReport.EmailSender. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### BrandingHeaderImageUrl Imagem de cabeçalho do email do relatório (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Obtida da definição do Tenant RJReport.Branding.HeaderImageUrl; é utilizado o cabeçalho predefinido do RealmJoin quando estiver vazio. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### BrandingFooterImageUrl Imagem de rodapé do email do relatório (URL HTTPS, PNG/JPEG/GIF, máx. 200 KB). Obtida da definição do Tenant RJReport.Branding.FooterImageUrl; é utilizado o rodapé predefinido do RealmJoin quando estiver vazio. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### BrandingFooterLink Ligação por trás da imagem de rodapé do email do relatório. Obtida da definição do Tenant RJReport.Branding.FooterLink; realmjoin.com é utilizado quando estiver vazio. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### BrandingAccentColor Cor de destaque do email do relatório como um valor hexadecimal de 6 dígitos. Obtida da definição do Tenant RJReport.Branding.AccentColor; é utilizado o valor predefinido do RealmJoin quando estiver vazio ou inválido. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### BrandingTextColor Cor do texto do email do relatório como um valor hexadecimal de 6 dígitos. Obtida da definição do Tenant RJReport.Branding.TextColor; é utilizado o valor predefinido do RealmJoin quando estiver vazio ou inválido. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### ReportFileFormat Entregar o relatório como CSV, como uma pasta de trabalho do Excel ou ambos. | Propriedade | Valor | | -------------------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | CSV e XLSX | | Tipo | Cadeia de caracteres | | Nome de exibição do portal | Formato do ficheiro do relatório | | Oculto no portal | sim (predefinido através da personalização do runbook) | **Opções do portal** | Opção do portal | Valor | | --------------- | ----------- | | CSV e XLSX | CSV e XLSX | | Apenas CSV | Apenas CSV | | Apenas XLSX | Apenas XLSX | #### CreateDownloadLink Também carregue o relatório e devolva uma ligação de download que expira após alguns dias. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | Falso | | Tipo | Booleano | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### ContainerName Contentor de armazenamento para o qual os ficheiros do relatório são carregados. Definir por runbook. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | report-primary-user-mismatch | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### ResourceGroupName Grupo de recursos da conta de armazenamento para carregamentos do relatório. Obtido a partir da definição de tenant RJReport.StorageAccount.ResourceGroup. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### StorageAccountName Conta de armazenamento para carregamentos do relatório. Obtida a partir da definição de tenant RJReport.StorageAccount.StorageAccountName. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | | | Tipo | Cadeia de caracteres | | Oculto no portal | sim (predefinido através da personalização do runbook) | #### LinkExpiryDays Número de dias que uma ligação de download permanece válida. Obtido a partir da definição de tenant RJReport.StorageAccount.LinkExpiryDays. | Propriedade | Valor | | ----------------- | ------------------------------------------------------ | | Obrigatório | falso | | Valor predefinido | 6 | | Tipo | Int32 | | Oculto no portal | sim (predefinido através da personalização do runbook) | [Voltar à visão geral da referência do Runbook](/pt/automatizacao/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/pt/automatizacao/runbooks/runbook-references/org/devices/report-primary-user-mismatch_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.