Add Collection | Confident AI Docs

Creates a metric collection with the name and the metricSettings you specified.

namestringRequired

This is the unique name of the metric collection you wish to create.

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.

successboolean

This is true if the metric collection was created successfully.

dataobject

This maps to the id of the metric collection.

deprecatedboolean

This is true if this metric collection endpoint is deprecated.

1	import requests
2
3	url = "https://api.confident-ai.com/v1/metric-collections"
4
5	payload = {
6	"name": "Collection Name",
7	"multiTurn": False,
8	"metricSettings": [
9	{
10	"metric": { "name": "Answer Relevancy" },
11	"threshold": 0.8
12	}
13	]
14	}
15	headers = {
16	"CONFIDENT_API_KEY": "<PROJECT-API-KEY>",
17	"Content-Type": "application/json"
18	}
19
20	response = requests.post(url, json=payload, headers=headers)
21
22	print(response.json())