> 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/es/data-api/catalog-products-2/syncing-catalog-products-via-file.md).

# Sincronizar el catálogo y los productos mediante archivo

Epsilon Retail Media admite dos tipos de formato para la sincronización de datos de productos mediante archivo:

* TSV
* CSV

Esta sección describe las estructuras de cada formato de archivo para los datos de productos que procesamos en Epsilon Retail Media.

## Tamaño máximo de archivo

Epsilon Retail Media puede admitir archivos de catálogo de 10 M de productos o menos por minorista, lo que permite la mayoría de los catálogos de tamaño de marketplace.

{% hint style="info" %}
¿Tiene más de 10 M de productos?

Si su catálogo supera este volumen, Epsilon Retail Media puede evaluar si el tamaño de su catálogo es admisible. Tenga en cuenta que esto también puede requerir ajustes comerciales
{% endhint %}

## Archivos TSV/CSV

La siguiente tabla ilustra los nombres de columna y la descripción de las columnas para los productos en un archivo TSV/CSV. En esta tabla, también especificamos las columnas obligatorias que se deben proporcionar en un archivo. Cuando una columna es obligatoria, se deben proporcionar todos los valores de la columna en sus filas.

{% hint style="warning" %}
️ TSV sin entrecomillar

Los archivos TSV no pueden estar en formato entrecomillado. Al sincronizar mediante TSV, asegúrese de sincronizar archivos sin entrecomillar.
{% endhint %}

### Nombres de columna y descripciones de datos de productos en archivos TSV/CSV

| Nombre de columna        | Obligatorio/opcional                                                                      | Tipo de datos                                              | Descripción                                                                                                                                                                                                                                                                                                                                      | Ejemplo                                                                                                                                                                    |
| ------------------------ | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `product_code`           | Obligatorio                                                                               | <p>Texto<br>Máximo 50 caracteres</p>                       | Un código para identificar el producto en su sistema. Este campo es idéntico a los campos gtin e item en la sincronización de API y archivos XML.                                                                                                                                                                                                | F153212AN1                                                                                                                                                                 |
| `name`                   | Obligatorio                                                                               | <p>Texto<br>Máximo 150 caracteres</p>                      | El nombre del producto.                                                                                                                                                                                                                                                                                                                          | SS Sticker Tee - Kids                                                                                                                                                      |
| `image_url`              | Obligatorio                                                                               | <p>Url<br>Máximo 2048 caracteres</p>                       | Un hiperenlace a la imagen de un producto. Debe ser una URL válida.                                                                                                                                                                                                                                                                              | <https://www.retailer.com/product/1234.jpg>                                                                                                                                |
| `inventory`              | Obligatorio                                                                               | <p>Número<br>Se recomienda entero sin signo de 32 bits</p> | El inventario del producto. Si el valor es 0, no se mostrarán anuncios de producto para el producto.                                                                                                                                                                                                                                             | 1                                                                                                                                                                          |
| `description`            | Obligatorio                                                                               | <p>Texto<br>Máximo 5000 caracteres</p>                     | La descripción del producto.                                                                                                                                                                                                                                                                                                                     | Con trifolios bordados y 3 tiras delineadas en blanco en contraste, los Sport Sweat Shorts son una propuesta fresca de Adidas Originals.                                   |
| `KEY (as a value)`       | Obligatorio para ubicaciones de categoría y display amplio                                | <p>Texto<br>Máximo 1000 caracteres por columna</p>         | <p>Si se utiliza este tipo de columna, los minoristas deben proporcionar un valor para \<KEY>.<br><br>Puede tener varias columnas con esta sintaxis en un archivo TSV.</p>                                                                                                                                                                       | El nombre de la columna puede ser “brand” y el valor de la celda de la columna puede ser “green-fairy”. Esto resultará en un filtro de "brand:green-fairy" en el producto. |
| `subClassName`           | <p>Obsoleto.<br>Obligatorio para ubicaciones de venta cruzada/ascendente de productos</p> | <p>Texto<br>Máximo 750 caracteres</p>                      | <p>El nombre de la subclase/categoría en la que se encuentra el producto correspondiente.<br><br>Las subclases permiten una mejor segmentación de productos; p. ej., un producto de mantequilla puede segmentarse a pan, pero no se segmentará a curitas.</p>                                                                                    | Queso                                                                                                                                                                      |
| `xSellSubClassName`      | <p>Obsoleto.<br>Obligatorio para ubicaciones de venta cruzada/ascendente de productos</p> | <p>Texto<br>Máximo 750 caracteres</p>                      | Los nombres de las subclases/categorías dentro de las cuales el producto correspondiente puede segmentar productos.                                                                                                                                                                                                                              | Panes, Untables, Galletas saladas                                                                                                                                          |
| `price`                  | Opcional                                                                                  | <p>Número<br>Se recomiendan 2 decimales</p>                | El precio de un producto.                                                                                                                                                                                                                                                                                                                        | 30.00                                                                                                                                                                      |
| `brand`                  | Obligatorio                                                                               | <p>Texto<br>Máximo 70 caracteres</p>                       | La marca del producto.                                                                                                                                                                                                                                                                                                                           | Tommy Hilfiger                                                                                                                                                             |
| `type`                   | Obligatorio                                                                               | <p>Texto<br>Máximo 750 caracteres</p>                      | El tipo de producto.                                                                                                                                                                                                                                                                                                                             | Ropa                                                                                                                                                                       |
| `retailer_taxonomy`      | Obligatorio para la atribución mejorada. No debe tener espacios entre `>` caracteres      | <p>Texto<br>Máximo 750 caracteres</p>                      | Su taxonomía de minorista individual del producto.                                                                                                                                                                                                                                                                                               | Men>Men's Clothing>Sweaters                                                                                                                                                |
| `google_taxonomy`        | Obligatorio para la atribución mejorada si `retailer_taxonomy` no se puede proporcionar   | <p>Texto<br>Máximo 750 caracteres</p>                      | La taxonomía estándar de Google del producto. Puede encontrar más información aquí: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                                                            | Ropa y accesorios > Ropa > Tops                                                                                                                                            |
| `global_identifier`      | Obligatorio                                                                               | <p>Texto<br>Máximo 50 caracteres</p>                       | El identificador global del producto.                                                                                                                                                                                                                                                                                                            | 08719108994761                                                                                                                                                             |
| `global_identifier_type` | Obligatorio                                                                               | Texto                                                      | El tipo de identificador global.                                                                                                                                                                                                                                                                                                                 | GTIN                                                                                                                                                                       |
| `custom_payload`         | No es obligatorio a menos que se indique lo contrario.                                    | Matriz de bytes codificada en Base64                       | Este campo contiene una carga útil personalizada que debe enhebrarse hasta la generación del anuncio. El campo debe contener un objeto JSON válido serializado en una matriz de bytes y codificado en Base64. El objeto JSON debe adherirse a un esquema.                                                                                        | Consulte la sección de cargas útiles personalizadas.                                                                                                                       |
| `hfss`                   | Opcional                                                                                  | Boolean                                                    | Se utiliza para indicar si un producto es HFSS o no. Esto se aprovecha aún más en Epsilon Retail Mediade la IU. Consulte nuestro [Documentación sobre HFSS](/retail-media-interface/integration/es/feature-integrations/placement-level-product-type-blocking-hfss-support.md) para obtener más información.                                     | true                                                                                                                                                                       |
| `seller_id`              | Opcional                                                                                  | <p>Texto<br>Máximo 50 caracteres</p>                       | <p>El Id. único del vendedor. Solo es obligatorio si se incorporan vendedores del marketplace. Se puede dejar en blanco para productos que no son del marketplace.<br><br>Existen requisitos adicionales para integrar seller\_ids, consulte <a href="/pages/Soc3fZIo6t6n0MGxP2qm">sellerId de Marketplace</a> para obtener más información.</p> | aes-de4-ss                                                                                                                                                                 |

A continuación se muestra un archivo de ejemplo representado como una tabla:

| `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 pack de regalo de ajenjo y cuchara Green Fairy es el regalo perfecto para cualquier amante del ajenjo o de los cócteles. Coloque un cubo de azúcar en la cuchara y vierta el ajenjo por encima para beber este licor de forma auténtica. | Regalos, Bebidas alcohólicas, Packs de regalo | 500ml         | República Checa  | Regalos, Bebidas alcohólicas, Packs de regalo | `5.00`  | Green Fairy | Alcohol | Regalos>Bebidas alcohólicas>Packs de regalo | Alimentos, bebidas y tabaco>Bebidas>Bebidas alcohólicas>Licores y bebidas espirituosas>Ajenjo | 8594001443079       | 7328s-dmie3-9jdae | Packs de regalo | Licores           |

{% hint style="info" %}
Los archivos TSV no pueden estar en formato entre comillas.
{% endhint %}

## Actualización de imágenes de productos

Epsilon almacena en caché las URL de las imágenes para garantizar un rendimiento constante y reducir las solicitudes a su servidor de imágenes. Si actualiza una imagen sin cambiar su URL, debe activar explícitamente una actualización en Epsilon. Para hacer esto:

* Elimine el image\_url existente del producto.
* Vuelva a enviar el mismo image\_url una vez completada la actualización.

Alternativamente, si su servidor de imágenes lo admite, puede forzar una actualización añadiendo una cadena de consulta (por ejemplo, una versión o marca de tiempo) a la URL existente. Esto hará que Epsilon vuelva a cargar la imagen..

{% hint style="info" %}
Las imágenes solo se utilizan en la IU

Las imágenes de los productos no se sirven en las respuestas de los anuncios. Cualquier actualización de imagen solo afecta a cómo aparece el producto en la Epsilon IU mientras se produce la actualización de la caché.
{% endhint %}

## Archivos XML: obsolescencia planificada

{% hint style="danger" %}
️ Obsoleto para nuevos clientes

Lo siguiente se proporciona para clientes heredados que aún utilizan el formato XML. Para la incorporación de nuevos catálogos, admitimos los formatos TSV y CSV documentados anteriormente, que ofrecen una mayor flexibilidad de archivos, así como la oportunidad de sincronizar el archivo varias veces al día.
{% endhint %}

Epsilon Retail Media ha definido una lista de etiquetas que se utilizan para describir un documento XML para productos. La siguiente tabla muestra las etiquetas y sus descripciones. La etiqueta "item" se utiliza para describir un producto en un documento XML. Todas las demás etiquetas para los otros campos deben escribirse dentro de esta etiqueta.

| Etiquetas XML            | Obligatorio/opcional                                                                                                                  | Descripción                                                                                                                                                                                                                                                                                                                                      |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `item`                   | Obligatorio                                                                                                                           | Esta etiqueta se utiliza para describir un producto. Todas las demás etiquetas XML para un producto deben estar dentro de esta etiqueta. Un documento XML para productos debe contener una lista de etiquetas de elementos. Este campo es idéntico a los campos gtin y product\_code en la sincronización de archivos API y TSV.                 |
| `id`                     | Obligatorio                                                                                                                           | Un código para identificar el producto en su sistema. Equivalente a `product_code` en archivos TSV. Este campo es idéntico a los campos gtin e item en la sincronización de archivos API y XML.                                                                                                                                                  |
| `title`                  | Obligatorio                                                                                                                           | El nombre del producto.                                                                                                                                                                                                                                                                                                                          |
| `image_link`             | <p>Obligatorio<br>Máximo 50 caracteres</p>                                                                                            | Un hiperenlace a la imagen de un producto. Debe ser una URL válida.                                                                                                                                                                                                                                                                              |
| `brand`                  | <p>Obligatorio<br>Máximo 70 caracteres</p>                                                                                            | La marca del producto.                                                                                                                                                                                                                                                                                                                           |
| `availability`           | <p>Obligatorio<br>Se recomienda entero sin signo de 32 bits</p>                                                                       | Esta etiqueta sirve para describir el inventario de un producto. El valor debe ser un número.                                                                                                                                                                                                                                                    |
| `description`            | <p>Obligatorio<br>Máximo 5000 caracteres</p>                                                                                          | Esta etiqueta sirve para describir la descripción de un producto.                                                                                                                                                                                                                                                                                |
| `price`                  | <p>Opcional<br>Se recomiendan 2 decimales</p>                                                                                         | Esta etiqueta sirve para describir el precio de un producto. Si se proporciona el valor dentro de la etiqueta, debe ser un número.                                                                                                                                                                                                               |
| `type`                   | <p>Opcional<br>Máximo 750 caracteres</p>                                                                                              | El tipo de producto.                                                                                                                                                                                                                                                                                                                             |
| `retailer_taxonomy`      | <p>Obligatorio para la atribución mejorada. También es obligatorio para las integraciones de categorías.<br>Máximo 750 caracteres</p> | Su taxonomía de minorista individual del producto. Por ejemplo, Ropa de hombre>Ropa de hombre>Jerséis                                                                                                                                                                                                                                            |
| `google_taxonomy`        | <p>Obligatorio para la atribución mejorada si <code>retailer\_taxonomy</code> no se puede proporcionar<br>Máximo 750 caracteres</p>   | La taxonomía estándar de Google del producto. Puede encontrar más información aquí: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                                                            |
| `global_identifier`      | <p>Obligatorio<br>Máximo 50 caracteres</p>                                                                                            | El identificador global del producto. Por ejemplo, `08719108994761`                                                                                                                                                                                                                                                                              |
| `global_identifier_type` | Obligatorio                                                                                                                           | El tipo de identificador global. Por ejemplo, `GTIN`                                                                                                                                                                                                                                                                                             |
| `custom_payload`         | No es obligatorio a menos que se indique lo contrario.                                                                                | Este campo contiene una carga útil personalizada que debe enhebrarse hasta la generación del anuncio. El campo debe contener un objeto JSON válido serializado en una matriz de bytes y codificado en Base64. El objeto JSON debe adherirse a un esquema.                                                                                        |
| `hfss`                   | Opcional                                                                                                                              | Se utiliza para indicar si un producto es HFSS o no. Esto se aprovecha aún más en Epsilon Retail Mediade la IU. Consulte nuestro [Documentación sobre HFSS](/retail-media-interface/integration/es/feature-integrations/placement-level-product-type-blocking-hfss-support.md) para obtener más información.                                     |
| `seller_id`              | <p>Opcional<br>Máximo 50 caracteres</p>                                                                                               | <p>El Id. único del vendedor. Solo es obligatorio si se incorporan vendedores del marketplace. Se puede dejar en blanco para productos que no son del marketplace.<br><br>Existen requisitos adicionales para integrar seller\_ids, consulte <a href="/pages/Soc3fZIo6t6n0MGxP2qm">sellerId de Marketplace</a> para obtener más información.</p> |

A continuación se describe un ejemplo de un documento XML válido con las etiquetas:

```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 útiles personalizadas

