List Metric Collections

GEThttps://api.confident-ai.com/v1/metric-collections

Lists all the available metric collections in your Confident AI project, each with the metrics inside it. Fetch a single collection for its sampling and transformer configuration.

GET/v1/metric-collections

curl -X GET "https://api.confident-ai.com/v1/metric-collections" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "metricCollections": [
      {
        "id": "COLLECTION-ID",
        "name": "Collection Name",
        "multiTurn": false,
        "metricsSettings": [
          {
            "metric": {
              "id": 1,
              "name": "Faithfulness"
            },
            "activated": true,
            "threshold": 0.5,
            "sampleRate": 1
          }
        ]
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

The metric collections in your project.

successboolean
This is true if the list of metric collections was retrieved successfully.
dataobject
This maps to a list of metric collections, which can be used to run evals remotely.
Show 1 propertyHide 1 property
- metricCollectionslist of objects
  This is a list of metric collection objects.
  Show 4 propertiesHide 4 properties
  - idstring
    This is the id of the metric collection.
  - namestring
    This is the name of the metric collection, which should be supplied to the evals API to run evaluations remotely.
  - multiTurnboolean
    This is true if the metric collection is a multi-turn collection, which only contains multi-turn metrics for multi-turn evaluations.
  - metricsSettingslist of objects
    The metrics in the collection, with the settings that decide whether and how each one runs.
    Show 4 propertiesHide 4 properties
    metricobject
    This is a metric object, which contains the metric id and name.
    Show 2 propertiesHide 2 properties
    idinteger
    This is the id of the metric.
    namestring
    This is the name of the metric.
    activatedboolean
    This is true if the metric is activated. Only activated metrics are used for evaluations. Non-activated metrics are skipped.
    thresholdnumber
    This is the threshold for the metric, which determines if the metric passes or fails depending on if the metric score is above or below the threshold.
    sampleRatenumber
    This is the probability of the metric being ran for evaluation.

Built byConfident AI