Set advanced model configurations using the API

This is for:

Developer System Administrator

The Coveo Machine Learning (Coveo ML) Advanced Model Configurations API lets you set an advanced configurations for a model using configuration files.

To set an advanced configuration using the API

  1. Create or update an advanced configuration file.

  2. Upload the advanced configuration file to the model.

Tip

You can also get a list of advanced configuration files currently used by a model, or delete a configuration file from a model.

Create or update an advanced configuration file

Setting an advanced configuration using the API requires an advanced configuration file.

You can create a new configuration file from scratch, or download an existing file that you previously uploaded to a model to edit its configuration.

  1. If required, to edit an advanced configuration file that’s currently used by a model, first download the file using the Swagger UI as follows:

    1. Access the Advanced Model Configurations section of the Swagger UI that’s associated with your Coveo organization region (US | CA | EU | AU).

    2. Click Authorize and authenticate using your Coveo organization account credentials.

      Note

      The Coveo organization account you use for authentication must have the Machine learning - Models - Edit privilege.

    3. Use the configs/{configurationType} GET operation to download an existing configuration file that you want to edit:

      Use Swagger UI to download a model advanced configuration file | Coveo

      1. Enter the required parameters for the model and configuration type that you want to download.

      2. Once you’ve entered the parameters, click Execute.

      3. Click Download file in the response body to download the file.

  2. Use your preferred text editor to either modify the downloaded advanced configuration file or create a new file from scratch. The configuration file requirements and formatting depends on the configuration type:

  3. Upload the advanced configuration file to the model.

Upload an advanced configuration file

Once you’ve created the configuration file, use the Swagger UI to upload it to a model to apply the advanced configuration to that model.

  1. Access the Advanced Model Configurations section of the Swagger UI that’s associated with your Coveo organization region (US | CA | EU | AU).

  2. Click Authorize and authenticate using your Coveo organization account credentials.

    Note

    The Coveo organization account you use for authentication must have the Machine learning - Models - Edit privilege.

  3. Use the configs/{configurationType} PUT operation to upload a configuration file to the model that you want to configure:

    Use Swagger UI to upload a model advanced configuration file | Coveo

    1. Enter the required parameters for the model to which you want to upload the file, as well as the configuration type.

    2. For configFile, click Choose File to select the configuration file.

    3. Click Execute.

Advanced model configuration API parameters

configurationType (string) - required

Parameter type: query

The type of advanced configuration file. Available values are:

languageCode (string) - optional

Parameter type: query

The language of the configuration file. It must be an ISO 639-1 code, or the string commons.

Important

For a configuration file that uses the commons language value, the queries in that file are automatically added to every other language-specific default queries files in your model. Languages without a default queries file aren’t affected by the commons file.

For example, your model processes queries in English (en), French (fr), and Spanish (es), but your model includes only en and fr default queries configuration files. Uploading a commons file will add its list of queries to the en and fr configuration files, but not to any other language.

modelId (string) - required

Parameter type: path

The unique identifier of the target model (see Review model information).

Example
myOrganization_topclicks_22ec9966_0f8b_4adc_967d_65219552192a

organizationId (string) - required

Parameter type: path

The unique identifier of the target Coveo organization (see Retrieve the organization ID).

Example
myorg6j53h4

configFile (file) - required

Note

This applies only when uploading a model’s advanced configuration file.

Parameter type: formData

The configuration file to be uploaded.

To learn how to set up your configuration file, click the appropriate link: