List batches

GET/v2/batchesList batches

List the batches for the current user

Parameters

page_sizeinteger · int32query

The maximum number of batches to return. The service may return fewer than this value. If unspecified, at most 50 batches will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringquery

A page token, received from a previous `ListBatches` call. Provide this to retrieve the subsequent page.

order_bystringquery

Batches can be ordered by creation time or last updated time. Use `created_at` for creation time or `updated_at` for last updated time.

X-Client-Namestringheader

The name of the project that is making the request.

Responses

objectListBatchesResponse

Response to a request to list batches.

batchesarray of object

The batches that belong to the authenticated user.

Show child attributes

Show array items

This resource represents a batch job.

created_atstring · date-time

read-only. Creation timestamp.

creator_idstring

read-only. User ID of the creator.

idstring

read-only. Batch ID.

input_dataset_idstringrequired

ID of the dataset the batch reads inputs from.

input_tokensstring · int64

read-only. The total number of input tokens in the batch.

modelstringrequired

The name of the model the batch uses.

namestringrequired

Batch name (e.g. `foobar`).

num_failed_recordsinteger · int32

read-only. The current number of failed records in the batch.

num_recordsinteger · int32

read-only. The total number of records in the batch.

num_successful_recordsinteger · int32

read-only. The current number of successful records in the batch.

org_idstring

read-only. Organization ID.

output_dataset_idstring

output_tokensstring · int64

read-only. The total number of output tokens in the batch.

statusstring

The possible stages of a batch life-cycle. - BATCH_STATUS_UNSPECIFIED: Unspecified status. - BATCH_STATUS_QUEUED: The batch has been queued. - BATCH_STATUS_IN_PROGRESS: The batch is in-progress. - BATCH_STATUS_CANCELING: The batch is being canceled. - BATCH_STATUS_COMPLETED: The batch has been completed. - BATCH_STATUS_FAILED: The batch has failed. - BATCH_STATUS_CANCELED: The batch has been canceled.

one of "BATCH_STATUS_UNSPECIFIED", "BATCH_STATUS_QUEUED", "BATCH_STATUS_IN_PROGRESS", "BATCH_STATUS_CANCELING", "BATCH_STATUS_COMPLETED", "BATCH_STATUS_FAILED", "BATCH_STATUS_CANCELED" · default "BATCH_STATUS_UNSPECIFIED"

status_reasonstring

read-only. More details about the reason for the status of a batch job.

updated_atstring · date-time

read-only. Latest update timestamp.

next_page_tokenstring

A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Example response

{
  "batches": [
    {
      "creator_id": "b5e1ffb9-49a1-4653-9927-94083316309d",
      "id": "9439e0e3-49a4-4336-93e3-485fc420bc18",
      "input_dataset_id": "my-requests-dataset",
      "model": "command",
      "name": "my-batch",
      "num_records": 5000,
      "org_id": "62603116-1750-4c04-b1b6-9d5046764bc4",
      "status": "BATCH_STATUS_IN_PROGRESS"
    }
  ]
}

objectBatchError