API ReferenceEvaluations

Dataset Evaluation Tasks Update

Detail view for individual dataset evaluation tasks. Similar to EvalSetDetailView but for dataset evaluation tasks.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

idintegerRequired

Request

This endpoint expects an object.
task_idstringRequired1-255 characters
namestringRequired1-255 characters
dataset_idstringRequired1-255 characters
typeenumOptional
  • add_logs - Add Logs
  • remove_logs - Remove Logs
  • run_logs - Run Logs
  • run_evals - Run Evals
  • run_experiment - Run Experiment
statusenumOptional
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
started_atdatetime or nullOptional
completed_atdatetime or nullOptional
error_messagestringOptional
metadataanyOptional

Response

task_idstring<=255 characters
namestring<=255 characters
dataset_idstring<=255 characters
dataset_namestringRead-only
dataset_descriptionstringRead-only
progress_percentagestringRead-only
processed_countstringRead-only
total_countstringRead-only
evaluator_namestringRead-only
evaluator_slugstringRead-only
evaluator_descriptionstringRead-only
created_atdatetimeRead-only
typeenum
  • add_logs - Add Logs
  • remove_logs - Remove Logs
  • run_logs - Run Logs
  • run_evals - Run Evals
  • run_experiment - Run Experiment
statusenum
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
started_atdatetime or null
completed_atdatetime or null
error_messagestring
metadataany