Sign in

v27

latestOpenAPI 3.0.02026-07-1347144237.4 KB
Batch:

Cancels the processing of the batch specified by the given batch-id.

post/batches/{batch-id}/cancel

Path parameters

batch-idstring required

The identifier of the batch.

Query parameters

api-versionstring required

The requested API version.

Response

The batch has been successfully canceled.

idstring required

The identity of this item.

object'list' | 'fine_tuning.job' | 'file' | 'fine_tuning.job.event' | 'fine_tuning.job.checkpoint' | 'model' | 'upload' | 'upload.part' | 'batch' | 'wandb'

Defines the type of an object.

endpointstring

The API endpoint used by the batch.

input_file_idstring required

The ID of the input file for the batch.

input_blobstring

The blob url containing the input file for the batch.

completion_windowstring

The time frame within which the batch should be processed.

status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'cancelled'

The status of a batch.

output_file_idstring

The ID of the file containing outputs of successfully executed requests.

output_blobstring

The blob url containing outputs of successfully executed requests.

error_file_idstring

The ID of the file containing outputs of requests with errors.

error_blobstring

The blob url containing outputs of requests with errors.

created_atinteger

A timestamp when this batch was created (in unix epochs).

in_progress_atinteger

A timestamp when this batch started progressing (in unix epochs).

expires_atinteger

A timestamp when this batch will expire (in unix epochs).

finalizing_atinteger

A timestamp when this batch started finalizing (in unix epochs).

completed_atinteger

A timestamp when this batch was completed (in unix epochs).

failed_atinteger

A timestamp when this batch failed (in unix epochs).

expired_atinteger

A timestamp when this batch expired (in unix epochs).

cancelling_atinteger

A timestamp when this batch started cancelling (in unix epochs).

cancelled_atinteger

A timestamp when this batch was cancelled (in unix epochs).

metadataobject

A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format.