Manage Intent-Aware Product Ranking (IAPR) models

This is for:

System Administrator

Coveo Machine Learning (Coveo ML) Intent-Aware Product Ranking (IAPR) models rank products on search result pages based on a customer’s shopping intent.

To take advantage of Coveo ML IAPR, members with the required privileges must first create their models.

Prerequisites

To be able to create an IAPR model, make sure you:

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 is retrained.

Create an IAPR model

  1. Depending on whether models have already been created in your Coveo organization:

  2. Click Next.

    Note

    If your Coveo organization doesn’t meet the minimum requirements for IAPR, 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:

    PQS missing requirements

  3. Under Catalog, select the catalog entity that makes available the products that the IAPR model must rank.

    The IAPR model relies on the product vector space embedded within the catalog entity selected at this step. Since models associated with the same catalog entity share the same product vector space, Coveo recommends having only one instance of a IAPR model per catalog entity. This means that you should avoid creating additional IAPR models for catalog entities already associated with an existing model. Contact your Coveo Customer Success Manager (CSM) if you have any additional requirements.

  4. Under Tracking IDs, select the tracking IDs used in the usage analytics events that you want to use to train the model.

    Example

    If you want to use the IAPR model on your Sports website, select the tracking ID value used in the usage analytics events that originate from the Sports website.

  5. Click Next.

  6. In the Name your model input, enter a meaningful display name for the model, and then click Start building.

    Note

    On the Models (platform-ca | platform-eu | platform-au) 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.

  7. You can then associate the model with a pipeline to take advantage of the model in a search interface.

    Important

    Make sure to follow the model association leading practices before associating your model with your production query pipeline.

Edit an IAPR model

  1. On the Models (platform-ca | platform-eu | platform-au) page, click the model you want to edit, and then click Edit in the Action bar.

  2. On the subpage that opens, select the Configuration tab.

  3. Under Name, you can optionally edit the model’s display name.

  4. Under Tracking IDs, you can change the tracking IDs identifying the usage analytics events that you want to use to train the model.

    Example

    If you want to use the IAPR model on your Sports website, select the tracking ID value used in the usage analytics events that originate from the Sports website.

  5. Click Save.

  6. On the Models (platform-ca | platform-eu | platform-au) page, under the Status column, in the model row, the value is most probably Updating.

    Note

    The model value will change to Active when the model edition 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.

  7. You can then associate the model with a pipeline to take advantage of the model in a search interface.

    Important

    Make sure to follow the model association leading practices before associating your model with your production query pipeline.

Delete an IAPR model

Important

You must dissociate a model from all its associated query pipelines before deleting it. Models aren’t automatically dissociated from pipelines when they’re deleted.

  1. On the Models (platform-ca | platform-eu | platform-au) page, click the ML model that you want to delete, and then click More > Delete in the Action bar.

  2. In the Delete a Model panel that appears, click Delete model.

Review active model information

On the Models (platform-ca | platform-eu | platform-au) page, click the desired model (must be Active), and then click Open in the Action bar (see Reviewing model information).

Reference

"Status" column

On the Models (platform-ca | platform-eu | platform-au) page of the Administration Console, the Status column indicates the current state of your Coveo ML models.

The following table lists the possible model statuses and their definitions:

Status Definition Status icon

Active

The model is active and available.

Active

Build in progress

The model is currently building.

Building

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).

Inactive

Limited

Build issues exist that may affect model performance.
Click See more details for additional information (see Review model information).

Limited

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.

Archive pending

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).

Error

Archived

The model was archived because it hasn’t been queried for at least 30 days.
Click Delete to remove the model.
Learn more about archived models.

Archived

Required privileges

By default, members with the required privileges can view and edit elements of the Models (platform-ca | platform-eu | platform-au) page.

The following table indicates the privileges required to use elements of the Models page and associated panels (see Manage privileges and Privilege reference).

Action Service - Domain Required access level

View models

Machine Learning - Models
Organization - Organization
Search - Query pipelines

View

Edit models

Organization - Organization
Search - Query pipelines

View

Machine Learning - Models

Edit

What’s next?

Associate an IAPR model with a query pipeline.