Deployments.ai Docs
Evaluations

List release comparisons, newest first

GET /v1/release-comparisons · SDK listReleaseComparisons · CLI deployments eval comparison list

GET
/v1/release-comparisons

Requires observability:read.

Authorization

platformBearer
headerAuthorizationBearer <token>

Platform bearer credential accepted as an opaque API key or JWT.

Query Parameters

cursor?string
Length1 <= length <= 8192
limit?integer
Range1 <= value <= 100
status?string

Only comparisons in this status.

Value in"completed""failed""queued""running"
baselineReleaseId?string

Only comparisons with this baseline release.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
candidateReleaseId?string

Only comparisons with this candidate release.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-organization*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-environment*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListReleaseComparisonsResponse

application/json
  1. response
items*array<>
nextCursor?string|null
curl -X GET "https://example.com/v1/release-comparisons" \  -H "x-deployments-organization: string" \  -H "x-deployments-project: string" \  -H "x-deployments-environment: string"
{  "items": [    {      "baseline": {        "agentReleaseId": "string",        "evaluationRunId": "string",        "releaseContentHash": "string"      },      "candidate": {        "agentReleaseId": "string",        "evaluationRunId": "string",        "releaseContentHash": "string"      },      "completedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "datasetId": "string",      "error": {        "code": "string",        "message": "string"      },      "gateMode": "advisory",      "gatePolicy": {        "maxEvaluatorErrorRate": 0,        "maxMeanDecrease": 0,        "maxMissingEvidenceRate": 0,        "maxNewFailures": 0,        "maxPassRateDecrease": 0,        "minComparableCases": 1      },      "id": "string",      "reasons": [        "string"      ],      "report": {        "json": {          "contentType": "string",          "downloadUrl": "string",          "downloadUrlExpiresAt": "2019-08-24T14:15:22Z",          "sha256": "string",          "sizeBytes": 0        },        "markdown": {          "contentType": "string",          "downloadUrl": "string",          "downloadUrlExpiresAt": "2019-08-24T14:15:22Z",          "sha256": "string",          "sizeBytes": 0        }      },      "runtimeConfigFromAgentDeploymentId": "string",      "scoreDefinitions": [        {          "evaluatorVersionHash": "string",          "name": "string",          "revision": 1,          "scoreDefinitionId": "string",          "threshold": 0,          "type": "deterministic"        }      ],      "status": "completed",      "summary": {        "comparableCases": 0,        "costUsdMicros": {          "baselineTotal": 0,          "candidateTotal": 0,          "delta": 0        },        "definitions": [          {            "baselineMean": 0,            "baselinePassRate": 0,            "candidateMean": 0,            "candidatePassRate": 0,            "meanDelta": 0,            "name": "string",            "passRateDelta": 0,            "revision": 0,            "scoreDefinitionId": "string"          }        ],        "evaluatorErrors": {          "baseline": 0,          "candidate": 0        },        "latency": {          "baselineP50Ms": 0,          "baselineP95Ms": 0,          "candidateP50Ms": 0,          "candidateP95Ms": 0,          "p50DeltaMs": 0,          "p95DeltaMs": 0        },        "missingEvidence": {          "baseline": 0,          "candidate": 0        },        "regressions": 0,        "tokens": {          "baselineTotal": 0,          "candidateTotal": 0,          "delta": 0        },        "totalCases": 0      },      "updatedAt": "2019-08-24T14:15:22Z",      "verdict": "error",      "version": 0    }  ],  "nextCursor": "string"}