List Metrics

GET

https://api.confident-ai.com/v1/metrics

GET

/v1/metrics

1 import requests
2 
3 url = "https://api.confident-ai.com/v1/metrics"
4 
5 headers = {"CONFIDENT_API_KEY": "<PROJECT-API-KEY>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 {
2   "success": true,
3   "data": {
4     "metrics": [
5       {
6         "name": "Correctness",
7         "multiTurn": false,
8         "id": "METRIC-ID-1",
9         "criteria": "Determine if the `actual output` is correct based on the `input`.",
10         "evaluationParams": [
11           "input",
12           "actualOutput"
13         ]
14       },
15       {
16         "name": "Relevancy",
17         "multiTurn": true,
18         "id": "METRIC-ID-2",
19         "criteria": "Determine if the assistant answers are relevant to what the user is asking."
20       }
21     ]
22   },
23   "deprecated": false
24 }

Retrieves all the metrics from your Confident AI project.

Response

successboolean

This is true if the metrics were successfully retrieved.

dataobject

This maps to all the metrics retrieved.

deprecatedboolean

This is true if this metrics endpoint is deprecated.

Headers

Response