For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordPlatform
DocumentationIntegrationsAPI referenceSDKsChangelog
DocumentationIntegrationsAPI referenceSDKsChangelog
  • API Reference
      • POSTCreate a dataset
      • POSTList datasets
      • GETRetrieve a dataset
      • PATCHUpdate a dataset
      • DELDelete a dataset
      • POSTCreate a dataset log
      • POSTList dataset logs
      • GETRetrieve a dataset log
      • PATCHUpdate a dataset log
      • DELDelete a dataset log
      • POSTBulk create dataset logs
      • POSTRun evaluators on a dataset
      • GETList dataset evaluation runs
      • PUTReplace a dataset log
      • POSTImport existing logs into a dataset
      • DELRemove logs from a dataset
      • GETGet dataset logs summary
      • POSTGet filtered dataset logs summary
  • Reference
    • Filters API Reference
LogoLogo
DiscordPlatform
API ReferenceDatasets

Run evaluators on a dataset

POST
https://api.respan.ai/api/datasets/:dataset_id/eval-reports/create/
POST
/api/datasets/:dataset_id/eval-reports/create/
$curl -X POST https://api.respan.ai/api/datasets/dataset_id/eval-reports/create/ \
> -H "Authorization: Bearer sk_live_xxxxx" \
> -H "Content-Type: application/json" \
> -d '{
> "evaluator_ids": [
> "eval_abc123"
> ]
>}'
1{
2 "created_tasks": [
3 {
4 "task_id": "task_01J6ABCDEF",
5 "name": "Run evaluator accuracy on dataset Support Conversations - July",
6 "dataset_id": "6d0b2c7e-3a6a-4c09-9c7e-1f2d9e2d3f0a",
7 "evaluator_slug": "accuracy",
8 "status": "pending",
9 "started_at": null,
10 "completed_at": null,
11 "error_message": "",
12 "evaluated_logs_count": null,
13 "score": null
14 }
15 ],
16 "experiment_updated": false
17}
Create dataset evaluation tasks for one or more evaluators.
Was this page helpful?
Previous

List dataset evaluation runs

Next
Built with

Path parameters

dataset_idstringRequired
Dataset ID.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY.

Request

This endpoint expects an object.
evaluator_idslist of stringsRequired
Evaluator IDs to run against the dataset.
experiment_idstringOptional
Optional experiment to associate with the evaluation runs.
generation_methodstringOptional

Optional generation strategy. Defaults to auto.

Response

Evaluation tasks created.
created_taskslist of objects
errorsmap from strings to any
experiment_updatedboolean
experiment_evaluator_idslist of strings

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error