### ¿Qué son las cargas útiles personalizadas?

Las cargas útiles personalizadas son campos que se transmiten "tal cual" desde la ingesta del catálogo hasta la publicación del anuncio. No se aplicará ninguna transformación al campo. Sin embargo, se realiza una validación basada en JSON Schema (<https://json-schema.org/>) en el campo. La especificación de la carga útil se proporciona a través del siguiente enlace (notación JSON Schema):

En la respuesta del anuncio del producto, la carga útil personalizada exacta se devuelve al integrador en un campo denominado `customPayload`. A continuación se muestra un ejemplo de una carga útil válida:

```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" %}
Solo archivo

Tenga en cuenta que las cargas útiles personalizadas solo se admiten al sincronizar productos mediante un archivo.
{% endhint %}

### Payloads personalizados en la generación de anuncios

Al devolver anuncios de productos, el payload personalizado se incluye como parte del anuncio generado. Los payloads de los anuncios devueltos contendrán un campo adicional `customPayload` que contendrá un objeto JSON que cumple con la misma especificación que la información proporcionada en el feed.

Una respuesta de ejemplo puede 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" %}
Dado que los payloads personalizados suponen una carga de trabajo adicional para nuestro servicio de generación de anuncios, tenga en cuenta que las integraciones de payloads personalizados no están sujetas al Epsilon Retail Media SLA, a menos que se especifique lo contrario.
{% 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/es/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.
