List Metric Collections

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

Lists all the available metric collections in your Confident AI project.

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": "string",
        "name": "string",
        "multiTurn": true,
        "metricSettings": [
          {
            "metric": {
              "name": null
            },
            "activated": true,
            "threshold": 0,
            "includeReason": true,
            "strictMode": true,
            "sampleRate": 0
          }
        ]
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

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.
  - metricSettingslist of objects
    This is a list of settings for each metric in the collection, which can be configured on Confident AI's metric collection page.
    Show 6 propertiesHide 6 properties
    metricobject
    This is a metric object, which contains the metric name.
    Show 1 propertyHide 1 property
    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.
    includeReasonboolean
    This is true if a metric's include_reason setting is toggled on the Confident platform. If true, the reason for the metric score will be generated during evaluations.
    strictModeboolean
    This is true if the metric is in strict mode. Metrics in strict mode output a binary score of 0 or 1, indicating pass or fail, as opposed to a continuous score from 0 to 1.
    sampleRatenumber
    This is the probability of the metric being ran for evaluation.

Built byConfident AI