> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/pt-br/data-api/catalog-products-2/syncing-catalog-products-via-file.md).

# Sincronizando catálogo e produtos via arquivo

Epsilon Retail Media suporta dois tipos de formato para sincronização de dados de produtos via arquivo:

* TSV
* CSV

Esta seção descreve as estruturas de cada formato de arquivo para os dados de produtos que processamos em Epsilon Retail Media.

## Tamanho máximo do arquivo

Epsilon Retail Media conseguem suportar arquivos de catálogo de 10M de produtos ou menos por varejista, permitindo a maioria dos catálogos de tamanho de marketplace.

{% hint style="info" %}
Você tem mais de 10M de produtos?

Se o seu catálogo estiver acima deste volume, Epsilon Retail Media pode avaliar se o tamanho do seu catálogo é suportável. Observe que isso também pode exigir ajustes comerciais
{% endhint %}

## Arquivos TSV/CSV

A tabela abaixo ilustra os nomes das colunas e a descrição das colunas para produtos em um arquivo TSV/CSV. Nesta tabela, também especificamos as colunas obrigatórias que devem ser fornecidas em um arquivo. Quando uma coluna é obrigatória, todos os valores na coluna precisam ser fornecidos em suas linhas.

{% hint style="warning" %}
️ TSV sem aspas

Os arquivos TSV não podem estar em formato entre aspas. Ao sincronizar via TSV, certifique-se de sincronizar arquivos sem aspas.
{% endhint %}

### Nomes de colunas e descrições de dados de produtos em arquivos TSV/CSV

| Nome da coluna           | Obrigatório/opcional                                                                          | Tipo de dados                                                | Descrição                                                                                                                                                                                                                                                                                                                                           | Exemplo                                                                                                                                                |
| ------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `product_code`           | Obrigatório                                                                                   | <p>Texto<br>Máx. de 50 caracteres</p>                        | Um código para identificar o produto no seu sistema. Este campo é idêntico aos campos gtin e item na sincronização via API e arquivo XML.                                                                                                                                                                                                           | F153212AN1                                                                                                                                             |
| `name`                   | Obrigatório                                                                                   | <p>Texto<br>Máx. de 150 caracteres</p>                       | O nome do produto.                                                                                                                                                                                                                                                                                                                                  | SS Sticker Tee - Kids                                                                                                                                  |
| `image_url`              | Obrigatório                                                                                   | <p>Url<br>Máx. de 2048 caracteres</p>                        | Um hiperlink para a imagem de um produto. Deve ser uma URL válida.                                                                                                                                                                                                                                                                                  | <https://www.retailer.com/product/1234.jpg>                                                                                                            |
| `inventory`              | Obrigatório                                                                                   | <p>Número<br>Inteiro não assinado de 32 bits recomendado</p> | O estoque do produto. Se o valor for 0, os anúncios de produtos não serão exibidos para o produto.                                                                                                                                                                                                                                                  | 1                                                                                                                                                      |
| `description`            | Obrigatório                                                                                   | <p>Texto<br>Máx. de 5000 caracteres</p>                      | A descrição do produto.                                                                                                                                                                                                                                                                                                                             | Com Trefoils bordados e 3-Stripes contornados em branco contrastante, o Sport Sweat Shorts é uma novidade da Adidas Originals.                         |
| `KEY (as a value)`       | Obrigatório para posicionamentos de categoria e display amplo                                 | <p>Texto<br>Máx. de 1000 caracteres por coluna</p>           | <p>Se esse tipo de coluna for usado, os varejistas deverão fornecer um valor para \<KEY>.<br><br>Você pode ter várias colunas com esta sintaxe em um arquivo TSV.</p>                                                                                                                                                                               | O nome da coluna pode ser “brand” e o valor da célula na coluna pode ser “green-fairy”. Isso resultará em um filtro de "brand:green-fairy" no produto. |
| `subClassName`           | <p>Descontinuado.<br>Obrigatório para posicionamentos de venda cruzada/upsell de produtos</p> | <p>Texto<br>Máx. de 750 caracteres</p>                       | <p>O nome da subclasse/categoria em que o produto relevante está.<br><br>As subclasses permitem um melhor direcionamento de produtos, por exemplo, um produto de manteiga pode direcionar para pão, mas não direcionará para curativos.</p>                                                                                                         | Queijo                                                                                                                                                 |
| `xSellSubClassName`      | <p>Descontinuado.<br>Obrigatório para posicionamentos de venda cruzada/upsell de produtos</p> | <p>Texto<br>Máx. de 750 caracteres</p>                       | Os nomes das subclasses/categorias nas quais o produto relevante é capaz de direcionar produtos.                                                                                                                                                                                                                                                    | Pães, Pastas, Biscoitos                                                                                                                                |
| `price`                  | Opcional                                                                                      | <p>Número<br>2 casas decimais recomendadas</p>               | O preço de um produto.                                                                                                                                                                                                                                                                                                                              | 30.00                                                                                                                                                  |
| `brand`                  | Obrigatório                                                                                   | <p>Texto<br>Máx. de 70 caracteres</p>                        | A marca do produto.                                                                                                                                                                                                                                                                                                                                 | Tommy Hilfiger                                                                                                                                         |
| `type`                   | Obrigatório                                                                                   | <p>Texto<br>Máx. de 750 caracteres</p>                       | O tipo de produto.                                                                                                                                                                                                                                                                                                                                  | Roupas                                                                                                                                                 |
| `retailer_taxonomy`      | Obrigatório para atribuição aprimorada. Não deve ter espaços entre `>` caracteres             | <p>Texto<br>Máx. de 750 caracteres</p>                       | Sua taxonomia individual de varejista do produto.                                                                                                                                                                                                                                                                                                   | Masculino>Roupas Masculinas>Suéteres                                                                                                                   |
| `google_taxonomy`        | Obrigatório para atribuição aprimorada se `retailer_taxonomy` não puder ser fornecido         | <p>Texto<br>Máx. de 750 caracteres</p>                       | A taxonomia padrão do Google do produto. Mais informações podem ser encontradas aqui: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                                                             | Vestuário e acessórios > Roupas > Blusas e Camisas                                                                                                     |
| `global_identifier`      | Obrigatório                                                                                   | <p>Texto<br>Máx. de 50 caracteres</p>                        | O identificador global do produto.                                                                                                                                                                                                                                                                                                                  | 08719108994761                                                                                                                                         |
| `global_identifier_type` | Obrigatório                                                                                   | Texto                                                        | O tipo de identificador global.                                                                                                                                                                                                                                                                                                                     | GTIN                                                                                                                                                   |
| `custom_payload`         | Não obrigatório, a menos que seja orientado.                                                  | Matriz de bytes codificada em Base64                         | Este campo contém uma carga útil personalizada que deve ser transmitida para a geração de anúncios. O campo deve conter um objeto JSON válido serializado em uma matriz de bytes e codificado em Base64. O objeto JSON deve aderir a um esquema.                                                                                                    | Consulte a seção de cargas úteis personalizadas.                                                                                                       |
| `hfss`                   | Opcional                                                                                      | Booleano                                                     | Usado para indicar se um produto é HFSS ou não. Isso é aproveitado na Epsilon Retail Mediainterface da . Veja nossa [Documentação HFSS](/retail-media-interface/integration/pt-br/feature-integrations/placement-level-product-type-blocking-hfss-support.md) para obter mais informações.                                                          | true                                                                                                                                                   |
| `seller_id`              | Opcional                                                                                      | <p>Texto<br>Máx. de 50 caracteres</p>                        | <p>O ID exclusivo do vendedor. Obrigatório apenas se estiver integrando vendedores do marketplace. Pode ser deixado em branco para produtos que não são de marketplace.<br><br>Existem requisitos adicionais para integrar seller\_ids, consulte <a href="/pages/GxgwmD57R8gNwn0Yn1ks">sellerId do marketplace</a> para obter mais informações.</p> | aes-de4-ss                                                                                                                                             |

Um exemplo de arquivo representado como uma tabela pode ser visto abaixo:

| `product_code` | `name`                              | `image_url`                                 | `inventory` | `description`                                                                                                                                                                                                                     | `filter:Category`                                | `filter:Size` | `filter:Country` | `groups`                                         | `price` | `brand`     | `type`             | `retailer_taxonomy`                            | `google_taxonomy`                                                                                | `global_identifier` | seller\_id        | subClassName      | xSellSubClassName  |
| -------------- | ----------------------------------- | ------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ------------- | ---------------- | ------------------------------------------------ | ------- | ----------- | ------------------ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------- | ----------------- | ----------------- | ------------------ |
| 80591101       | Green Fairy Absinth Gift Pack 500mL | <https://www.retailer.com/product/1234.jpg> | `20`        | Este Gift Pack de Absinto e Colher Green Fairy é o presente perfeito para qualquer amante de absinto ou coquetéis. Coloque um cubo de açúcar na colher e despeje o absinto por cima para beber este destilado da forma autêntica! | Presentes, Bebidas alcoólicas, Packs de presente | 500ml         | República Tcheca | Presentes, Bebidas alcoólicas, Packs de presente | `5.00`  | Green Fairy | Bebidas alcoólicas | Presentes>Bebidas alcoólicas>Packs de presente | Alimentos, bebidas e tabaco>Bebidas>Bebidas alcoólicas>Destilados e bebidas espirituosas>Absinto | 8594001443079       | 7328s-dmie3-9jdae | Packs de presente | Bebidas alcoólicas |

{% hint style="info" %}
Arquivos TSV não podem estar em formato entre aspas.
{% endhint %}

## Atualizando imagens do produto

Epsilon armazena em cache as URLs das imagens para garantir um desempenho consistente e reduzir as solicitações ao seu servidor de imagens. Se você atualizar uma imagem sem alterar sua URL, deverá disparar explicitamente uma atualização no Epsilon. Para fazer isso:

* Remova a image\_url existente do produto.
* Reenvie a mesma image\_url assim que a atualização for concluída.

Como alternativa, se o seu servidor de imagens der suporte, você poderá forçar uma atualização anexando uma string de consulta (por exemplo, uma versão ou carimbo de data/hora) à URL existente. Isso fará com que o Epsilon recarregue a imagem..

{% hint style="info" %}
As imagens são usadas apenas na UI

As imagens dos produtos não são fornecidas nas respostas dos anúncios. Quaisquer atualizações de imagem afetam apenas a aparência do produto na Epsilon UI enquanto a atualização do cache ocorre.
{% endhint %}

## Arquivos XML- descontinuação planejada

{% hint style="danger" %}
️ Descontinuado para novos clientes

O conteúdo abaixo é fornecido para clientes legados que ainda utilizam o formato XML. Para o onboarding de novos catálogos, oferecemos suporte aos formatos TSV e CSV documentados acima, o que proporciona maior flexibilidade de arquivo, bem como a oportunidade de sincronizar o arquivo várias vezes ao dia.
{% endhint %}

Epsilon Retail Media definiu uma lista de tags que são usadas para descrever um documento XML para produtos. A tabela abaixo ilustra as tags e suas descrições. A tag 'item' é usada para descrever um produto em um documento XML. Todas as outras tags para os outros campos devem ser escritas dentro desta tag.

