Batch
Represents a Batch object returned by the OpenAI API.
Attributes
- cancelled_at
The Unix timestamp (in seconds) for when the batch was cancelled, if available.
- cancelling_at
The Unix timestamp (in seconds) for when the batch started cancelling, if available.
- completed_at
The Unix timestamp (in seconds) for when the batch was completed, if available.
- completion_window
The time frame within which the batch should be processed.
- created_at
The Unix timestamp (in seconds) for when the batch was created.
- endpoint
The OpenAI API endpoint used by the batch.
- error_file_id
The ID of the file containing the outputs of requests with errors, if available.
- errors
Map of errors, if any occurred during the batch processing.
- expired_at
The Unix timestamp (in seconds) for when the batch expired, if available.
- expires_at
The Unix timestamp (in seconds) for when the batch will expire, if available.
- failed_at
The Unix timestamp (in seconds) for when the batch failed, if available.
- finalizing_at
The Unix timestamp (in seconds) for when the batch started finalizing, if available.
- id
The ID of the batch.
- in_progress_at
The Unix timestamp (in seconds) for when the batch started processing, if available.
- input_file_id
The ID of the input file for the batch.
- metadata
Optional metadata as a map. This can be useful for storing additional information about the batch in a structured format.
- object
The object type, which is always "batch".
- output_file_id
The ID of the file containing the outputs of successfully executed requests, if available.
- request_counts
Map detailing the counts of requests by their status within the batch.
- status
The current status of the batch.
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any