Sign in
Eval Runs

Get Eval Run

Retrieve a specific eval run by its UUID.

Args: eval_run_uuid (str): UUID of the eval run to retrieve. workspace_uuid (str, optional): UUID of the workspace. Defaults to None.

Returns: EvalRunResult: The eval run data.

Raises: AymaraAPIError: If the organization is missing or the eval run is not found.

Example: GET /api/eval-runs/{eval_run_uuid}

get/v2/eval-runs/{eval_run_uuid}

Path parameters

eval_run_uuidstring required

Query parameters

workspace_uuidstring

Response

OK

eval_run_uuidstring required

Unique identifier for the eval run.

eval_uuidstring required

Unique identifier for the eval.

namestring nullable

Name of the eval run, if any (defaults to the eval name + timestamp).

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

Resource status.

created_atstring date-time required

Timestamp when the eval run was created.

updated_atstring date-time required

Timestamp when the eval run was last updated.

ai_descriptionstring nullable

Description of the AI for this run, if any.

is_sandboxboolean

Indicates if the eval run is sandboxed (default: False).

workspace_uuidstring nullable

UUID of the associated workspace, if any.

pass_ratenumber nullable

Pass rate for the eval run, if any.

num_promptsinteger nullable

Number of prompts in the eval run, if any.

num_responses_scoredinteger nullable

Number of responses scored in the eval run, if any.

Changes

Changed in 13 of the 25 revisions of this API.51128

  • 0cb64ef11adf2See the full diff
    • ▲

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

      response-required-property-removed

    • ▲

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

      response-required-property-removed

  • cd49adceebf82See the full diff
    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-removed

  • 0b43b7bedf322See the full diff
    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added to the // response property anyOf list for the response status

      response-property-any-of-added

  • 1af31c95d91a12See the full diff
    • ▲

      added to the //// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      removed from the //// response property anyOf list for the response status

      response-property-any-of-removed

    • ○

      added discriminator to //// response property for the response status

      response-property-discriminator-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d950d722e2302See the full diff
    • ○

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

      response-property-any-of-added

    • ○

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

      response-property-any-of-removed

  • 9f42371cf19a4See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 33b4b8e9d2ce2See the full diff
    • ○

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

      response-property-any-of-added

    • ○

      removed subschema #2 from the //// response property anyOf list for the response status

      response-property-any-of-removed

  • b824d75fc3cb1See the full diff
    • ○

      added to the // response property anyOf list for the response status

      response-property-any-of-added

  • 9b529d67a7d0115See the full diff
    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new auth.workspace_required enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new video enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new video enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property ///// to the response with the status

      response-optional-property-added

  • 39873621da545See the full diff
    • ○

      the response's property default value changed from 50 to 100 for the status

      response-property-default-value-changed

    • ○

      removed the audio enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the audio enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the video enum value from the /// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the video enum value from the //// response property for the response status

      response-property-enum-value-removed