Struct BatchObject 

pub struct BatchObject {

    pub id: String,
    pub object: String,
    pub endpoint: String,
    pub errors: Option<BatchErrors>,
    pub input_file_id: String,
    pub completion_window: String,
    pub status: BatchStatus,
    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<RequestCounts>,
    pub metadata: Option<HashMap<String, String>>,
}

A batch object representing an async batch job.

The Batch API allows you to send asynchronous groups of requests with 50% lower costs and higher rate limits.

Fields

id: String

The unique identifier for the batch.

object: String

The object type (always “batch”).

endpoint: String

The API endpoint used for the batch.

errors: Option<BatchErrors>

Any errors that occurred during batch processing.

input_file_id: String

The ID of the input file containing the requests.

completion_window: String

The time window for batch completion (e.g., “24h”).

status: BatchStatus

The current status of the batch.

output_file_id: Option<String>

The ID of the output file containing the results.

error_file_id: Option<String>

The ID of the error file containing failed requests.

created_at: i64

The Unix timestamp when the batch was created.

in_progress_at: Option<i64>

The Unix timestamp when processing started.

expires_at: Option<i64>

The Unix timestamp when the batch expires.

finalizing_at: Option<i64>

The Unix timestamp when finalization started.

completed_at: Option<i64>

The Unix timestamp when the batch completed.

failed_at: Option<i64>

The Unix timestamp when the batch failed.

expired_at: Option<i64>

The Unix timestamp when the batch expired.

cancelling_at: Option<i64>

The Unix timestamp when cancellation started.

cancelled_at: Option<i64>

The Unix timestamp when the batch was cancelled.

request_counts: Option<RequestCounts>

Counts of requests in different states.

metadata: Option<HashMap<String, String>>

User-defined metadata attached to the batch.

Trait Implementations

impl Clone for BatchObject

fn clone(&self) -> BatchObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BatchObject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.