class

OpenAI::Batch

Inherits JSON::Serializable < Reference < Object

Constructors

new(pull : JSON::PullParser)

new(id : String = "", object : BatchObject = BatchObject::Batch, endpoint : String = "", model : String | Nil = nil, errors : BatchErrors | Nil = nil, input_file_id : String = "", completion_window : String = "", status : BatchStatus = BatchStatus::Validating, output_file_id : String | Nil = nil, error_file_id : String | Nil = nil, created_at : Int64 = 0, in_progress_at : Int64 | Nil = nil, expires_at : Int64 | Nil = nil, finalizing_at : Int64 | Nil = nil, completed_at : Int64 | Nil = nil, failed_at : Int64 | Nil = nil, expired_at : Int64 | Nil = nil, cancelling_at : Int64 | Nil = nil, cancelled_at : Int64 | Nil = nil, request_counts : BatchRequestCounts | Nil = nil, usage : BatchUsage | Nil = nil, metadata : Metadata | Nil = nil)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

cancelled_at

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

cancelled_at=(cancelled_at : Int64 | Nil)

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

cancelling_at

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

cancelling_at=(cancelling_at : Int64 | Nil)

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

completed_at

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

completed_at=(completed_at : Int64 | Nil)

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

completion_window

The time frame within which the batch should be processed.

completion_window=(completion_window : String)

The time frame within which the batch should be processed.

created_at

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

created_at=(created_at : Int64)

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

endpoint

The OpenAI API endpoint used by the batch.

endpoint=(endpoint : String)

The OpenAI API endpoint used by the batch.

error_file_id

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

error_file_id=(error_file_id : String | Nil)

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

errors

errors=(errors : BatchErrors | Nil)

expired_at

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

expired_at=(expired_at : Int64 | Nil)

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

expires_at

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

expires_at=(expires_at : Int64 | Nil)

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

failed_at

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

failed_at=(failed_at : Int64 | Nil)

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

finalizing_at

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

finalizing_at=(finalizing_at : Int64 | Nil)

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

id

id=(id : String)

in_progress_at

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

in_progress_at=(in_progress_at : Int64 | Nil)

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

input_file_id

The ID of the input file for the batch.

input_file_id=(input_file_id : String)

The ID of the input file for the batch.

metadata

metadata=(metadata : Metadata | Nil)

model

Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

model=(model : String | Nil)

Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

object

The object type, which is always batch.

object=(object : BatchObject)

The object type, which is always batch.

output_file_id

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

output_file_id=(output_file_id : String | Nil)

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

request_counts

request_counts=(request_counts : BatchRequestCounts | Nil)

status

The current status of the batch.

status=(status : BatchStatus)

The current status of the batch.

usage

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.

usage=(usage : BatchUsage | Nil)

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.