| Tags XML                 | Obrigatório/opcional                                                                                                               | Descrição                                                                                                                                                                                                                                                                                                                                           |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `item`                   | Obrigatório                                                                                                                        | Esta tag é usada para descrever um produto. Todas as outras tags XML para um produto devem estar dentro desta tag. Um documento XML para produtos deve conter uma lista de tags item. Este campo é idêntico aos campos gtin e product\_code na sincronização de arquivos via API e TSV.                                                             |
| `id`                     | Obrigatório                                                                                                                        | Um código para identificar o produto no seu sistema. Equivalente ao `product_code` em arquivos TSV. Este campo é idêntico aos campos gtin e item na sincronização de arquivos via API e XML.                                                                                                                                                        |
| `title`                  | Obrigatório                                                                                                                        | O nome do produto.                                                                                                                                                                                                                                                                                                                                  |
| `image_link`             | <p>Obrigatório<br>Máx. de 50 caracteres</p>                                                                                        | Um hiperlink para a imagem de um produto. Deve ser uma URL válida.                                                                                                                                                                                                                                                                                  |
| `brand`                  | <p>Obrigatório<br>Máx. de 70 caracteres</p>                                                                                        | A marca do produto.                                                                                                                                                                                                                                                                                                                                 |
| `availability`           | <p>Obrigatório<br>Inteiro não assinado de 32 bits recomendado</p>                                                                  | Esta tag serve para descrever o inventário de um produto. O valor deve ser um número.                                                                                                                                                                                                                                                               |
| `description`            | <p>Obrigatório<br>Máx. de 5000 caracteres</p>                                                                                      | Esta tag serve para descrever a descrição de um produto.                                                                                                                                                                                                                                                                                            |
| `price`                  | <p>Opcional<br>2 casas decimais recomendadas</p>                                                                                   | Esta tag serve para descrever o preço de um produto. Se o valor dentro da tag for fornecido, ele deverá ser um número.                                                                                                                                                                                                                              |
| `type`                   | <p>Opcional<br>Máx. de 750 caracteres</p>                                                                                          | O tipo de produto.                                                                                                                                                                                                                                                                                                                                  |
| `retailer_taxonomy`      | <p>Obrigatório para atribuição aprimorada. Também obrigatório para integrações de categoria.<br>Máx. de 750 caracteres</p>         | Sua taxonomia individual de varejista para o produto. Ex.: Masculino>Roupas Masculinas>Suéteres                                                                                                                                                                                                                                                     |
| `google_taxonomy`        | <p>Obrigatório para atribuição aprimorada se <code>retailer\_taxonomy</code> não puder ser fornecido<br>Máx. de 750 caracteres</p> | A taxonomia padrão do Google do produto. Mais informações podem ser encontradas aqui: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                                                             |
| `global_identifier`      | <p>Obrigatório<br>Máx. de 50 caracteres</p>                                                                                        | O identificador global do produto. Ex. `08719108994761`                                                                                                                                                                                                                                                                                             |
| `global_identifier_type` | Obrigatório                                                                                                                        | O tipo de identificador global. Ex. `GTIN`                                                                                                                                                                                                                                                                                                          |
| `custom_payload`         | Não obrigatório, a menos que seja orientado.                                                                                       | Este campo contém uma carga útil personalizada que deve ser transmitida para a geração de anúncios. O campo deve conter um objeto JSON válido serializado em uma matriz de bytes e codificado em Base64. O objeto JSON deve aderir a um esquema.                                                                                                    |
| `hfss`                   | Opcional                                                                                                                           | Usado para indicar se um produto é HFSS ou não. Isso é aproveitado na Epsilon Retail Mediainterface da . Veja nossa [Documentação HFSS](/retail-media-interface/integration/pt-br/feature-integrations/placement-level-product-type-blocking-hfss-support.md) para obter mais informações.                                                          |
| `seller_id`              | <p>Opcional<br>Máx. de 50 caracteres</p>                                                                                           | <p>O ID exclusivo do vendedor. Obrigatório apenas se estiver integrando vendedores do marketplace. Pode ser deixado em branco para produtos que não são de marketplace.<br><br>Existem requisitos adicionais para integrar seller\_ids, consulte <a href="/pages/GxgwmD57R8gNwn0Yn1ks">sellerId do marketplace</a> para obter mais informações.</p> |

Um exemplo de um documento XML válido com as tags é apresentado abaixo:

