> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/advocate-program/getting-started-with-advocate/import-your-referral-program-data.md).

# Importar os dados do seu programa de indicações

Ao migrar de outra plataforma de indicação para o Advocate, você não está apenas importando dados: está ampliando o potencial do seu programa com rastreamento avançado, experiências personalizáveis e suporte especializado. Este artigo explica:

* Por que a migração é importante
* Como é um plano estratégico de migração
* Quais dados podem ser importados
* Como preparar seus arquivos
* Erros comuns de validação e como evitá-los

#### Por que planejar uma migração estratégica?

Migrar seu programa de indicação não é apenas uma tarefa técnica: é uma oportunidade de melhorar a forma como você interage com seus clientes e os recompensa. Uma migração bem planejada ajuda a:

* Minimizar as interrupções na experiência de indicação
* Preservar dados históricos e garantir a continuidade das recompensas ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media)
* Fazer uma transição tranquila dos sistemas antigos
* Relançar seu programa de indicação com entusiasmo e clareza

![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media) A migração de indicações e recompensas depende da possibilidade de exportar dados do sistema atual. A equipe do Advocate pode informar o que é possível com base nos dados exportados que você fornecer.

A equipe do Advocate trabalhará com você para analisar os arquivos exportados, identificar o que é viável e criar um plano que corresponda às necessidades e aos objetivos do seu programa.

#### O que você precisa fazer

* Exporte os dados do programa sobre *usuários*, *indicações*e *recompensas*. Entre em contato com seu CSM na plataforma de indicação anterior para obter ajuda ou use uma ferramenta de exportação da plataforma, se disponível.
* Baixe cada um dos três relatórios de dados em um arquivo CSV separado, por exemplo: `user_data.CSV`, `referral_data.CSV`e `reward_data.CSV`.
  * Consulte os exemplos abaixo para ver como poderia ser o conteúdo de cada arquivo .csv ou consulte a referência completa dos campos de destino.

Isso inclui e-mails, códigos de indicação, links de compartilhamento ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media)e campos personalizados. Os afiliados devem ser removidos para evitar recompensas duplicadas.

![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media) Depende do formato do link de compartilhamento e do uso de um subdomínio personalizado.

O arquivo de dados dos usuários conterá informações detalhadas sobre cada participante do seu programa. Exporte uma lista de todos os participantes para manter o programa atualizado com os links de compartilhamento e os códigos de indicação deles.

Os campos a seguir são **obrigatórios**:

* ID do usuário
* ID da conta

