切换语言

The batch object

id

stringsource

object

stringsource

The object type, which is always batch.source

endpoint

stringsource

The OpenAI API endpoint used by the batch.source

errors

objectsource

input_file_id

stringsource

The ID of the input file for the batch.source

completion_window

stringsource

The time frame within which the batch should be processed.source

status

stringsource

The current status of the batch.source

output_file_id

stringsource

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

error_file_id

stringsource

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

created_at

integersource

The Unix timestamp (in seconds) for when the batch was created.source

in_progress_at

integersource

The Unix timestamp (in seconds) for when the batch started processing.source

expires_at

integersource

The Unix timestamp (in seconds) for when the batch will expire.source

finalizing_at

integersource

The Unix timestamp (in seconds) for when the batch started finalizing.source

completed_at

integersource

The Unix timestamp (in seconds) for when the batch was completed.source

failed_at

integersource

The Unix timestamp (in seconds) for when the batch failed.source

expired_at

integersource

The Unix timestamp (in seconds) for when the batch expired.source

cancelling_at

integersource

The Unix timestamp (in seconds) for when the batch started cancelling.source

cancelled_at

integersource

The Unix timestamp (in seconds) for when the batch was cancelled.source

request_counts

objectsource

The request counts for different statuses within the batch.source

metadata

mapsource

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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.source

OBJECT The batch object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}