AYaymara-ai
Evals

Get Eval

Changed on

Retrieve a specific eval by its UUID.

Args: eval_uuid (str): UUID of the eval to retrieve. workspace_uuid (str, optional): Optional workspace UUID for filtering.

Returns: Eval: The eval data.

Raises: AymaraAPIError: If the eval is not found.

Example: GET /api/evals/{eval_uuid}

get/v2/evals/{eval_uuid}

Request

Path parameters

eval_uuidstring required

Query parameters

workspace_uuidstring

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.

Changes

  • 0cb64ef11adfRevision changes
    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

  • cd49adceebf8Revision changes
    • info

      added subschema #1 subschema #4 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #4 from the response property anyOf list for the response status