OMomnistack-sh
Evals

Cancel eval run

Changed on

Cancel an ongoing evaluation run.

post/evals/{eval_id}/runs/{run_id}/cancel

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/evals/{eval_id}/runs/{run_id}/cancel
  • Auth
    HTTP bearer

Path parameters

eval_idstring required

The ID of the evaluation whose run you want to cancel.

run_idstring required

The ID of the run to cancel.

Response

The canceled eval run object

object'eval.run' required

The type of the object. Always "eval.run".

idstring required

Unique identifier for the evaluation run.

eval_idstring required

The identifier of the associated evaluation.

statusstring required

The status of the evaluation run.

modelstring nullable required

The model that is evaluated, if applicable.

namestring nullable required

The name of the evaluation run.

created_atinteger required

Unix timestamp (in seconds) when the evaluation run was created.

report_urlstring uri required

The URL to the rendered evaluation run report on the UI dashboard.

metadataMetadata nullable required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Changes

  • 410e6429083aRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • af780af62f70Revision changes
    • info

      the response's property default value changed from gpt-image-1 to gpt-image-2 for the status