Sign in
Batch:

Creates and executes a batch from an uploaded file of requests. Response includes details of the enqueued job including job status. The ID of the result file is added to the response once complete.

post/batches

Query parameters

api-versionstring required

The requested API version.

Request body

input_file_idstring

The ID if the input file for the batch.

input_blobstring

The url of an Azure Storage blob to use as input for the batch.

endpointstring required

The API endpoint used by the batch.

completion_windowstring required

The time frame within which the batch should be processed.

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.

Response

The batch has been successfully created.

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.

Changes

Changed in 5 of the 26 revisions of this API.45

  • 2022-03-01-previewb177dc430e3912See the full diff
    • ▲

      added required request body

      request-body-added-required

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    • ○

      added the media type application/json for the response with the status

      response-media-type-added

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

  • 2022-03-01-preview5a7369607eb211See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added

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

  • 2022-03-01-preview7f597b88d2e911See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added

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

  • 2022-03-01-preview086f672d36481See the full diff
    • ○

      endpoint added

      endpoint-added

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

  • 2022-03-01-preview9d525b5caa311See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

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