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

# Synchronizace katalogu a produktů pomocí souboru

Epsilon Retail Media podporuje dva typy formátů pro synchronizaci produktových dat prostřednictvím souboru:

* TSV
* CSV

Tato sekce popisuje struktury jednotlivých formátů souborů pro produktová data, která zpracováváme v Epsilon Retail Media.

## Maximální velikost souboru

Epsilon Retail Media jsou schopny podporovat soubory katalogu s 10 miliony produktů nebo méně na jednoho prodejce, což umožňuje obsloužit většinu katalogů o velikosti tržiště.

{% hint style="info" %}
Máte více než 10 milionů produktů?

Pokud váš katalog překračuje tento objem, Epsilon Retail Media může posoudit, zda je velikost vašeho katalogu podporovatelná. Upozorňujeme, že to může vyžadovat také obchodní úpravy
{% endhint %}

## Soubory TSV/CSV

Níže uvedená tabulka znázorňuje názvy sloupců a popis sloupců pro produkty v souboru TSV/CSV. V této tabulce také specifikujeme povinné sloupce, které je nutné v souboru uvést. Pokud je sloupec vyžadován, musí být v jeho řádcích uvedeny všechny hodnoty.

{% hint style="warning" %}
️ TSV bez uvozovek

Soubory TSV nemohou být ve formátu s uvozovkami. Při synchronizaci přes TSV se ujistěte, že synchronizujete soubory bez uvozovek.
{% endhint %}

### Názvy sloupců a popisy produktových dat v souborech TSV/CSV