```xml
<rss>
  <item>
      <id>80591011</id>
      <title>Melissa &amp; Doug Dinosaur Stamp Set, 4yrs+</title>
      <description>Imagine a rugged landscape littered with volcanoes, and full of dinosaurs roaming around</description>
      <image_link>https://www.retailer.com/productImages/image1.jpg</image_link>
      <price>&pound;9.99</price>
      <brand>Melissa &amp; Doug</price>
      <product_type>Food Cupboard</product_type>
      <availability>10</availability>
    	<hfss>true</hfss>
    </item>
    <item>
      <id>87086011</id>
      <title>Waitrose Splits Strawberry Ice Lollies</title>
      <description>Strawberry splits; Suitable for vegetarians. Strawberry splits vanilla flavoured ice cream with a fruity strawberry ice coating. Our fundamental belief is that few things in life are more important than the food you buy. Good quality is essential.</description>
			<image_link>https://www.retailer.com/productImages/image2.jpg</image_link>
      <price>&pound;1.25</price>
      <brand>Waitrose</brand>
      <product_type>Frozen Ice Cream Ice Cream Lollies</product_type>
      <availability>20</availability>
      <brand>Waitrose</brand>
      <hfss>false</hfss>
      <seller_id>432un3-sd32s-ssaar</seller_id>
    </item>
</rss>
```

## Cargas úteis personalizadas

### O que são cargas úteis personalizadas?

