LLM-readable documentation index

Cancel a model comparison

Hand off to an LLM

Cancel a comparison.

Cancels every entry's still-running scoring run. Entries that already finished keep their results; the comparison's status becomes cancelled. Returns the updated comparison.

POST
/v3/model-comparisons/{comparisonID}/cancel
x-api-key<token>

Authenticate using API Key in request header

In: header

Path Parameters

comparisonID*string

The comparisonID returned by POST /v3/model-comparisons.

Response Body

application/json

application/json

curl -X POST "https://api.bem.ai/v3/model-comparisons/string/cancel"
{
  "comparisonID": "string",
  "name": "string",
  "status": "pending",
  "entries": [
    {
      "label": "string",
      "functionName": "string",
      "functionVersionNum": 0,
      "scoreRunID": "string",
      "status": "pending",
      "isBaseline": true,
      "coverage": {
        "completed": 0,
        "total": 0
      },
      "metrics": {
        "aggregateMetrics": {
          "accuracy": 0.1,
          "precision": 0.1,
          "recall": 0.1,
          "f1Score": 0.1,
          "tp": 0,
          "fp": 0,
          "fn": 0,
          "tn": 0
        },
        "fieldMetrics": [
          null
        ]
      },
      "latencyPercentiles": {
        "latencyP50": 0.1,
        "latencyP90": 0.1,
        "latencyP95": 0.1
      },
      "baselineMetrics": {
        "aggregateMetrics": {
          "accuracy": 0.1,
          "precision": 0.1,
          "recall": 0.1,
          "f1Score": 0.1,
          "tp": 0,
          "fp": 0,
          "fn": 0,
          "tn": 0
        },
        "fieldMetrics": [
          null
        ]
      },
      "lift": {
        "accuracy": {
          "baselineValue": 0.1,
          "comparisonValue": 0.1,
          "difference": 0.1,
          "liftPercent": 0.1
        },
        "precision": {
          "baselineValue": 0.1,
          "comparisonValue": 0.1,
          "difference": 0.1,
          "liftPercent": 0.1
        },
        "recall": {
          "baselineValue": 0.1,
          "comparisonValue": 0.1,
          "difference": 0.1,
          "liftPercent": 0.1
        },
        "f1Score": {
          "baselineValue": 0.1,
          "comparisonValue": 0.1,
          "difference": 0.1,
          "liftPercent": 0.1
        }
      },
      "rowResults": [
        {
          "rowKey": "string",
          "fields": [
            {
              "path": "string",
              "category": "string",
              "expected": null,
              "actual": null
            }
          ]
        }
      ]
    }
  ]
}
{
  "message": "string",
  "code": 0,
  "details": {}
}

See also