Associate a Dynamic Navigation Experience (DNE) Model With a Query Pipeline

When a Coveo Machine Learning (Coveo ML) Dynamic Navigation Experience (DNE) 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

Duplicate the Production Query Pipeline

Once you have created a Coveo ML DNE model, the leading practice is to duplicate the query pipeline with which you plan to associate the model, and then associate the model with the pipeline copy.

Once satisfied with the model efficiency on the pipeline copy, dissociate the model from the test pipeline and associate it with the production pipeline. You can test your Coveo ML model’s efficiency by performing A/B tests or model testings.

Once you’re done testing the model in the test pipeline, you can Delete the test pipeline.

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 the various Coveo ML features 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.

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

Associate a DNE Model

Follow the model association leading practices when associating your model with your query pipeline.

  1. On the Query Pipelines page, click the query pipeline for which you want to associate a DNE model, and then in the Action bar, click Edit Components.

  2. On the subpage that opens, select the Machine Learning tab, and then in the upper-right corner, click Associate Model.

  3. In the Model drop-down menu, select the desired model.

  4. On the right side, under Condition, you can optionally select a query pipeline condition in the drop-down menu or create a new one.

  5. In the Advanced Configuration section, you can optionally tune the following parameters:

  6. Click Associate Model.

When the DNE model has been associated with a query pipeline, make sure that the search interfaces in which you want to deploy the model use dynamic facets.

Edit a DNE Model Association

Follow the model association leading practices when associating your model with your query pipeline.

  1. On the Query Pipelines page, click the query pipeline for which you want to edit a model association, and then in the Action bar, click Edit Components.

  2. On the subpage that opens, click the desired model, and then in the Action Bar, click Edit.

  3. On the right side, under Condition, you can optionally select a query pipeline condition in the drop-down menu or create a new one.

  4. In the Advanced Configuration section, you can optionally tune the following parameters:

  5. Click Save.

When the DNE model has been associated with a query pipeline, make sure that the search interfaces in which you want to deploy the model use dynamic facets.

Associate a DNE Model via a JSON Configuration

Advanced users may want to manage a model association via a JSON configuration to specify association parameters that don’t fit with the parameters available in the Administration Console.

  1. On the Query Pipelines page, click the query pipeline for which you want to associate a model, and then in the Action bar, click Edit Components.

  2. On the subpage that opens, select the Machine Learning tab, and then in the upper-right corner, click menu-button, and select Associate a model in JSON view.

  3. On the Associate a Model subpage, in JSON view, replace the <Model_ID> placeholder with the actual ID of the model you want to associate with the pipeline (see Review Coveo Machine Learning Information).

    Once you accessed the Associate a Model subpage, in JSON view:

    • You can always go back to the Associate a Model subpage in the UI view and use the available options. However, all unsaved changes made in the Associate a Model subpage, in JSON view, are lost.

    • The Associate a Model subpage in JSON view becomes the default model association view for that model. In other words, the Associate a Model subpage in JSON view is now automatically displayed when you access this model association.

  4. Click Associate Model.

When the DNE model has been associated with a query pipeline, make sure that the search interfaces in which you want to deploy the model use dynamic facets.

Edit a DNE Model Association via a JSON Configuration

Advanced users may want to manage a model association via a JSON configuration to specify association parameters that don’t fit with the parameters available in the Administration Console.

  1. On the Query Pipelines page, click the query pipeline for which you want to edit a model association, and then in the Action bar, click Edit Components.

  2. In the Machine Learning tab, click the desired model, and then in the Action bar, click Edit.

  3. On the Edit a Model Association subpage, click menu-button, and then select Switch to JSON view.

  4. On the Switch to JSON view? panel that appears, click Switch to JSON view.

    Switching to the JSON view of the Edit a Model Association subpage cancels unsaved configuration changes made on the Model Association page.

  5. On the Edit a Model Association subpage, in JSON view, tune the JSON model association configuration as needed (see Model Association Parameters).

    Once you accessed the Edit a Model Association subpage, in JSON view:

    • You can always go back to the Edit a Model Association subpage in the UI view and use the available options. However, all unsaved changes made in the Edit a Model Association subpage, in JSON view are lost.

    • If you specified non-default parameters in JSON view of the Edit a Model Association subpage, the complete configuration will be reset to the default one when switching back to the UI view of the Edit a Model Association subpage.

    • The Edit a Model Association subpage in JSON view becomes the default model association view for that model. In other words, the Edit a Model Association subpage in JSON view is now automatically displayed when you access this model association.

  6. Click Save.

When the DNE model has been associated with a query pipeline, make sure that the search interfaces in which you want to deploy the model use dynamic facets.

Dissociate a Model

  1. On the Query Pipelines page, click the query pipeline from which you want to dissociate a model, and then in the Action bar, click Edit Components.

  2. On the subpage that opens, select the Machine Learning tab.

  3. In the Machine Learning tab, click the model you want to dissociate from the pipeline, and then in the Action Bar, click Dissociate.

The model is now dissociated from the pipeline.

Reorder Model Associations

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

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

  1. On the Query Pipelines page, click the query pipeline in which you want to reorder model associations, and then in the Action bar, click Edit Components.

  2. On the subpage that opens, select the Machine Learning tab.

  3. In the Machine Learning tab of the desired query pipeline, click the model whose position you want to change.

  4. In the Action bar, use the Move up or Move down arrows to change the position of the model.

Reference

DNE Advanced Configuration Options

Facet Ordering

Specifies whether to enable facet ordering for this model association.

This check box is selected by default because it’s typically desirable for DNE models to display the most relevant facets first.

You can however deselect this check box if you want to take advantage of the other DNE model options, without having your facets automatically ranked.

Facet Value Ordering

Specifies whether to enable facet value ordering for this model association.

This check box is selected by default because it’s typically desirable for DNE models to display the most relevant facet values within a given facet first.

You can however deselect this check box if you want to take advantage of the other DNE model options, without having your facet values automatically ranked.

Facet Value Selection

Specifies whether to enable automatic selection of facet values for this model association.

This check box is selected by default for models with the automatic selection of facet values enabled.[1]

When this option is selected, the fields to which the automatic selection of facet values is applied are displayed underneath.

You can however deselect this check box if you don’t want the automatic selection of facet values to apply for this model association.

Ranking Boost

Specifies whether to enable ranking boost for items that match facet values determined as relevant by the model.

This check box is selected by default because it’s typically desirable for DNE models to boost items that match facet values determined as relevant by the model. You can however:

  • Deselect this check box if you want to take advantage of the other DNE model options, without having search results that correspond to relevant facets boosted.

  • Adjust the default boosting value applied to items matching relevant facet values.

Increasing the ranking modifier above the recommended value can considerably alter your search results.

Model Association Parameters

You can use the following parameters when creating or editing a Coveo ML DNE model association.

id (string)

The unique identifier of the model association (automatically generated by the Coveo Search API).

Example: 62579f33-a505-4d07-b77d-545aefb2eea1

position (integer [int32])

The position of the model in the order of execution (see Reorder Model Associations).

Example: 8

modelId (string)

The unique identifier of the model (see Reviewing Coveo Machine Learning Model Information).

Example: c7ab60e2-e6b8-41e8-be6a-ad5c8edc662e

modelDisplayName (string)

The name of the model as selected when creating the model. This field is automatically filled with the name of the Coveo ML model.

Example: MyModelName

modelEngine (string)

The ID of the Coveo ML model (see Creating a Model With JSON). This field is automatically filled with the ID of the Coveo ML model.

Example: facetsense

modelStatus (string)

The status of the model. This field is automatically generated according to the current ML model status.

Example: ONLINE

condition (string)

The unique identifier of the condition that must be satisfied for a request to be processed by the ML model.

Example: c7ab60e2-e6b8-41e8-be6a-ad5c8edc662e

conditionDefinition (string)

The QPL expression that indicates the condition defined for the model association (see Query Pipeline Language (QPL)). This field is automatically filled when a condition is specified.

Example: when $searchHub is \"internalSearch\"

cacheMaximumAge (string)

The maximum age of cached query results the ML model should accept, in the ISO-8601 format only including the seconds and milliseconds part.

For each incoming query to be processed by the ML model, if a result set for an identical previously made query is available in the cache and this result set isn’t older than the specified value, the ML model makes recommendations based on that cached query result set. Otherwise, the query is executed against the index.

Default: PT105

useAdvancedConfiguration (boolean)

Whether the model association specifies an advanced configuration.

Default: false

rankingModifier (integer [int32])

The ranking score modifier the ML model should apply to each search result that matches relevant facet values (see Ranking Boost).

The rankingModifier value must be a number between 5 and 100 (e.g., 75).

Default: 50

customQueryParameters (JValue (object))

A JSON object representing the additional parameters to send to Coveo ML on all queries.

This object allows you to specify the facetAutoSelect, facetOrdering, facetValueOrdering, and rankingBoost DNE model association parameters.

facetAutoSelect (boolean)

Whether to enable automatic selection of facet values for this model association.

Default:

facetOrdering (boolean)

Whether the model influences facet ordering according to the user query (see Facet Ordering).

Default: true

maxRecommendations (integer [int32])

The maximum number of facets that the model can expand and order when the facetOrdering parameter is set to true.

Default: 4

facetValueOrdering (boolean)

Whether the model influences facet values ordering according to the user query (see Facet Value Ordering).

Default: true

maxRecommendations (integer [int32])

The maximum number of facet values that the model can expand and order within a facet when the facetValueOrdering parameter is set to true.

Default: 8

rankingBoost (boolean)

Whether the search results matching relevant facet values are boosted (see Ranking Boost).

If set to false, the boost specified in the rankingModifier parameter isn’t applied.

Default: true

Code Sample

The following code sample shows a DNE model association configuration in JSON:

{
  "position": 1,
  "modelId": "XXXXXX_facetsense_XXXXXXXX_XXXX_XXXX_XXXX_XXXXXXXXXXXX",
  "condition": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "rankingModifier": 75,
  "customQueryParameters": {
    "facetOrdering": {
      "isEnabled": true
    },
    "facetValueOrdering": {
      "isEnabled": true
    },
    "rankingBoost": {
      "isEnabled": true
    }
  },
  "useAdvancedConfiguration": true
}

For complete information on DNE model available association parameters, see DNE Model Association Parameters Reference.

Required Privileges

By default, members of the Administrators and Relevance Managers built-in groups can view and edit elements of the Models 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

Search - Query pipelines

View

Edit model associations

Machine Learning - Models

Search - Query pipelines

Edit


1. This check box is grayed and irresponsive for DNE models that don’t have the facet autoselect option configured.
Recommended Articles