Manage models

This is for:

In this article

Creating a model
Editing a model
Reference
Required privileges

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 members 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:

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.

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

Status	Definition	Status icon
Active	The model is active and available.
Build in progress	The model is currently 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).
Limited	Build issues exist that may affect model performance. Click See more details for additional information (see Review model information).
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.
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).
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.

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

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