| Název sloupce            | Povinné/volitelné                                                                                   | Datový typ                                                  | Popis                                                                                                                                                                                                                                                                                                  | Příklad                                                                                                                                |
| ------------------------ | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `product_code`           | Povinné                                                                                             | <p>Text<br>Max. 50 znaků</p>                                | Kód pro identifikaci produktu ve vašem systému. Toto pole je shodné s poli gtin a item při synchronizaci přes API a XML soubory.                                                                                                                                                                       | F153212AN1                                                                                                                             |
| `name`                   | Povinné                                                                                             | <p>Text<br>Max. 150 znaků</p>                               | Název produktu.                                                                                                                                                                                                                                                                                        | SS Sticker Tee - Kids                                                                                                                  |
| `image_url`              | Povinné                                                                                             | <p>Url<br>Max. 2048 znaků</p>                               | Hypertextový odkaz na obrázek produktu. Musí se jednat o platnou URL.                                                                                                                                                                                                                                  | <https://www.retailer.com/product/1234.jpg>                                                                                            |
| `inventory`              | Povinné                                                                                             | <p>Číslo<br>Doporučeno 32bitové celé číslo bez znaménka</p> | Skladová zásoba produktu. Pokud je hodnota 0, reklamy na tento produkt se nebudou zobrazovat.                                                                                                                                                                                                          | 1                                                                                                                                      |
| `description`            | Povinné                                                                                             | <p>Text<br>Max. 5000 znaků</p>                              | Popis produktu.                                                                                                                                                                                                                                                                                        | Sport Sweat Shorts od Adidas Originals nabízí svěží vzhled s vyšívanými jetelemi a lemovanými 3 proužky v kontrastní bílé barvě.       |
| `KEY (as a value)`       | Vyžadováno dla křížového a plošného umístění v kategoriích                                          | <p>Text<br>Max. 1000 znaků na sloupec</p>                   | <p>Pokud je použit tento typ sloupce, prodejci musí uvést hodnotu pro \<KEY>.<br><br>V souboru TSV můžete mít několik sloupců s touto syntaxí.</p>                                                                                                                                                     | Název sloupce může být „brand“ a hodnota buňky ve sloupci může být „green-fairy“. Výsledkem bude filtr „brand:green-fairy“ u produktu. |
| `subClassName`           | <p>Zastaralé.<br>Vyžadováno pro umístění křížového/navazujícího prodeje produktů (cross/upsell)</p> | <p>Text<br>Max. 750 znaků</p>                               | <p>Název podkategorie/kategorie, ve které se příslušný produkt nachází.<br><br>Podkategorie umožňují lepší cílení produktů, např. produkt máslo může cílit na chléb, ale nebude cílit na náplasti.</p>                                                                                                 | Sýry                                                                                                                                   |
| `xSellSubClassName`      | <p>Zastaralé.<br>Vyžadováno pro umístění křížového/navazujícího prodeje produktů (cross/upsell)</p> | <p>Text<br>Max. 750 znaků</p>                               | Názvy podkategorií/kategorií, v rámci kterých může příslušný produkt cílit na produkty.                                                                                                                                                                                                                | Chléb, Pomazánky, Krekry                                                                                                               |
| `price`                  | Volitelné                                                                                           | <p>Číslo<br>Doporučena 2 desetinná místa</p>                | Cena produktu.                                                                                                                                                                                                                                                                                         | 30.00                                                                                                                                  |
| `brand`                  | Povinné                                                                                             | <p>Text<br>Max. 70 znaků</p>                                | Značka produktu.                                                                                                                                                                                                                                                                                       | Tommy Hilfiger                                                                                                                         |
| `type`                   | Povinné                                                                                             | <p>Text<br>Max. 750 znaků</p>                               | Typ produktu.                                                                                                                                                                                                                                                                                          | Oblečení                                                                                                                               |
| `retailer_taxonomy`      | Vyžadováno pro rozšířenou atribuci. Mezi znaky nesmí být `>` mezery                                 | <p>Text<br>Max. 750 znaků</p>                               | Vaše individuální taxonomie produktů prodejce.                                                                                                                                                                                                                                                         | Muži>Pánské oblečení>Svetry                                                                                                            |
| `google_taxonomy`        | Vyžadováno pro rozšířenou atribuci, pokud `retailer_taxonomy` nelze poskytnout                      | <p>Text<br>Max. 750 znaků</p>                               | Standardní taxonomie Google pro daný produkt. Více informací naleznete zde: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                          | Odevy a doplňky > Oblečení > Topy                                                                                                      |
| `global_identifier`      | Povinné                                                                                             | <p>Text<br>Max. 50 znaků</p>                                | Globální identifikátor produktu.                                                                                                                                                                                                                                                                       | 08719108994761                                                                                                                         |
| `global_identifier_type` | Povinné                                                                                             | Text                                                        | Typ globálního identifikátoru.                                                                                                                                                                                                                                                                         | GTIN                                                                                                                                   |
| `custom_payload`         | Není vyžadováno, pokud to není doporučeno.                                                          | Pole bajtů zakódované v Base64                              | Toto pole obsahuje vlastní datové zatížení, které by mělo být předáno do generování reklamy. Pole by mělo obsahovat platný objekt JSON serializovaný do pole bajtů a zakódovaný v Base64. Objekt JSON by měl odpovídat schématu.                                                                       | Viz sekce vlastních datových zatížení.                                                                                                 |
| `hfss`                   | Volitelné                                                                                           | Boolean                                                     | Používá se k označení, zda je produkt HFSS nebo ne. To je dále využíváno v Epsilon Retail Mediauživatelském rozhraní. Podívejte se na naši [Dokumentaci k HFSS](/retail-media-interface/integration/cs/feature-integrations/placement-level-product-type-blocking-hfss-support.md) pro více informací. | true                                                                                                                                   |
| `seller_id`              | Volitelné                                                                                           | <p>Text<br>Max. 50 znaků</p>                                | <p>Unikátní Id prodejce. Vyžadováno pouze při registraci prodejců na tržišti. Pro produkty mimo tržiště lze ponechat prázdné.<br><br>Pro integraci seller\_ids existují další požadavky, podívejte se prosím na <a href="/pages/GdINTwW9yWYQ9HlXJRpi">Marketplace sellerId</a> pro více informací.</p> | aes-de4-ss                                                                                                                             |

Příklad souboru reprezentovaného jako tabulka naleznete níže:

| `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       | Dárkové balení Absinth Green Fairy 500 mL | <https://www.retailer.com/product/1234.jpg> | `20`        | Tento dárkový balíček Absinth Green Fairy se lžičkou je dokonalým dárkem pro každého milovníka absintu nebo koktejlů. Položte kostku cukru na lžičku a přelijte ji absintem, abyste si tento destilát vychutnali autentickým způsobem! | Dárky, Alkoholické, Dárkové balíčky | 500ml         | Česká republika  | Dárky, Alkoholické, Dárkové balíčky | `5.00`  | Green Fairy | Alkohol | Dárky>Alkoholické>Dárkové balíčky | Potraviny, nápoje a tabák>Nápoje>Alkoholické nápoje>Lihoviny a destiláty>Absint | 8594001443079       | 7328s-dmie3-9jdae | Dárková balení | Alkohol           |

{% hint style="info" %}
Soubory TSV nemohou být ve formátu s uvozovkami.
{% endhint %}

## Aktualizace obrázků produktů

Epsilon ukládá URL adresy obrázků do mezipaměti, aby byl zajištěn konzistentní výkon a snížil se počet požadavků na váš obrázkový server. Pokud aktualizujete obrázek bez změny jeho URL adresy, musíte ručně vyvolat obnovení v EpsilonTo provedete takto:

* Odeberte stávající image\_url z produktu.
* Po dokončení aktualizace znovu odešlete stejnou image\_url.

Případně, pokud to váš obrázkový server podporuje, můžete vynutit obnovení připojením dotazovacího řetězce (například verze nebo časového razítka) ke stávající URL adrese. To způsobí, že Epsilon obrázek znovu načte..

{% hint style="info" %}
Obrázky se používají pouze v uživatelském rozhraní

Obrázky produktů se v odpovědích na reklamu neposkytují. Jakékoli aktualizace obrázků ovlivní pouze to, jak se produkt zobrazuje v Epsilon UI během obnovování mezipaměti.
{% endhint %}

## Soubory XML - plánováno k ukončení podpory

{% hint style="danger" %}
️ Nepodporováno pro nové zákazníky

Níže uvedené informace jsou určeny pro stávající zákazníky, kteří stále využívají formát XML. Pro onboarding nového katalogu podporujeme výše zdokumentované formáty TSV a CSV, které poskytují větší flexibilitu souborů a také možnost synchronizovat soubor několikrát denně.
{% endhint %}

Epsilon Retail Media definovala seznam tagů, které se používají k popisu dokumentu XML pro produkty. Nižší tabulka znázorňuje tagy a jejich popisy. Tag 'item' se používá k popisu produktu v dokumentu XML. Všechny ostatní tagy pro ostatní pole musí být zapsány uvnitř tohoto tagu.

| Značky XML               | Povinné/volitelné                                                                                                   | Popis                                                                                                                                                                                                                                                                                                  |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `item`                   | Povinné                                                                                                             | Tato značka slouží k popisu produktu. Všechny ostatní značky XML pro produkt musí být uvnitř této značky. Dokument XML pro produkty musí obsahovat seznam značek item. Toto pole je identické s poli gtin a product\_code při synchronizaci přes API a soubor TSV.                                     |
| `id`                     | Povinné                                                                                                             | Kód pro identifikaci produktu ve vašem systému. Ekvivalent k `product_code` v souborech TSV. Toto pole je identické s poli gtin a item při synchronizaci přes API a soubor XML.                                                                                                                        |
| `title`                  | Povinné                                                                                                             | Název produktu.                                                                                                                                                                                                                                                                                        |
| `image_link`             | <p>Povinné<br>Max. 50 znaků</p>                                                                                     | Hypertextový odkaz na obrázek produktu. Musí se jednat o platnou URL.                                                                                                                                                                                                                                  |
| `brand`                  | <p>Povinné<br>Max. 70 znaků</p>                                                                                     | Značka produktu.                                                                                                                                                                                                                                                                                       |
| `availability`           | <p>Povinné<br>Doporučeno 32bitové celé číslo bez znaménka</p>                                                       | Tato značka slouží k popisu skladové zásoby produktu. Hodnota musí být číslo.                                                                                                                                                                                                                          |
| `description`            | <p>Povinné<br>Max. 5000 znaků</p>                                                                                   | Tato značka slouží k popisu popisu produktu.                                                                                                                                                                                                                                                           |
| `price`                  | <p>Volitelné<br>Doporučena 2 desetinná místa</p>                                                                    | Tato značka slouží k popisu ceny produktu. Pokud je hodnota uvnitř značky uvedena, musí být číslo.                                                                                                                                                                                                     |
| `type`                   | <p>Volitelné<br>Max. 750 znaků</p>                                                                                  | Typ produktu.                                                                                                                                                                                                                                                                                          |
| `retailer_taxonomy`      | <p>Vyžadováno pro rozšířené přisouzení. Vyžadováno také pro integrace kategorií.<br>Max. 750 znaků</p>              | Vaše individuální taxonomie produktu u prodejce, např. Muži>Pánské oblečení>Svetry                                                                                                                                                                                                                     |
| `google_taxonomy`        | <p>Vyžadováno pro rozšířenou atribuci, pokud <code>retailer\_taxonomy</code> nelze poskytnout<br>Max. 750 znaků</p> | Standardní taxonomie Google pro daný produkt. Více informací naleznete zde: <https://www.google.com/basepages/producttype/taxonomy.en-US.txt>                                                                                                                                                          |
| `global_identifier`      | <p>Povinné<br>Max. 50 znaků</p>                                                                                     | Globální identifikátor produktu, např. `08719108994761`                                                                                                                                                                                                                                                |
| `global_identifier_type` | Povinné                                                                                                             | Typ globálního identifikátoru, např. `GTIN`                                                                                                                                                                                                                                                            |
| `custom_payload`         | Není vyžadováno, pokud to není doporučeno.                                                                          | Toto pole obsahuje vlastní datové zatížení, které by mělo být předáno do generování reklamy. Pole by mělo obsahovat platný objekt JSON serializovaný do pole bajtů a zakódovaný v Base64. Objekt JSON by měl odpovídat schématu.                                                                       |
| `hfss`                   | Volitelné                                                                                                           | Používá se k označení, zda je produkt HFSS nebo ne. To je dále využíváno v Epsilon Retail Mediauživatelském rozhraní. Podívejte se na naši [Dokumentaci k HFSS](/retail-media-interface/integration/cs/feature-integrations/placement-level-product-type-blocking-hfss-support.md) pro více informací. |
| `seller_id`              | <p>Volitelné<br>Max. 50 znaků</p>                                                                                   | <p>Unikátní Id prodejce. Vyžadováno pouze při registraci prodejců na tržišti. Pro produkty mimo tržiště lze ponechat prázdné.<br><br>Pro integraci seller\_ids existují další požadavky, podívejte se prosím na <a href="/pages/GdINTwW9yWYQ9HlXJRpi">Marketplace sellerId</a> pro více informací.</p> |

Příklad platného dokumentu XML se značkami je uveden níže:

```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>
```

## Vlastní datové obsahy

### Co jsou vlastní datové obsahy (payloads)?

Vlastní datové obsahy jsou pole, která jsou předávána v nezměněné podobě od načtení katalogu až po zobrazování reklamy. Na toto pole se neaplikují žádné transformace. Na poli však probíhá validace na základě JSON Schema (<https://json-schema.org/>). Specifikace datového obsahu je k dispozici prostřednictvím odkazu níže (notace JSON Schema):

V odpovědi s produktovou reklamou se integrátorovi vrací přesný vlastní datový obsah v poli s názvem `customPayload`. Příklad platného těla zprávy je uveden níže:

```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" %}
Pouze soubor

Vezměte prosím na vědomí, že vlastní těla zpráv jsou podporována pouze při synchronizaci produktů prostřednictvím souboru.
{% endhint %}

### Vlastní těla zpráv při generování reklam

Při vrácení produktových reklam je vlastní tělo zprávy předáváno jako součást vygenerované reklamy. Vrácená těla reklam budou obsahovat dodatečné pole `customPayload` které bude obsahovat objekt JSON odpovídající stejné specifikaci jako informace poskytnuté ve feedu.

Příklad odpovědi může být:

```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" %}
Jelikož vlastní těla zpráv představují dodatečnou zátěž pro naši službu generování reklam, vezměte prosím na vědomí, že integrace vlastních těl zpráv nepodléhají Epsilon Retail Media SLA, pokud není uvedeno jinak.
{% 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/cs/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.
