Skip to main content
POST
/
api
/
datasets
/
{dataset_id}
/
eval-reports
/
create
{
  "evaluator_slugs": ["char_count_eval", "quality_eval"]
}

{
  "id": "report_id_123",
  "dataset_id": "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a",
  "status": "running",
  "evaluator_slugs": ["char_count_eval", "quality_eval"]
}
Run evaluators on all logs in a dataset to generate evaluation reports.

​
Authentication

  • API key: Authorization: Bearer <API key>

​
Path Parameters

​
dataset_id
string
required
The ID of the dataset to run evaluations on.

​
Request Body

{
  "evaluator_slugs": ["char_count_eval", "quality_eval"]
}

​
Examples

import requests

dataset_id = "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a"
url = f"https://api.keywordsai.co/api/datasets/{dataset_id}/eval-reports/create"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

data = {
    "evaluator_slugs": ["char_count_eval", "quality_eval"]
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

​
Response

{
  "id": "report_id_123",
  "dataset_id": "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a",
  "status": "running",
  "evaluator_slugs": ["char_count_eval", "quality_eval"]
}