Struct Batch 

pub struct Batch {

    pub id: String,
    pub object: String,
    pub endpoint: String,
    pub errors: Option<BatchErrors>,
    pub input_file_id: String,
    pub completion_window: String,
    pub status: String,
    pub output_file_id: Option<String>,
    pub error_file_id: Option<String>,
    pub created_at: i64,
    pub in_progress_at: Option<i64>,
    pub expires_at: Option<i64>,
    pub finalizing_at: Option<i64>,
    pub completed_at: Option<i64>,
    pub failed_at: Option<i64>,
    pub expired_at: Option<i64>,
    pub cancelling_at: Option<i64>,
    pub cancelled_at: Option<i64>,
    pub request_counts: Option<BatchRequestCounts>,
    pub metadata: Option<Metadata>,
}

Represents a Batch job object.

Used By

• /batches (POST response, GET - in ListBatchesResponse)
• /batches/{batch_id} (GET)
• /batches/{batch_id}/cancel (POST response)

Fields

id: String

Batch job ID.

object: String

The object type, always batch.

endpoint: String

The OpenAI API endpoint used by the batch.

errors: Option<BatchErrors>

Errors associated with the batch job.

input_file_id: String

The ID of the input file for the batch.

completion_window: String

The time frame within which the batch should be processed (e.g., “24h”).

status: String

The current status of the batch.

output_file_id: Option<String>

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

error_file_id: Option<String>

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

created_at: i64

Creation timestamp.

in_progress_at: Option<i64>

Timestamp when processing started.

expires_at: Option<i64>

Expiration timestamp.

finalizing_at: Option<i64>

Timestamp when finalization started.

completed_at: Option<i64>

Completion timestamp.

failed_at: Option<i64>

Failure timestamp.

expired_at: Option<i64>

Timestamp when the batch expired.

cancelling_at: Option<i64>

Timestamp when cancellation started.

cancelled_at: Option<i64>

Timestamp when the batch was cancelled.

request_counts: Option<BatchRequestCounts>

Request counts for different statuses within the batch.

metadata: Option<Metadata>

Metadata associated with the batch.

Trait Implementations

impl Clone for Batch

fn clone(&self) -> Batch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Batch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Batch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Batch

fn eq(&self, other: &Batch) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Batch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Batch