Tasks

Cancel task run

Changed on

Cancel a running task run. Only valid when the run's current status is pending or running.

<Note>This endpoint is in beta, read more here.</Note>

post/v2/task-runs/{run_id}/cancel

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/task-runs/{run_id}/cancel
  • Auth
    HTTP bearer

Path parameters

run_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique task run identifier (base64)

Response

Returns a single task run object

idstring required

The unique identifier for the task run.

task_idstring required

The parent task identifier (base64).

experiment_idstring nullable

Created experiment identifier (base64). Present only for RUN_EXPERIMENT task runs; null for all other task types.

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required

Status of a task run.

  • PENDING - The run has been created but not yet started.
  • RUNNING - The run is currently in progress.
  • COMPLETED - The run finished successfully.
  • FAILED - The run encountered an error and stopped.
  • CANCELLED - The run was cancelled before completion.
run_started_atstring date-time nullable required

When the run started processing.

run_finished_atstring date-time nullable required

When the run finished processing.

data_start_timestring date-time nullable required

Start of the data window evaluated. Null for run_experiment runs.

data_end_timestring date-time nullable required

End of the data window evaluated. Null for run_experiment runs.

num_successesinteger required

Number of successfully evaluated items.

num_errorsinteger required

Number of items that errored during evaluation.

num_skippedinteger required

Number of items that were skipped.

created_atstring date-time required

When the run was created.

created_by_user_idstring nullable required

The unique identifier for the user who triggered the run.

failure_reasonstring nullable

Human-readable explanation of why the run failed or was cancelled; null for successful runs. For example, when all matching data already has evaluation labels from a previous run, the task cancels with zero successes, errors, and skipped items, and this field explains that the task must be re-triggered with override_evaluations enabled to re-evaluate it.

Changes

  • 4f94eb2fd1abRevision changes
    • warning

      added the new CANCELLED enum value to the response property for the response status

    • warning

      added the new COMPLETED enum value to the response property for the response status

    • warning

      added the new FAILED enum value to the response property for the response status

    • warning

      added the new PENDING enum value to the response property for the response status

    • warning

      added the new RUNNING enum value to the response property for the response status

    • info

      api operation id task_runs_cancel removed and replaced with cancel_task_run

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the cancelled enum value from the response property for the response status

    • info

      removed the completed enum value from the response property for the response status

    • info

      removed the failed enum value from the response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the running enum value from the response property for the response status