Cargas úteis personalizadas são campos transmitidos 'como estão' desde a ingestão do catálogo até a veiculação do anúncio. Nenhuma transformação será aplicada ao campo. No entanto, a validação baseada em JSON Schema (<https://json-schema.org/>) é realizada no campo. A especificação da carga útil é fornecida no link abaixo (notação JSON Schema):

Na resposta do anúncio do produto, a carga útil personalizada exata é retornada ao integrador em um campo chamado `customPayload`. Um exemplo de carga útil válida é fornecido abaixo:

```json
{
  "id": "102013703",
  "upc": "4400000463",
  "name": "Bee Farms Honey - 14.4 Oz",
  "nutrientName": [
    "Kosher"
  ],
  "description": "Honey",
  "brand": "Bee Farms",
  "imageUrl": "https://www.retailer.com/products/1/image.png",
  "productUrl": "https://www.retailer.com/products/1/page.html",
  "aisleId": "1_22_2_3",
  "departmentName": "Breakfast ",
  "aisleName": "Breakfast spreads",
  "shelfName": "Honeu",
  "salesRank": 481,
  "details": "Made with real honey. No high fructose corn syrup. 8 g of while grain per 31 g serving. Per 8 Crackers: 130 calories; 0 g sat fat (% DV); 160 mg sodium (7% DV); 8 g total sugars. Start with: Bee farms honey grahams. Fill grahams with toasted marshmallows. Add milk chocolate squares. For full nutritional information, go to honeymaid.com. Try our other delicious flavors: Grahams made with real cinnamon. Grahams made with real chocolate. 8 g of whole grain per 31 g serving. Nutritionist recommend eating 18 g or more of whole grains throughout the day. 100% Whole Grain: 8 per serving. Eat 48 g or more of whole grains daily. WholeGrainsCouncil.org. Smartlabel. Visit us at: beefarms.com 1-809-622-4726 please have package available. Keep it Going: 100 recycled paperboard. Please recycle this carton. Minimum 35% post-consumer content. Made in Mexico.",
  "averageWeight": 0,
  "displayType": 0,
  "stores": [
    {
      "storeId": "2543",
      "price": 3.99,
      "salePrice": 0.28,
      "pricePer": 4.99,
      "unitOfMeasure": "OUNCE",
      "restrictedFlag": false,
      "sellByWeight": false,
      "promoDescription": "I",
      "promoText": "Club Price: $3.99&lt;BR&gt;SAVE up to: $1",
      "promoType": "P",
      "offerFlag": true
    },
    {
      "storeId": "2544",
      "price": 3.99,
      "salePrice": 0.28,
      "pricePer": 4.99,
      "unitOfMeasure": "OUNCE",
      "restrictedFlag": false,
      "sellByWeight": false,
      "promoDescription": "I",
      "promoText": "Club Price: $3.99&lt;BR&gt;SAVE up to: $1",
      "promoType": "P",
      "offerFlag": true
    }
  ]
}
```

{% hint style="warning" %}
Somente arquivo

Observe que cargas úteis personalizadas só são suportadas ao sincronizar produtos via arquivo.
{% endhint %}

### Cargas úteis personalizadas na geração de anúncios

Ao retornar anúncios de produtos, a carga útil personalizada é transmitida como parte do anúncio gerado. As cargas úteis dos anúncios retornados conterão um campo adicional `customPayload` que conterá um objeto JSON aderente à mesma especificação das informações fornecidas no feed.

Um exemplo de resposta pode ser:

```json
{
    "ads": [
        {
            "id": "display_SEY2W7-VZzspoirbw4ANs-r-w6YyODk5MDQ5UA==",
            "gtin": "4400000463",
            "customPayload": {
                "id": "102013703",
                "upc": "4400000463",
                "name": "Bee Farms Honey - 14.4 Oz",
                "nutrientName": [
                  "Kosher"
                ],
                "description": "Honey",
                "brand": "Bee Farms",
                "imageUrl": "https://www.retailer.com/products/1/image.png",
                "productUrl": "https://www.retailer.com/products/1/page.html",
                "aisleId": "1_22_2_3",
                "departmentName": "Breakfast ",
                "aisleName": "Breakfast spreads",
                "shelfName": "Honeu",
                "salesRank": 481,
                "details": "Made with real honey. No high fructose corn syrup. 8 g of while grain per 31 g serving. Per 8 Crackers: 130 calories; 0 g sat fat (% DV); 160 mg sodium (7% DV); 8 g total sugars. Start with: Bee farms honey grahams. Fill grahams with toasted marshmallows. Add milk chocolate squares. For full nutritional information, go to honeymaid.com. Try our other delicious flavors: Grahams made with real cinnamon. Grahams made with real chocolate. 8 g of whole grain per 31 g serving. Nutritionist recommend eating 18 g or more of whole grains throughout the day. 100% Whole Grain: 8 per serving. Eat 48 g or more of whole grains daily. WholeGrainsCouncil.org. Smartlabel. Visit us at: beefarms.com 1-809-622-4726 please have package available. Keep it Going: 100 recycled paperboard. Please recycle this carton. Minimum 35% post-consumer content. Made in Mexico.",
                "averageWeight": 0,
                "displayType": 0,
                "stores": [
                  {
                  "storeId": "2543",
                  "price": 3.99,
                  "salePrice": 0.28,
                  "pricePer": 4.99,
                  "unitOfMeasure": "OUNCE",
                  "restrictedFlag": false,
                  "sellByWeight": false,
                  "promoDescription": "I",
                  "promoText": "Club Price: $3.99&lt;BR&gt;SAVE up to: $1",
                  "promoType": "P",
                  "offerFlag": true
                  },
                  {
                  "storeId": "2544",
                  "price": 3.99,
                  "salePrice": 0.28,
                  "pricePer": 4.99,
                  "unitOfMeasure": "OUNCE",
                  "restrictedFlag": false,
                  "sellByWeight": false,
                  "promoDescription": "I",
                  "promoText": "Club Price: $3.99&lt;BR&gt;SAVE up to: $1",
                  "promoType": "P",
                  "offerFlag": true
                }
              ]
            } ,
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2019-12-10T01:46:07.516943179Z"
        }
    ],
    "banners": [],
    "products": []
}
```

{% hint style="warning" %}
Como as cargas úteis personalizadas são um trabalho adicional para nosso serviço de geração de anúncios, observe que as integrações de cargas úteis personalizadas não estão sujeitas a Epsilon Retail Media SLA, salvo especificação em contrário.
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/integration/pt-br/data-api/catalog-products-2/syncing-catalog-products-via-file.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
