Batch
objectThe object type, which is always batch.
Allowed values:batch
The OpenAI API endpoint used by the batch.
Show Child Parameters
The ID of the input file for the batch.
The time frame within which the batch should be processed.
The current status of the batch.
Allowed values:validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled
The ID of the file containing the outputs of successfully executed requests.
The ID of the file containing the outputs of requests with errors.
The Unix timestamp (in seconds) for when the batch was created.
The Unix timestamp (in seconds) for when the batch started processing.
The Unix timestamp (in seconds) for when the batch will expire.
The Unix timestamp (in seconds) for when the batch started finalizing.
The Unix timestamp (in seconds) for when the batch was completed.
The Unix timestamp (in seconds) for when the batch failed.
The Unix timestamp (in seconds) for when the batch expired.
The Unix timestamp (in seconds) for when the batch started cancelling.
The Unix timestamp (in seconds) for when the batch was cancelled.
The request counts for different statuses within the batch.
Show Child Parameters
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, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
BatchRequestInput
objectThe per-line object of the batch input file
A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.
The HTTP method to be used for the request. Currently only POST is supported.
Allowed values:POST
The OpenAI API relative URL to be used for the request. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported.
BatchRequestOutput
objectThe per-line object of the batch output and error files
A developer-provided per-request id that will be used to match outputs to inputs.
Show Child Parameters
For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure.
Show Child Parameters
CancelUploadRequest
objectChatCompletionFunctionCallOption
objectSpecifying a particular function via {"name": "my_function"} forces the model to call that function.
The name of the function to call.