Manage model associations with query pipelines

This is for:

Developer System Administrator

When a Coveo Machine Learning (Coveo ML) model has been created, it must be associated with a query pipeline to be effective in a search interface.

organization members with the required privileges can access the Machine Learning tab of a query pipeline configuration page to manage Coveo ML model associations for that query pipeline.

Leading practices

Test the model efficiency

Once you’ve created a Coveo ML model, the leading practice is to test the model performance by doing an A/B test.

This allows you to test the model on a chosen proportion of the traffic passing through a given query pipeline. You can then assess the impact of the model by comparing the query pipeline search performance metrics with and without the model.

Once satisfied with the model efficiency, you can stop the A/B test to make the model effective for all the traffic passing through the query pipeline.

Note

You can also use the Model Testing (platform-ca | platform-eu | platform-au) feature of the Coveo Administration Console to compare two ART or QS models together, or to test the results a pipeline-model combination would provide if associated together.

Validate that the model is effective

To validate that your Coveo ML models work as expected, you can inspect your models.

Plan the usage of custom contexts

While Coveo ML models can perform well without custom context information, using custom contexts can take Coveo ML relevance one step further.

You can define custom contexts and then pass appropriate ones along with usage analytics events and queries to allow Coveo ML to take them into account.

Notes

  • Custom context support is limited under the new Event Protocol.

  • If you’re just getting started with Coveo ML, you can skip this step to take advantage of Coveo ML model types more quickly and easily, and consider using custom contexts in a second phase.

Associate a model with a query pipeline

The process of associating a Coveo ML model with a query pipeline differs depending on which Coveo ML model type you want to associate. Click one of the following model links to access the corresponding procedure:

Associate a model with a pipeline using JSON

Advanced users may want to associate a Coveo ML model with a pipeline using JSON. Click one of the following model links to access the corresponding procedure:

Dissociate a model

In the Machine Learning tab of the desired query pipeline, click the model that you want to dissociate from this pipeline, and then click Dissociate in the Action bar.

Reorder model associations

The Coveo ML models of a given type are executed in the order in which they appear on the page until a condition is satisfied.

Important

The first model on the list will be used if no conditions are met.

To reorder model associations in a query pipeline:

In the Machine Learning tab of the desired query pipeline, click the model whose position you want to change, and then use the Move up or Move down arrows in the Action bar to change the position of the model.

Reference

"Advanced Configuration" section

When association ART, DNE, and PR models with a query pipeline, the Administration Console lets you configure settings in the Advanced Configuration section. Click one of the following model links to access the corresponding procedure:

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 model associations

Machine Learning - Models
Organization - Organization
Search - Query pipelines

View

Edit model associations

Organization - Organization
Machine Learning - Models

View

Search - Query pipelines

Edit