DigitalOcean API (unofficial showcase)
POST/v2/gen-ai/evaluation_datasets

Create an evaluation dataset

Creates an evaluation dataset for agent evaluation. Set dataset_paradigm to describe the dataset row format and dataset_type to identify its type; both fields have defaults when omitted. Include file_upload_dataset to associate an uploaded file with the dataset.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Evaluation dataset details, including its name, dataset type and paradigm, and optional uploaded-file metadata.

dataset_paradigmstringoptional
EvaluationDatasetParadigm is the row/content shape of a dataset, orthogonal to the surface in EvaluationDatasetType (e.g. a model dataset can be single- or multi-turn).
Allowed:EVALUATION_DATASET_PARADIGM_SINGLE_TURNEVALUATION_DATASET_PARADIGM_MULTI_TURNEVALUATION_DATASET_PARADIGM_CODINGEVALUATION_DATASET_PARADIGM_N_PLUS_1Default:EVALUATION_DATASET_PARADIGM_SINGLE_TURN
dataset_typestringoptional
The dataset type: EVALUATION_DATASET_TYPE_UNKNOWN or EVALUATION_DATASET_TYPE_MODEL. Defaults to EVALUATION_DATASET_TYPE_UNKNOWN when omitted.
Allowed:EVALUATION_DATASET_TYPE_UNKNOWNEVALUATION_DATASET_TYPE_MODELDefault:EVALUATION_DATASET_TYPE_UNKNOWN
file_upload_datasetobjectoptional
File to upload as data source for knowledge base.
namestringoptional
The name of the agent evaluation dataset.

6 status codes
200Returns the created evaluation dataset's UUID.
evaluation_dataset_uuidstringoptional
Evaluation dataset uuid.
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when the server encounters an error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when credentials are invalid. A 404 is returned when a requested resource is not found. A 429 is returned when the API rate limit is exceeded. A 500 is returned when the server encounters an error. dataset_paradigm must be one of EVALUATION_DATASET_PARADIGM_SINGLE_TURN, EVALUATION_DATASET_PARADIGM_MULTI_TURN, EVALUATION_DATASET_PARADIGM_CODING, or EVALUATION_DATASET_PARADIGM_N_PLUS_1; dataset_type must be EVALUATION_DATASET_TYPE_UNKNOWN or EVALUATION_DATASET_TYPE_MODEL.