Image to item mapping data entities
This article provides guidance on how to configure image to item mapping data entities in the Intelligent Recommendations data contract.
Data entities review
A data entity is a set of one or more data text files, each having a list of columns (also called attributes) and rows containing the actual data values.
Intelligent Recommendations defines logical groups of data entities, each with its own purpose.
Note
Data entities are optional, unless explicitly stated otherwise, which means that their data can be empty or missing.
For the full list of data entities, see data entities.
Introduction to image to item mapping data entities
To return recommendations results that are based on the visual similarities of multiple item images, you can provide images that contain multiple items (and item variants). You can use the image ID to get recommendations based on the items that appear in that image.
Images that contain only a single item (or item variant) should be added to the ItemAndVariantImages data entity.
The following data entities are part of the image to item mapping data entities:
For the full list of data entities, see data entities.
Images inventory
Data entity name: Reco_ImagesInventory
Description: Inventory of all images.
Attributes:
| Name | Data type | Mandatory | Default value | Invalid value behavior | Comments |
|---|---|---|---|---|---|
| ImageId | String(16) | Yes | Drop entry | See Required data entities per recommendations scenario for image ID, which are the same requirements as for an item ID. | |
| ImageFullUrl | String(2048) | No | Drop entry | Must be an absolute URL. The URL should be properly encoded (using percent-encoding). Length is limited to 2,048 characters. | |
| ImageType | String | No | Composite | Drop entry | Supports only Composite. |
Guidelines:
- At this time, only composite images are supported for this data entity.
Sample data:
Headers appear for convenience only and shouldn't be part of the actual data.
| ImageId | ImageFullUrl | ImageType |
|---|---|---|
| Image1 | https://my.server.com/image/image1.png |
|
| Image2 | Composite |
Image to item mappings
Data entity name: Reco_ImageToItemMappings
Description: Mapping between an image and its associated items.
Attributes:
| Name | Data type | Mandatory | Default value | Invalid value behavior | Comments |
|---|---|---|---|---|---|
| ImageId | String(16) | Yes | Drop entry | See Required data entities per recommendations scenario for image ID, which are the same requirements as for an item ID. | |
| ItemId | String(16) | Yes | Drop entry | See Required data entities per recommendations scenario for an item ID | |
| ItemVariantId | String(16) | No | Drop entry | See Required data entities per recommendations scenario for an item variant ID |
Guidelines:
- Items should only be mapped to images that also appear in the images inventory data entity.
Sample data:
Headers appear for convenience only and shouldn't be part of the actual data.
| ImageId | ItemId | ItemVariantId |
|---|---|---|
| Image1 | Item1 | |
| Image2 | Item3 | Item3Var1 |
For the full list of data entities, see data entities.
See also
Data contract overview
Data entities mapping table
Catalog data entities
Interactions data entities
Reco configuration data entities
External lists data entities
Opted-out users data entities
Recommendations enrichment data entities
Intelligent Recommendations API
Quick start guide: Set up and run Intelligent Recommendations with sample data