file-search

Get Evaluation Results

Status, progress, per-config scorecards, billing and per-case results for an eval. scorecards is {} and billing is null until the eval is terminal (completed, completed_with_errors, or failed). Items are paged by items_limit (default 100, max 500) and items_cursor; each item carries a result object per config name. Recall, MRR and nDCG are over scored units only; a failed query is counted in failed, never scored as a miss. Evals of a deleted collection return 404. Metric definitions are on the Evaluations guide.

get/v3/evals/{eval_id}

Path parameters

eval_idstring required

Query parameters

items_limitinteger
items_cursorstring nullable

Response

The eval, with items paged.

collection_namestring required
completed_atstring nullable
created_atstring required
environmentstring nullable
error_codestring nullable
error_messagestring nullable
eval_idstring required
idempotency_keystring required
request_idstring required
scorecardsobject
started_atstring nullable
status'pending' | 'running' | 'completed' | 'completed_with_errors' | 'failed' required
updated_atstring required
upload_idstring required

Changes

Changed in 2 of the 13 revisions of this API.417

  • 61a9364ad042416See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ○

      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 required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

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

    • ○

      endpoint added

      endpoint-added