Evaluation

Creates a new in-progress test run and returns its id. Use this id as the testRunId when ingesting traces (POST /v1/traces) so that each trace becomes one test case in this run.

post/v1/test-runs

Request

Request body

metricCollectionstring

This is the metric collection used to evaluate the test cases formed from traces ingested into this test run.

identifierstring

This is an optional human-readable identifier for the test run, shown on the Confident AI platform.

Response

The created test run id.

successboolean required

A boolean indicating the success or failure of the API call

linkstring required

This is the URL to the test run on the Confident AI platform.

deprecatedboolean required

This is true if this endpoint is deprecated.

Example response

{
  "success": true,
  "data": {
    "id": "<TEST-RUN-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT_ID>/test-runs/<TEST-RUN-ID>/test-cases",
  "deprecated": false
}

Changes