--- title: Manage Intent-Aware Product Ranking (IAPR) models slug: na4f0419 canonical_url: https://docs.coveo.com/en/na4f0419/ collection: coveo-for-commerce source_format: adoc --- # Manage Intent-Aware Product Ranking (IAPR) models [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) [Intent-Aware Product Ranking (IAPR)](https://docs.coveo.com/en/m61h0552/) [models](https://docs.coveo.com/en/1012/) rank products on search result pages based on a customer's shopping intent. To take advantage of Coveo ML [Intent-Aware Product Ranking](https://docs.coveo.com/en/m61h0552/), members with the required privileges must first create their models. ## Prerequisites To be able to create an IAPR model, make sure you: * Have product data indexed in a [Catalog source](https://docs.coveo.com/en/n8of0593/). * Have configured a [catalog entity](https://docs.coveo.com/en/3139/). * Ensure that the [search interface](https://docs.coveo.com/en/2741/) where you want to integrate the model is configured to log [commerce events](https://docs.coveo.com/en/3188/). More specifically, you must minimally log [click](https://docs.coveo.com/en/o1n92447/) and [product view](https://docs.coveo.com/en/o1n93101/) events. Note that if your Coveo for Commerce implementation targets the Search API, you must also [log search events](https://docs.coveo.com/en/o1n91392/). * Make sure tracked events send a [tracking ID](https://docs.coveo.com/en/o8rb0139/) value. This is done when [initializing the Relay library](https://docs.coveo.com/en/o1n90002/). IAPR models are based on usage analytics data, so if no data is available, there will be no suggestions. If you recently started collecting usage analytics data, suggestions will improve as more data becomes available each time the [model](https://docs.coveo.com/en/1012/) is [retrained](https://docs.coveo.com/en/1727#training-and-retraining). ## Create an IAPR model . On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/), click **Add model**, and then click the **Intent-Aware Product Ranking** card. . Click **Next**. > **Note** > > If your Coveo organization doesn't meet the [minimum requirements for IAPR](https://docs.coveo.com/en/na4f0419#prerequisites), a **Requirements** page appears that shows the missing requirements. > You must resolve all missing requirements before creating an IAPR model. > For example, if a Coveo organization contains a catalog entity but doesn't track events, the **Requirements** page shows: > > ![IAPR missing requirements](:https://docs.coveo.com/en/assets/images/leverage-machine-learning/pqs-iapr-missing-req.png) . Under **Catalog**, select the [catalog entity](https://docs.coveo.com/en/3143/) that makes available the products that the IAPR model must rank. The Intent-Aware Product Ranking [model](https://docs.coveo.com/en/1012/) relies on the [product vector](https://docs.coveo.com/en/nbla0256/) space embedded within the [catalog entity](https://docs.coveo.com/en/3143/) selected at this step. Since [models](https://docs.coveo.com/en/1012/) associated with the same catalog entity share the same product vector space, Coveo recommends having only one Intent-Aware Product Ranking model per catalog entity. This means that you should avoid creating additional Intent-Aware Product Ranking models for catalog entities already associated with an existing model. Contact your Coveo Customer Success Manager (CSM) if you have any additional requirements. . Under **Tracking IDs**, select the [tracking ID](https://docs.coveo.com/en/o8rb0139/) that corresponds to the catalog entity chosen in the previous step. Catalog entities and tracking IDs have a one-to-one relationship, which you can view on the [**Storefront associations**](https://platform.cloud.coveo.com/admin/#/orgid/commerce/storefront/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/commerce/storefront/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/commerce/storefront/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/commerce/storefront/)) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/). **Example** To use the IAPR model on your `Sports` website, select the tracking ID that's used in the usage analytics events that originate from the `Sports` website. This tracking ID must also be mapped to the catalog entity that you selected in the previous step through a storefront association. . Click **Next**. . In the **Name your model** input, enter a meaningful display name for the model. . (Optional) Use the **Project** selector to associate your model with one or more [projects](https://docs.coveo.com/en/n7ef0517/). . Click **Start building**. > **Note** > > On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page, under the **Status** column, in the model row, the value is most probably **Inactive**. > > The model value will change to **Active** when the model creation is complete (typically within 30 minutes, depending on the amount of usage analytics data to process). > The model can only return recommendations when its status is **Active**. > > For more information on Coveo ML model statuses, see the [**Status** column reference](#status-column). . [Associate the model with a pipeline](https://docs.coveo.com/en/na4f0342/) to use the [model](https://docs.coveo.com/en/1012/) in a [search interface](https://docs.coveo.com/en/2741/). > **Important** > > Make sure to follow the [model association leading practices](https://docs.coveo.com/en/na4f0342#leading-practices) before associating your model with your production query pipeline. ## Manage an IAPR model You can [edit](#edit-an-iapr-model), [delete](#delete-an-iapr-model), or [review information](#review-model-information) for your [model](https://docs.coveo.com/en/1012/). ### Edit an IAPR model . On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page, click the model you want to edit, and then click **Edit** in the Action bar. . On the subpage that opens, select the **Configuration** tab. . Under **Name**, you can optionally edit the model's display name. . (Optional) Use the **Project** selector to associate your model with one or more [projects](https://docs.coveo.com/en/n7ef0517/). . Under **Tracking IDs**, you can change the [tracking ID](https://docs.coveo.com/en/n8tg0567/) that you want to use to train the model, but this must still correspond to the catalog entity chosen when configuring the model. A catalog entity and a tracking ID have a one-to-one relationship, which you can view on the [**Storefront associations**](https://platform.cloud.coveo.com/admin/#/orgid/commerce/storefront/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/commerce/storefront/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/commerce/storefront/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/commerce/storefront/)) page of the [Coveo Administration Console](https://docs.coveo.com/en/183/). **Example** To use the IAPR model on your `Sports` website, select the tracking ID that's used in the usage analytics events that originate from the `Sports` website. This tracking ID must also be mapped to the catalog entity that you selected when configuring the model. . Click **Save**. > **Note** > > Some configuration changes initiate an automatic model rebuild when you save the model. > The [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page shows your model's current **Status**. > Model settings take effect only when its status is **Active**. > > For more information on Coveo ML model statuses, see the [**Status** column reference](#status-column). . [Associate the model with a pipeline](https://docs.coveo.com/en/na4f0342/) to use the [model](https://docs.coveo.com/en/1012/) in a [search interface](https://docs.coveo.com/en/2741/). > **Important** > > Make sure to follow the [model association leading practices](https://docs.coveo.com/en/na4f0342#leading-practices) before associating your model with your production query pipeline. ### Delete an IAPR model > **Note** > > If the model is associated with a query pipeline, make sure to dissociate the model from the query pipeline after deleting it. . On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page, click the ML model that you want to delete, and then click **More** > **Delete** in the Action bar. . In the panel that appears, click **Delete**. ### Review model information On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page, click the desired model, and then click **View** in the Action bar. For more information, see [Reviewing model information](https://docs.coveo.com/en/1894/). ## "Status" column On the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page of the [Administration Console](https://docs.coveo.com/en/183/), the **Status** column indicates the current state of your Coveo ML models. The following table lists the possible model statuses and their definitions: [%header,cols="1,6,^.^1"] |=== .^|Status .^|Definition |Status icon |Active |The model is active and available. a|![Active](leverage-machine-learning/model-active.png) |Build in progress |The model is currently building. a|![Building](leverage-machine-learning/model-build.png) |Inactive |The model isn't ready to be queried, such as when a model was recently created or the organization is offline. Click **See more details** for additional information (see [Review model information](https://docs.coveo.com/en/1894/)). a|![Inactive](leverage-machine-learning/model-limited.png) |Limited |Build issues exist that may affect model performance. Click **See more details** for additional information (see [Review model information](https://docs.coveo.com/en/1894/)). a|![Limited](leverage-machine-learning/model-limited.png) |Soon to be archived |The model will soon be archived because it hasn't been queried for an extended period of time. Click **Delete** to remove the model. [Learn more about archived models](https://docs.coveo.com/en/mb3e0324/). a|![Archive pending](leverage-machine-learning/model-limited.png) |Error |An error prevented the model from being built successfully. If it's a temporary system error, check back soon. Otherwise, click **See more details** for additional information (see [Review model information](https://docs.coveo.com/en/1894/)). a|![Error](leverage-machine-learning/model-error.png) |Archived |The model was archived because it hasn't been queried for an extended period of time. Click **Delete** to remove the model. [Learn more about archived models](https://docs.coveo.com/en/mb3e0324/). a|![Archived](leverage-machine-learning/model-archived.png) |=== ## Required privileges By default, members with the [required privileges](https://docs.coveo.com/en/1832#required-privileges) can view and edit elements of the [**Models**](https://platform.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) ([platform-ca](https://platform-ca.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-eu](https://platform-eu.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/) | [platform-au](https://platform-au.cloud.coveo.com/admin/#/orgid/ai-and-ml/models/)) page. The following table indicates the privileges required to use elements of the **Models** page and associated panels (see [Manage privileges](https://docs.coveo.com/en/3151/) and [Privilege reference](https://docs.coveo.com/en/1707/)). [cols="3",options="header"] |=== |Action |Service - Domain |Required access level |View models |Machine Learning - Models Organization - Organization Search - Query pipelines |View .2+|Edit models |Organization - Organization Search - Query pipelines |View |Machine Learning - Models |Edit |=== ## What's next? [Associate an IAPR model with a query pipeline](https://docs.coveo.com/en/na4f0342/).