Use o e-mail do usuário como *ID do usuário* e *ID da conta*. As datas devem estar no formato de [milissegundos desde o Unix epoch](https://currentmillis.com/). Baixe um [exemplo dos campos obrigatórios](https://res.cloudinary.com/product-enablement/raw/upload/v1750169976/CSVs/Migration_User_Import_examples_-_User_Data.csv) ou use o exemplo abaixo no formato `.csv` .

```programlisting
id,accountId,email,firstName,lastName,dateCreated,locale,countryCode,segments
User1@example.com,User1@example.com,User1@example.com,First,Last,1741051242000,en_US,US,
User2@example.com,User2@example.com,User2@example.com,First,Last,,,,"vip,newuser"
User3@example.com,User3@example.com,User3@example.com,First,Last,,en_CA,,
User4@example.com,User4@example.com,User4@example.com,First,Last,,,,newuser
```

Isso inclui as datas de início e conversão, além das relações entre indicador e indicado. Permite mapear o desempenho histórico das indicações.

O arquivo de dados de indicações registra o status de cada conexão de indicação feita no seu programa de indicações.

Os campos a seguir são **obrigatórios**:

* ID do usuário indicador
* ID da conta do indicador
* ID do usuário indicado
* ID da conta do indicado

Use o e-mail do usuário como *ID do usuário* e *ID da conta*. As datas devem estar no formato de [milissegundos desde o Unix epoch](https://currentmillis.com/). Baixe um [exemplo dos campos obrigatórios](https://res.cloudinary.com/product-enablement/raw/upload/v1750249453/CSVs/Migration_User_Import_examples_-_Referral_Data_-_Referral_Data.csv) ou use o exemplo abaixo no formato `.csv` .

```programlisting
referrerUser,referrerAccount,referredUser,referredAccount,dateReferralStarted,dateConverted,programId
User2@example.com,User2@example.com,User12@example.com,User12@example.com,1740824979000,1740824979000,33435
User1@example.com,User1@example.com,User13@example.com,User13@example.com,1741051242000,1741051242000,33435
User1@example.com,User1@example.com,User17@example.com,User17@example.com,,,33435
User1@example.com,User1@example.com,User18@example.com,User18@example.com,,,33435
```

Isso inclui valores, datas de concessão e resgate, tipos de recompensa e status. Permite preservar a credibilidade e a imparcialidade junto aos usuários.

O arquivo de dados de recompensas registra o histórico de recompensas dos participantes, incluindo o valor e a quantia resgatada gerados pelo seu programa de indicações.

Os campos a seguir são **obrigatórios**:

* ID do usuário indicador
* ID da conta do indicador
* Nome da recompensa
* Unidade da recompensa
* Valor da recompensa
* Data de criação
* Data de concessão
* Data de resgate
* Quantia resgatada

Use o e-mail do usuário como *ID do usuário* e *ID da conta*. As datas devem ser formatadas em [milissegundos desde a época Unix](https://currentmillis.com/).

O valor da recompensa é o valor numérico da recompensa na sua menor unidade de medida (por exemplo, para uma recompensa em dinheiro de US$ 1,00, o valor seria 100 centavos). Se a unidade da recompensa for dinheiro, ela deverá incluir o código da moeda no seguinte formato `<unitName>/<Currency>` (Por exemplo, Cash/USD).

{% hint style="warning" %}
**Importante**: se os campos *Data de resgate* e *Quantia resgatada* não forem preenchidos corretamente — ou seja, se forem deixados em branco ou contiverem valores incorretos (por exemplo, uma data futura ou uma quantia resgatada imprecisa) —, a recompensa poderá ficar disponível para o usuário resgatá-la novamente.
{% endhint %}

Baixe um [exemplo dos campos obrigatórios](https://res.cloudinary.com/product-enablement/raw/upload/v1750249453/CSVs/Migration_User_Import_examples_-_Reward_Data_-_Reward_Data.csv) ou use o exemplo abaixo no formato `.csv` .

```programlisting
User ID,Acccount ID,Referred User ID,Referred Account ID,Reward Name,Reward Unit,Reward Value,Redeemed Amount,Date Created,Date Given,Date Redeemed
User1@example.com,User1@example.com,User2@example.com,User2@example.com,Dollars,CASH/USD,1000,1000,1709712158000,1709712158000,1709712158000
User1@example.com,User1@example.com,User3@example.com,User3@example.com,Points,POINT,100,100,1726164909682,1726164909682,1726164909682
User1@example.com,User1@example.com,User4@example.com,User4@example.com,Points,POINT,100,100,1726164887075,1726164887075,1726164887075
User1@example.com,User1@example.com,User5@example.com,User5@example.com,Points,POINT,100,100,1726164875888,1726164875888,1726164875888
User1@example.com,User1@example.com,User6@example.com,User6@example.com,Points,POINT,10,10,1726164828986,1726164828986,1726164828986
User1@example.com,User1@example.com,User7@example.com,User7@example.com,Account Credit,USD,8000,8000,1726164289997,1726164289997,1726164289997
User1@example.com,User1@example.com,,,Gift Card,USD,10000,10000,1726163864871,1726163864871,1726163864871
User1@example.com,User1@example.com,,,Points,POINT,800,800,1726095906392,1726095906392,1726095906392
User1@example.com,User1@example.com,,,Cartão-presente,USD,30000,30000,1726163769157,1726163769157,1726163769157
User1@example.com,User1@example.com,,,20 de desconto,%,20,20,1726180309034,1726180309034,1726180309034
```

{% hint style="warning" %}
**Importante:** Os 3 arquivos de exportação devem conter dados de apenas um programa. Se os arquivos tiverem dados de vários programas, a importação consolidará tudo em um único programa.
{% endhint %}

<details>

<summary>Um exemplo de plano de migração</summary>

Cada migração é única, mas as bem-sucedidas seguem uma estrutura semelhante, que equilibra preparação, comunicação e execução. A seguir, apresentamos um plano de migração que garante a continuidade e uma experiência tranquila para sua equipe e seus defensores. Os cronogramas e as etapas podem variar de acordo com a configuração do seu programa.

**Etapa 1: Planejamento e preparação (1–2 semanas)**

Esta é a etapa em que você estabelece os alicerces para uma transição tranquila.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Alinhar as partes interessadas.</p><p>• Preparar a configuração técnica.</p><p>• Confirmar o escopo da migração.</p><p>• Planejar a comunicação com os usuários.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Tarefas   | <p>• Obter uma amostra dos seus dados históricos (usuários, indicações e recompensas) e compartilhá-la com a equipe da Advocate para análise e mapeamento dos campos. <img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media" alt="">.</p><p>• Exportar os conjuntos de dados completos depois que a amostra for validada. Provavelmente, será necessário ajustar os dados exportados (por exemplo, os cabeçalhos, nomes dos campos ou a estrutura dos arquivos) para atender aos requisitos de importação.</p><p>• Definir uma data de entrada em produção e um período para reversão.</p><p>• Adicionar os widgets da Advocate em modo oculto (ambiente de teste ou páginas sem links).</p><p>• Configurar as integrações necessárias (por exemplo, Shopify, HubSpot e Segment).</p><p>• Concluir a configuração do programa na Advocate (por exemplo, configurar recompensas, regras do programa, modelos de e-mail e segmentação).</p><p>• Testar a funcionalidade do programa de ponta a ponta: confirmar, em um ambiente de teste e antes da entrada em produção, se os compartilhamentos, as conversões e as recompensas estão sendo registrados corretamente.</p><p>• Preparar as mensagens para comunicar a transição aos defensores.</p><p><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media" alt=""> A migração de indicações e recompensas depende da possibilidade de exportar os dados do seu sistema atual. A equipe da Advocate poderá informar o que é possível com base nos dados exportados que você fornecer.</p> |
| Dicas     | <p>• Se as plataformas funcionarem em paralelo, certifique-se de que apenas uma delas esteja emitindo recompensas.</p><p>• Identifique os usuários mais ativos que podem precisar de atenção especial (VIPs, influenciadores).</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |

**Etapa 2: Transição e entrada em produção (1–2 dias)**

Este é o momento da transição. Planeje uma breve pausa no rastreamento entre os sistemas e, se possível, programe-a para um horário de pouco tráfego.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Faça a transição da plataforma antiga para a Advocate sem interrupções.</p><p>• Garanta que os usuários possam acessar a nova experiência imediatamente.</p><p>• Evite a perda de dados de indicações ou de recompensas.</p>                                                                                                                                                                                                                                                                                                                                                                                             |
| Tarefas   | <p>• Remova do seu site os scripts e widgets da plataforma antiga.</p><p>• Ative os widgets da Advocate.</p><p>• Importe os dados finais de usuários, indicações e recompensas.</p><p>• Registre ou sinalize manualmente todas as conversões ocorridas entre o desligamento e a ativação dos sistemas.</p><p>• Monitore a atividade no painel da Advocate.</p><p>• Envie uma comunicação de lançamento aos seus defensores. Informe aos usuários que os links de indicação foram atualizados e, de preferência, inclua os novos links diretamente no e-mail para que eles possam começar a compartilhá-los imediatamente.</p> |
| Dicas     | <p>• Se necessário, inclua um breve período de bloqueio de recompensas (por exemplo: “As indicações feitas em 15 de maio serão analisadas e adicionadas após o lançamento.”).</p><p>• Use comunicações direcionadas aos defensores para gerar entusiasmo (por exemplo: “Melhoramos sua experiência de indicação!”).</p>                                                                                                                                                                                                                                                                                                       |

**Etapa 3: Pós-migração e ajustes finais (1–2 dias)**

Agora que o programa está em produção, verifique se está funcionando como esperado e resolva quaisquer pendências.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Verifique a integridade dos dados e o rastreamento das recompensas.</p><p>• Registre todas as conversões não contabilizadas.</p><p>• Ofereça suporte e oriente os usuários.</p>                                                                                                                                                                                                                                                                                                                                                                                         |
| Tarefas   | <p>• Valide se as relações entre quem indicou e quem foi indicado funcionam no modo de produção.</p><p>• Importe todas as conversões não contabilizadas que ocorreram durante a transição.</p><p>• Faça um teste de controle de qualidade (faça uma indicação para si mesmo e confirme o rastreamento e a lógica das recompensas).</p><p>• Disponibilize perguntas frequentes ou materiais de ajuda para as equipes internas e para os usuários.</p><p>• Monitore a caixa de entrada de suporte para identificar problemas relacionados a usuários da plataforma antiga.</p> |
| Dicas     | <p>• Se você for desativar uma conta antiga usada para financiar recompensas, conceda aos usuários um prazo para resgatá-las.</p><p>• Use e-mails ou lembretes no aplicativo para incentivar as primeiras indicações no novo programa.</p>                                                                                                                                                                                                                                                                                                                                   |

</details>

#### Importar os dados do seu programa

1. No menu de navegação à esquerda, selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-230534471fef5f40808e921e41ee44e4a06ded03%2Fe6cb9548999afdc1ed3ce4942e4cb5b45b5cecbd323267aac2a7cd1915fccc09.svg?alt=media) **\[Engage] → Reporting → Imports & Exports**.
2. No canto superior direito, selecione ![](https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-ec3276f07285180fbb2167a40e148d3e43e8681c%2F05aa88f72076df5a744d4620574f19cc187b7154fe1f3bb73ad7a892b7d23002.svg?alt=media) **Importar**.
3. Selecione o *Tipo de importação* entre as opções disponíveis:

   | Tipo de importação                           | Descrição                                                                                                                                                                                                                                                       |
   | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Usuários                                     | Selecione esta opção para enviar novos usuários ou dados de usuários existentes. Você também pode optar por importar esses dados de outra conta ou plataforma.                                                                                                  |
   | Atualizar saldos de recompensas dos usuários | Selecione esta opção para atualizar e resgatar os saldos de recompensas dos usuários.                                                                                                                                                                           |
   | Eventos de usuários                          | Selecione esta opção para enviar dados de eventos de usuários.                                                                                                                                                                                                  |
   | Excluir usuários                             | <p>Selecione esta opção se quiser excluir em massa usuários existentes do seu programa.</p><p>Você também pode excluir o tratamento de usuários e optar por:</p><p>• Preservar contas vazias</p><p>• Impedir que usuários excluídos sejam criados novamente</p> |
   | Histórico de recompensas                     | Selecione esta opção para enviar um registro de todas as informações de recompensas. Você também pode optar por importar esses dados de outra conta ou plataforma.                                                                                              |
   | Histórico de indicações                      | Selecione esta opção para enviar um registro de todas as conexões de indicação. Você também pode optar por importar esses dados de outra conta ou plataforma.                                                                                                   |
4. Selecionar **Escolher arquivo** ou arraste e solte o arquivo que você quer importar.
5. Selecione **Importar** para enviar seus dados.
   * Se estiver excluindo usuários existentes em massa, selecione **Exclusão em massa**.

#### Referência de erros de validação

Você pode receber 3 tipos de erros de validação:

1. **Mensagem de erro em linha:** elas aparecem na tabela de validação da prévia e destacam as linhas com erros em vermelho:

   * `INVALID_FIELD` — por exemplo, o campo *Data de criação* não foi formatado em [milissegundos desde a época Unix](https://currentmillis.com/) .
   * `MISSING_FIELD` — por exemplo, um campo obrigatório, como *ID do usuário* ou *ID da conta* está ausente.

   <div data-with-frame="true"><figure><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-eb521fbbc452c243d6b3763ebcb90053b4e9e4dc%2Ff969fa535707c24f4913282d07287a546b348f2448bdb4ca2eef0a30c871fbb6.png?alt=media" alt="" width="375"><figcaption></figcaption></figure></div>
2. **Aviso de erro:** eles aparecem no lugar da tabela de validação da prévia como mensagens de aviso em vermelho:

   * `MISSING_HEADER` — por exemplo, um cabeçalho de coluna obrigatório, como *ID da conta* ou *Valor da recompensa* está ausente.
   * `CSV_PARSING` — por exemplo, o arquivo CSV contém caracteres especiais com formatação incorreta.
   * `FILE_REF_IO` — por exemplo, o arquivo está corrompido e não pode ser lido.

   <div data-with-frame="true"><figure><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FqSd1JDFy8AQDR2aGJdrz%2FScreenshot%202026-05-25%20at%2017.58.06.png?alt=media&amp;token=26f43eaf-904a-4e1f-8b3c-185700af5edc" alt="" width="563"><figcaption></figcaption></figure></div>
3. **Erros listados:** eles aparecem como uma lista de contagens de erros na tela *Importações e exportações* na seção *Relatórios* quando o tipo de importação não tem uma tabela de validação prévia. Os erros nas linhas e no arquivo serão exibidos juntos:

   <div data-with-frame="true"><figure><img src="https://526234278-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FQuMoDG2ppJmsEdDwdw50%2FUntitled%20design%20(48).png?alt=media&amp;token=b1cbcb03-ffc7-4ad7-bbbd-c54b81ee3638" alt="" width="563"><figcaption></figcaption></figure></div>

#### Suporte

Você não precisa passar pela migração sem ajuda. Nossa equipe de integração Advocate está pronta para ajudar com:

* Suporte para mapeamento de campos
* Orientações sobre a formatação de dados
* Estratégia de migração de recompensas
* Testes e controle de qualidade

Entre em contato com sua [equipe de suporte Advocate](mailto:support-advocate@impact.com).


---

# 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://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/advocate-program/getting-started-with-advocate/import-your-referral-program-data.md?ask=<question>&goal=<user_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.
