Get Eval Structure

Retrieve the configuration structure of a specific evaluation, including required keys,.

GET https://api.futureagi.com/model-hub/develops/{dataset_id}/get_eval_structure/{eval_id}/

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. Required when eval_type is user.

eval_id UUID Required

UUID of the evaluation template or user eval metric to retrieve.

Query parameters

eval_type string Required

Type of evaluation to retrieve. One of preset, user, or previously_configured.

Response

200 OK
data object
Response payload containing the evaluation structure.
eval object
Evaluation structure object with all configuration details.
id string
UUID of the evaluation.
template_id string

UUID of the underlying eval template.

name string

Display name of the evaluation.

description string

Description of what the evaluation assesses.

required_keys array
Variable keys that must be mapped to dataset columns.
optional_keys array
Variable keys that may optionally be mapped to dataset columns.
variable_keys array
Complete list of all template variable keys (required and optional).
mapping object
Current key-to-column mapping configuration.
config object

Template-specific configuration parameters.

params object
Runtime parameters for the evaluation.
output string
Output type of the evaluation.
choices object
Choice options for choice-type evaluations.
models string

Configured model for running this evaluation.

kb_id string
UUID of the associated knowledge base, if configured.
error_localizer boolean
Whether error localization is enabled.
api_key_available boolean
Whether the required API key for the evaluation model is configured.
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 eval template or user eval was not found.
500 Internal Server Error Optional
An unexpected error occurred on the server while retrieving the eval structure.
GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE