Manage models

This is for:

Developer System Administrator

Coveo Machine Learning (Coveo ML) models are algorithms which leverage usage analytics data to provide contextually relevant recommendations (see Coveo Machine Learning models).

The Models (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console allows users with the required privileges to manage and review the ML models of a Coveo organization.

Creating a model

Each Coveo ML model type has its own set of prerequisites and a different model creation procedure. Click one of the following links to access the corresponding procedure:

Creating a model with JSON

Click one of the following links to access the corresponding procedure:

Editing a model

Click one of the following links to access the corresponding procedure:

Editing a model with JSON

Click one of the following links to access the corresponding procedure:

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.

When inspecting the Status column, a given model is either in the Active or Inactive state. Additional information can be displayed depending on the model’s current state.

status column

The following table lists the possible model statuses, their definitions, and their status colors as shown in the Administration Console:

Status Definition Status color

Active

The model is active and available.

green

Inactive

The model isn’t available.

grey

Update in queue

Waiting to process a scheduled update or configuration change.

green

Updating

The model is being rebuilt based on a new configuration.

green

Waiting

The model is in the building queue.

blue

Building

The model is currently being processed.

blue

Degraded

The model is active, but has some limitations. Additional information is available in the Error section of a model (see Review model information).

orange

Failed

The model couldn’t be built with the requested configuration. Additional information is available in the Error section of a model (see Review model information).

red

Update failed

The model couldn’t be updated with the requested configuration.

red

Error

An error prevented the model from being built successfully.

grey

Archived

The model was archived because it hasn’t been queried for at least 30 days.
Learn more on archived models.

grey

"Learning Interval" section

In this section, you can modify the following:

  • Frequency: The rate at which the model is retrained.

  • Data period: The usage analytics data time interval on which the model will be based.

The more data the model has access to and learns from, the better the recommendations. As a general guide, a usage analytics dataset of 10,000 queries or more typically allows a Coveo ML model to provide very relevant recommendations. You can look at your Coveo Usage Analytics (Coveo UA) data to evaluate the volume of queries on your search hub, and ensure that your Coveo ML models are configured with a training Data Period that corresponds to at least 10,000 queries. When your search hub serves a very high volume of queries, you can consider reducing the data period so that the model learns only more recent user behavior and be more responsive to trends.

A Coveo ML model is regularly retrained on a more recent Coveo UA dataset, to ensure that recent user behavior is learned and that the model freshness maintained.

Set the Coveo ML model training Frequency based on the Data Period value. Less frequent for a larger Data Period and more frequent for a smaller Data Period as recommended in the following table.

Data Period

Frequency

Daily

Weekly

Monthly

1 month

check

check

3 months (Recommended)

check

6 months

check
Note

If you’re testing the model in a sandbox environment in which very little analytics data is available to train the model, you can activate the Test configuration mode advanced option to ensure the model provides recommendations.

"Learn From" section

The Learn From section allows you to refine the data that the model uses to make its recommendations. By narrowing down the set of data that a model uses, you can better customize relevancy for specific user groups and use cases. You can apply filters on all events, or on every event that belongs to a specific category (i.e., search, click, view, or custom events).

Examples

  • You want your QS model to return queries that pertain to a specific user group, so you add a data filter to ensure that only a specific set of analytics are used by the model for training purposes.

  • Your Community search and Agent search have very specific vocabulary. You don’t want them to influence one another in the ART model learning process, so you add a filter on the Origin 1 (Page/Hub) dimension.

To add an event filter:

  1. (When creating a model only) Click Add-Filter.

  2. In the Select a dimension dropdown menu, select the dimension on which you want to base the learning of the model.

  3. In the Select an operator dropdown menu, select the appropriate operator.

  4. In the Select value(s) dropdown menu, add, type, or select the appropriate value.

  5. Click Add filter.

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