Metric Collections

Update Collection

Updates a metric collection’s name and metricSettings.

Path parameters

idstringRequired
The id of the metric collection you want to update.

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request

namestringOptional
The name of the metric collection, which must be unique within your project.
multiTurnbooleanOptional

This is true if your metric collection is multi-turn, which contains only multi-turn metrics. Defaulted to false.

metricSettingslist of objectsOptional
This is the list of metric settings for the collection.

Response

successboolean
This is true if the metric collection was updated successfully.
dataobject
This maps to the id of the metric collection.
deprecatedboolean
This is true if this metric collection endpoint is deprecated.