Delete an advanced configuration file from a model
Delete an advanced configuration file from a model
The Coveo Machine Learning API configs/{configurationType}
endpoint allows you to delete an advanced configuration file attached to a Coveo Machine Learning (Coveo ML) model.
Ensure that you’re using an access token with Machine learning - Models - Edit privilege in the target organization (see Add an API key).
Making a request
The following request deletes the desired advanced configuration file from a model:
DELETE https://platform.cloud.coveo.com/rest/organizations/<ORGANIZATION-ID>/machinelearning/models/<MODEL-ID>/configs/<CONFIGURATION-TYPE> HTTP/1.1
Authorization: Bearer **********-****-****-****-************
Reference
Authenticating
The Advanced Model Configurations API relies on the bearer HTTP authentication scheme. All HTTP requests made to the Coveo Machine Learning service must include an Authorization
header with a valid access token (that is, an API key or OAuth2 token):
Authorization: Bearer <token>
To delete a model’s advanced configuration file, the <token>
must grant the Machine learning - Models - Edit privilege in the target organization.
Parameters
When making a DELETE
request to https://platform.cloud.coveo.com/rest/organizations/{organizationId}/machinelearning/models/{modelId}/configs/{configurationType}
to delete a model’s advanced configuration file, the following parameters apply (see /configs/{configurationType}
).
configurationType
(string) - required
Parameter type: query
The type of advanced configuration file. Available values are:
-
ADVANCED_CONFIGURATION
- deprecated. No longer available.
languageCode
(string) - optional
Parameter type: query
The language of the configuration file to retrieve. It must be an ISO 639-1 code, or the string commons
.
modelId
(string) - required
Parameter type: path
The unique identifier of the target model (see Review model information).
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).
myorg6j53h4