Add Dataset Eval

Add an evaluation to a dataset by selecting a template and configuring the key mapping.

POST https://api.futureagi.com/model-hub/develops/{dataset_id}/add_user_eval/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Path parameters

dataset_id UUID Required

UUID of the dataset to add the evaluation to.

Request body

name string Required
Name for the evaluation. Maximum 50 characters.
template_id string Required
UUID of the eval template to use. Maximum 500 characters.
config object Required

Configuration object controlling how the evaluation executes against dataset rows.

config object

Template-specific configuration parameters.

params object

Runtime parameters for the evaluation engine.

mapping object

Mapping of eval template variable keys to dataset column names.

reason_column boolean

Whether to create a reason column alongside the eval result column.

kb_id string Optional

UUID of a knowledge base to associate with this evaluation.

error_localizer boolean Optional

Whether to enable error localization for this evaluation.

model string Optional
Model to use for running the evaluation. Maximum 100 characters.
run boolean Optional

Whether to immediately run the evaluation after adding it.

save_as_template boolean Optional

Whether to save this configuration as a new reusable eval template.

Response

200 OK
data string
Confirmation message indicating the evaluation was added.
success boolean
Whether the request completed successfully.

Errors

400 Bad Request Optional
Invalid request parameters.
401 Unauthorized Optional
Invalid or missing API credentials.
404 Not Found Optional
The specified dataset was not found.
429 Too Many Requests Optional
Resource limit reached.
500 Internal Server Error Optional
An unexpected error occurred on the server while adding the evaluation.
GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE