API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get evaluation results for a dataset

client.datasets.getEvaluation(stringdatasetID, RequestOptionsoptions?): DatasetGetEvaluationResponse { dataset_id, quality, raw_results, status }

GET/api/v1/datasets/{dataset_id}/evaluation

Get evaluation results for a dataset

ParametersExpand Collapse

datasetID: string

ReturnsExpand Collapse

DatasetGetEvaluationResponse { dataset_id, quality, raw_results, status }

dataset_id: string

Dataset ID

quality: Quality | null

Structured quality metrics. Null until evaluation completes.

grade_after: string | null

Letter grade (A-E) after augmentation

grade_before: string | null

Letter grade (A-E) before augmentation

improvement_percent: number | null

Relative quality improvement as a percentage

percentile_after: number | null

Percentile rank (0-100) after augmentation

score_after: number | null

Quality score (0-10) after augmentation

score_before: number | null

Quality score (0-10) before augmentation

raw_results: Record<string, unknown> | null

Raw evaluation results payload for advanced use. Null until evaluation completes.

status: string | null

Evaluation pipeline status: pending | running | succeeded | failed | skipped

Get evaluation results for a dataset

TypeScript

HTTP

TypeScript

Python

import Adaption from 'adaption';

const client = new Adaption({
  apiKey: process.env['ADAPTION_API_KEY'], // This is the default and can be omitted
});

const response = await client.datasets.getEvaluation('dataset_id');

console.log(response.dataset_id);

200 example

{
  "dataset_id": "dataset_id",
  "quality": {
    "grade_after": "A",
    "grade_before": "C",
    "improvement_percent": 37.1,
    "percentile_after": 92.3,
    "score_after": 8.5,
    "score_before": 6.2
  },
  "raw_results": {
    "foo": "bar"
  },
  "status": "succeeded"
}

Returns Examples

200 example

{
  "dataset_id": "dataset_id",
  "quality": {
    "grade_after": "A",
    "grade_before": "C",
    "improvement_percent": 37.1,
    "percentile_after": 92.3,
    "score_after": 8.5,
    "score_before": 6.2
  },
  "raw_results": {
    "foo": "bar"
  },
  "status": "succeeded"
}