> 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 mudar de outra plataforma de indicações para a Advocate, você não está apenas importando dados — você está elevando o potencial do seu programa com rastreamento poderoso, experiências personalizáveis e suporte especializado. Este artigo orienta você por:

* Por que a migração importa
* 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ções não é apenas uma tarefa técnica — é uma chance de elevar a forma como você engaja e recompensa seus clientes. Uma migração bem planejada ajuda a:

* Minimizar a interrupção na sua 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)
* Permitir uma transição limpa dos sistemas legados
* Reintroduzir seu programa de indicações 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 sua capacidade de exportar dados do seu sistema atual. Sua equipe da Advocate pode informar o que é possível com base nos dados de exportação que você fornecer.

Sua equipe da Advocate trabalhará com você para revisar seus arquivos de exportação, identificar o que é viável e criar um plano que corresponda às necessidades e aos objetivos do seu programa.

#### O que você precisará fazer

* Exportar os dados de *usuários*, *dados de indicação*, e *dados de recompensas*. Entre em contato com o CSM da sua antiga plataforma de indicações para obter ajuda ou use uma ferramenta de exportação na própria plataforma, se houver uma disponível.
* Baixe cada um dos 3 relatórios de dados em um arquivo CSV separado, por exemplo, `user_data.CSV`, `referral_data.CSV`, e `reward_data.CSV`.
  * Veja os exemplos abaixo para entender como o conteúdo de cada arquivo .csv pode ficar, ou consulte a referência completa do campo Destination.

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 filtrados 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 sharelink e do uso de um subdomínio personalizado.

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

Os seguintes campos são **obrigatórios**:

* ID do usuário
* ID da conta

