Archived models

This is for:

Developer System Administrator

When inspecting the Status column of the Models (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console, you may notice that some of your Coveo Machine Learning (Coveo ML) models have the Archived status, or contain a warning message stating that the model will be archived soon.

A Coveo ML model is automatically archived when it hasn’t been queried for at least 10 days. In other words, if a model hasn’t been requested through a Search API call in 10 days the model falls into a state in which it can no longer instantly answer user queries.

Notes

  • The Status column of a given model displays a warning 5 days before being archived. This warning helps you take action before the model is archived.

    warning for archived models as shown in the Coveo Administration Console

  • Archived models count against the number of models granted in your Platform plan.

An archived model no longer affects search results or improves the overall user experience. Therefore, you should consider deleting it so that the models that appear on the Models (platform-ca | platform-eu | platform-au) page are only those used on your production interfaces.

However, if you want to reactivate an archived model, see Reactivate archived models for instructions.

Delete archived models

Note

Models are automatically dissociated from all their associated query pipelines once they’re deleted.

  1. On the Models (platform-ca | platform-eu | platform-au) page, on the row of the archived model, in the Status column, click Delete.

  2. In the panel that appears, click Delete.

Reactivate archived models

You can reactivate an archived models if needed. For an archived model to become active again, the model must be queried at least once.

Notes

  • When an archived model is queried, the model initiates a rebuild if necessary. This is to ensure that the model operates based only on your most recent data. During a rebuild, the model won’t provide any output until the rebuild completes and the model’s status switches from Building to Active.

  • You can’t reactivate a model that’s not supported by your organization license. An unsupported model is never queried and therefore can’t be reactivated once archived. For example, if your existing license no longer grants access to RGA models, an archived RGA model can’t be reactivated. A message appears in a model’s information page when it’s not supported by your current license.

    Model type unsupported by license | Coveo

For a model to be queried

  • The model must be associated with a query pipeline to which a query is routed.

    Note

    For Case Classification (CC) models, which can’t be associated with a query pipeline, models must be associated with a Case Assist configuration and requested by the Customer Service API to be queried.

  • If the archived model association includes a condition, the condition must be met by the query.

    Note

    If you want to reactivate an archived model and another model of the same type is associated with the query pipeline, you may need to re-order the models in the query pipeline’s model association list to make sure that the archived model is queried by the Search API.

    When a query pipeline is associated with more than one model of the same type, only one model of that type is queried (executed) for a given query. Priority is given to the topmost model of that type in the model association list. Once a model is executed, the Search API doesn’t evaluate the other models of that type in the list.

    For example, your query pipeline has the following ART model associations, and you want to reactivate the ART-3 model:

    Execution example of 3 associated ART models in a query pipeline | Coveo

    A goodbye query is routed to the query pipeline:

    1. The Search API evaluates the ART-1 association, but doesn’t execute it because the query doesn’t meet the Query contains hello condition.

    2. The Search API then evaluates the ART-2 association. Because the model association doesn’t contain a condition, the Search API executes the ART-2 model. Since an ART model was already executed for the query, the Search API doesn’t evaluate or execute the ART-3 association despite the query matching the Query contains goodbye condition, and ART-3 remains archived.

    Given the same goodbye query, to reactivate the ART-3 model you must change the order of the model associations so that ART-3 is above ART-2. In this case, the Search API executes the ART-3 model and not the ART-2 model.

    Execution example of 3 reordered associated ART models in a query pipeline | Coveo