Definition
Use the AI Assistant type to show products that are relevant to the conversation happening on site between a shopper and an AI. Make an ad request for each predicted keyword sent by the LLM.Parameters
event-type
Value: aiAssistant
Description: Indicates to the Delivery API that this is an AI Assistant event.
Required: Yes
page-id
Description: An identifier that tells Criteo which placements to return for the ad request. Placements are instantiated by your Technical Account Manager depending on your desired ad configuration. Below are the standard page-ids for this page type:
- In Americas: Typically follows the structure
[event-type]_API_[environment], e.g.,aiAssistant_API_desktop,aiAssistant_API_iOS - In EMEA: Typically follows the structure
[event-type]Api[environment], e.g.,aiAssistantApiMobile,aiAssistantApiAndroid
keywords
Description: The search query predicted by the LLM. Should be URL encoded.
Examples:
black%20laptopsblack-laptops
page-uid
Description: This value is returned within the response of the initial call made on page load. By storing this value and including it in subsequent aiAssistant event calls, Criteo is able to link the events to the initial ad request.
Example: 545d9a70-f096-4568-b4b9-8f2f32a452d4
Required: Recommended. If not used, might inflate page views.
item
Description: The list of SKUs that are organically shown on the page in the grid or list. Must match the parameter id in the feed (See details here). Multiple items should be separated by a pipe | or %7C (URL encoded). Used for reporting and for organic deduplication, if enabled.
Examples:
123|456|789123%7C456%7C789
parent-item
Description: Only use this if parent SKUs are being passed. Must match the parameter item_group_id in the feed (See details here). Multiple parent items should be separated by a pipe | or %7C (URL encoded). For SKUs that do not have parent SKUs, NULL should be sent instead. Used for reporting and for organic deduplication, if enabled.
Examples:
12345P|NULL|456789P12345P%7CNULL%7C456789P
list-size
Description: The total number of organic items on the page. Preferably, it should match the number of item IDs sent in the item parameter.
Required: Recommended
page-number
Description: Represents the page number for either paginated results or scroll fold if products are loaded dynamically. This parameter can be used for result deduplication, by limiting the number of products shown on each page. Please note that a valid page-number starts at 1 and not 0.
Example: 3
Required: Recommended
filters
Description: Corresponds to the filters applied by the shopper on the results. See the filter section for details on how to use this parameter.
Examples:
(price,le,100)(color,eq,blue)
Sample Calls
The header values in the sample calls are illustrative. Make sure to replace them with the appropriate values for your implementation.
AI Assistant Page Example
AMER
EMEA
cURL