Use o e-mail do usuário como seu *ID do usuário* e *ID da conta*. As datas devem ser formatadas em [milissegundos desde a época Unix](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 em `.csv` formato.

```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 datas de início e de conversão, e relacionamentos entre quem indicou e quem foi indicado. Isso dá suporte ao mapeamento do desempenho histórico das indicações.

O arquivo de dados de indicação fornece um registro do status de cada conexão de indicação feita no seu programa de indicações.

Os seguintes campos são **obrigatórios**:

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

Use o e-mail do usuário como seu *ID do usuário* e *ID da conta*. As datas devem ser formatadas em [milissegundos desde a época Unix](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 em `.csv` formato.

```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 concedidas/resgatadas, tipos de recompensa e status. Isso permite preservar a credibilidade e a justiça com os usuários.

O arquivo de Dados de Recompensas fornece um registro do histórico de recompensas dos participantes, incluindo seu valor e o valor resgatado gerado por meio do seu programa de indicações.

Os seguintes campos são **obrigatórios**:

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

Use o e-mail do usuário como seu *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 em 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 deve incluir o código da moeda no seguinte formato `<unitName>/<Currency>` (Ex.: Cash/USD).

{% hint style="warning" %}
**Importante**: Se os *Data de resgate* e *Valor resgatado* campos não forem definidos adequadamente — ou seja, se forem deixados em branco ou contiverem valores incorretos (por exemplo, uma data futura ou um valor resgatado impreciso) — a recompensa pode voltar a ficar disponível para o usuário resgatar 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 em `.csv` formato.

```programlisting
ID do usuário,ID da conta,ID do usuário indicado,ID da conta do usuário indicado,Nome da recompensa,Unidade da recompensa,Valor da recompensa,Valor resgatado,Data de criação,Data de concessão,Data de resgate
User1@example.com,User1@example.com,User2@example.com,User2@example.com,Dólares,CASH/USD,1000,1000,1709712158000,1709712158000,1709712158000
User1@example.com,User1@example.com,User3@example.com,User3@example.com,Pontos,POINT,100,100,1726164909682,1726164909682,1726164909682
User1@example.com,User1@example.com,User4@example.com,User4@example.com,Pontos,POINT,100,100,1726164887075,1726164887075,1726164887075
User1@example.com,User1@example.com,User5@example.com,User5@example.com,Pontos,POINT,100,100,1726164875888,1726164875888,1726164875888
User1@example.com,User1@example.com,User6@example.com,User6@example.com,Pontos,POINT,10,10,1726164828986,1726164828986,1726164828986
User1@example.com,User1@example.com,User7@example.com,User7@example.com,Crédito na conta,USD,8000,8000,1726164289997,1726164289997,1726164289997
User1@example.com,User1@example.com,,,Cartão-presente,USD,10000,10000,1726163864871,1726163864871,1726163864871
User1@example.com,User1@example.com,,,Pontos,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:** Todos os 3 arquivos de exportação devem conter dados de apenas um único programa. Se os arquivos tiverem dados de vários programas, a importação os consolidará em um único programa.
{% endhint %}

<details>

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

Toda migração é única, mas as bem-sucedidas seguem uma estrutura semelhante que equilibra preparação, comunicação e execução. Abaixo está um plano de migração que garante continuidade e uma experiência sem atritos para sua equipe e seus defensores. Os cronogramas e as fases podem variar de acordo com a configuração do seu programa.

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

Esta é a etapa de definição da base, que estabelece os alicerces para uma transição suave.

|         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Metas   | <p>• Alinhe as partes interessadas.</p><p>• Configuração técnica.</p><p>• Confirme o escopo da migração.</p><p>• Planeje a comunicação com os usuários.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Tarefas | <p>• Garanta uma amostra dos seus dados históricos (usuários, indicações, recompensas) e compartilhe com a equipe da Advocate para revisão e mapeamento de 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>• Exporte os conjuntos completos de dados depois que a amostra for validada. Muito provavelmente os dados exportados precisarão ser manipulados (por exemplo, ajustando cabeçalhos, nomes de campos ou a estrutura do arquivo) para corresponder aos requisitos de importação.</p><p>• Defina uma data de lançamento e uma janela de reversão.</p><p>• Adicione os widgets da Advocate em modo oculto (ambiente de teste ou páginas não vinculadas).</p><p>• Configure as integrações necessárias (por exemplo, Shopify, HubSpot, Segment).</p><p>• Conclua a configuração do programa na Advocate (por exemplo, configuração de recompensas, regras do programa, modelos de e-mail, segmentação).</p><p>• Teste a funcionalidade do programa de ponta a ponta — confirme que compartilhamentos, conversões e recompensas são rastreados corretamente em um ambiente de teste antes de entrar no ar.</p><p>• Elabore 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 sua capacidade de exportar dados do seu sistema atual. Sua equipe da Advocate pode informar o que é possível com base nos dados de exportação que você fornecer.</p> |
| Dicas   | <p>• Se você estiver usando plataformas sobrepostas, certifique-se de que apenas uma esteja emitindo recompensas.</p><p>• Identifique usuários de destaque que possam precisar de tratamento especial (VIPs, influenciadores).</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

**Fase 2: Virada 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, agende para horários de menor tráfego.

|         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Metas   | <p>• Faça a transição da sua plataforma legada para a Advocate sem complicações.</p><p>• Garanta que os usuários possam acessar imediatamente a nova experiência.</p><p>• Evite a perda de dados de indicação ou recompensas.</p>                                                                                                                                                                                                                                                                                                                                                                                                |
| Tarefas | <p>• Remova do seu site os scripts/widgets da plataforma antiga.</p><p>• Coloque os widgets da Advocate no ar.</p><p>• Importe os dados finais de usuários, indicações e recompensas.</p><p>• Rastreie/marque manualmente quaisquer conversões entre o desligamento e o lançamento do sistema.</p><p>• Monitore o painel da Advocate para acompanhar a atividade.</p><p>• Envie a comunicação de lançamento aos seus defensores. Informe aos usuários que seus links de indicação foram atualizados e, idealmente, inclua os novos links diretamente no e-mail para facilitar que eles comecem a compartilhar imediatamente.</p> |
| Dicas   | <p>• Inclua, se necessário, um breve período de bloqueio de recompensas (por exemplo, “Indicações feitas em 15 de maio serão revisadas e adicionadas após o lançamento.”).</p><p>• Use a comunicação voltada aos defensores para gerar entusiasmo (por exemplo, “Atualizamos sua experiência de indicação!”).</p>                                                                                                                                                                                                                                                                                                                |

**Fase 3: Pós-migração e limpeza (1–2 dias)**

Agora que você está no ar, garanta que o programa esteja funcionando como esperado e resolva quaisquer pendências.

|         |                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Metas   | <p>• Verifique a integridade dos dados e o rastreamento de recompensas.</p><p>• Registre quaisquer conversões perdidas.</p><p>• Ofereça suporte e orientação aos usuários.</p>                                                                                                                                                                                                                                                                                |
| Tarefas | <p>• Valide se os relacionamentos entre quem indicou e quem foi indicado funcionam no modo ao vivo.</p><p>• Importe quaisquer conversões perdidas que ocorreram durante a virada.</p><p>• Realize um teste de QA (indique você mesmo, confirme o rastreamento e a lógica de recompensas).</p><p>• Forneça FAQs ou documentos de ajuda internos e externos.</p><p>• Monitore a caixa de entrada de suporte para problemas relacionados a usuários legados.</p> |
| Dicas   | <p>• Se você estiver descontinuando uma conta legada de financiamento de recompensas, dê aos usuários um período de carência para resgate.</p><p>• Use e-mail ou lembretes no app para incentivar a atividade inicial de indicação no novo programa.</p>                                                                                                                                                                                                      |

</details>

#### Importe 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] → Relatórios → Importações e exportações**.
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* das opções disponíveis:

   | Tipo de importação                         | Descrição                                                                                                                                                                                                                                                               |
   | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Usuários                                   | Selecione esta opção para carregar novos usuários ou dados de usuários existentes. Você também pode optar por importar esses dados de uma conta ou plataforma diferente.                                                                                                |
   | Atualizar saldos de recompensas do usuário | Selecione esta opção para atualizar e resgatar saldos de recompensas dos usuários.                                                                                                                                                                                      |
   | Eventos do usuário                         | Selecione esta opção para carregar dados de eventos do usuário.                                                                                                                                                                                                         |
   | Excluir usuários                           | <p>Selecione esta opção se quiser excluir em massa os usuários existentes do seu programa.</p><p>Você também pode desativar o gerenciamento 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 carregar um registro de todas as informações de recompensa. Você também pode optar por importar esses dados de uma conta ou plataforma diferente.                                                                                             |
   | Histórico de indicações                    | Selecione esta opção para carregar um registro de todas as conexões de indicação. Você também pode optar por importar esses dados de uma conta ou plataforma diferente.                                                                                                 |
4. Selecione **Escolher arquivo** ou arraste e solte o arquivo que deseja importar.
5. Selecione **Importar** para carregar seus dados.
   * Se estiver excluindo usuários existentes em massa, selecione **Exclusão em massa**.

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

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

1. **Mensagem de erro inline:** elas aparecem na tabela de validação de visualização e fazem com que as linhas com erro sejam destacadas em vermelho:

   * `INVALID_FIELD` — por exemplo, o *Data de criação* campo 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. **Chamada de erro:** elas aparecem no lugar da tabela de validação de visualização 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 formatados incorretamente.
   * `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:** elas aparecem como uma lista de contagens de erros na *Importações e Exportações* tela dentro da *Relatórios* seção quando o tipo de importação não tem uma tabela de validação de visualização. Erros de linha e erros de 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 navegar pela migração sozinho. Nossa equipe de onboarding da Advocate está pronta para ajudar com:

* Suporte ao mapeamento de campos
* Orientação sobre formatação de dados
* Estratégia de migração de recompensas
* Teste e QA

Entre em contato com sua [equipe de suporte da 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.
