Sign in

v25

latestOpenAPI 3.1.0raw.githubusercontent.com2025-11-204973358.2 KB
Evals

Update Eval

Update an existing eval's fields and prompts.

Args: eval_uuid (str): UUID of the eval to update. update_request (EvalUpdateRequest): Update data including fields and prompt modifications. workspace_uuid (str, optional): Optional workspace UUID for filtering.

Returns: Eval: The updated eval data.

Raises: AymaraAPIError: If the eval is not found or update is invalid.

Example: PUT /api/evals/{eval_uuid} { "name": "Updated Eval Name", "ai_description": "Updated description", "prompt_updates": [ {"prompt_uuid": "...", "content": "New content", "action": "update"}, {"prompt_uuid": "...", "action": "delete"} ], "prompt_creates": [ {"content": "New prompt", "category": "test"} ] }

put/v2/evals/{eval_uuid}

Path parameters

eval_uuidstring required

Query parameters

workspace_uuidstring

Request body

namestring nullable

New name for the evaluation.

ai_descriptionstring nullable

New description of the AI under evaluation.

eval_instructionsstring nullable

New additional instructions for the eval.

Response

OK

eval_uuidstring nullable

Unique identifier for the evaluation.

namestring nullable

Name of the evaluation.

created_bystring nullable

Name of the user who created the evaluation.

ai_descriptionstring required

Description of the AI under evaluation.

eval_typestring required

Type of the eval (safety, accuracy, etc.)

eval_instructionsstring nullable

Additional instructions for the eval, if any.

languagestring nullable

Language code for the eval (default: "en").

modality'text' | 'image' | 'video'

Content type for AI interactions.

num_promptsinteger nullable

Number of prompts/questions in the eval (default: 50).

is_jailbreakboolean

Indicates if the eval is a jailbreak test.

is_sandboxboolean

Indicates if the eval results are sandboxed.

workspace_uuidstring nullable

UUID of the associated workspace, if any.

status'created' | 'processing' | 'finished' | 'failed'

Resource status.

created_atstring date-time nullable

Timestamp when the eval was created.

updated_atstring date-time nullable

Timestamp when the eval was last updated.