Run eval on dataset
Run evaluators on all spans in a dataset to generate evaluation reports.
## Authentication
- API key: `Authorization: Bearer `
## Path Parameters
- `dataset_id` *string* **required**: The ID of the dataset to run evaluations on.
## Request Body
```json Request
{
"evaluator_slugs": ["char_count_eval", "quality_eval"]
}
```
## Examples
```python Python
dataset_id = "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a"
url = f"https://api.respan.ai/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())
```
```bash cURL
curl -X POST "https://api.respan.ai/api/datasets/{dataset_id}/eval-reports/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"evaluator_slugs": ["char_count_eval", "quality_eval"]
}'
```
## Response
```json 200 OK
{
"id": "report_id_123",
"dataset_id": "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a",
"status": "running",
"evaluator_slugs": ["char_count_eval", "quality_eval"]
}
```
Authentication
AuthorizationBearer
API key authentication. Get your API key from https://platform.respan.ai/platform/api-keys
Path parameters
dataset_id
The ID of the dataset to run evaluations on.
Request
This endpoint expects an object.
Response
Successful response for Run eval on dataset
Errors
401
Unauthorized Error
