Struct Batch 

pub struct Batch {

    pub id: BatchId,
    pub file_id: Option<FileId>,
    pub created_at: DateTime<Utc>,
    pub metadata: Option<Value>,
    pub service_tier: Option<String>,
    pub completion_window: Option<String>,
    pub endpoint: String,
    pub output_file_id: Option<FileId>,
    pub error_file_id: Option<FileId>,
    pub created_by: String,
    pub expires_at: Option<DateTime<Utc>>,
    pub cancelling_at: Option<DateTime<Utc>>,
    pub errors: Option<Value>,
    pub total_requests: i64,
    pub pending_requests: i64,
    pub in_progress_requests: i64,
    pub completed_requests: i64,
    pub failed_requests: i64,
    pub canceled_requests: i64,
    pub requests_started_at: Option<DateTime<Utc>>,
    pub finalizing_at: Option<DateTime<Utc>>,
    pub completed_at: Option<DateTime<Utc>>,
    pub failed_at: Option<DateTime<Utc>>,
    pub cancelled_at: Option<DateTime<Utc>>,
    pub deleted_at: Option<DateTime<Utc>>,
    pub notification_sent_at: Option<DateTime<Utc>>,
    pub api_key_id: Option<Uuid>,
}

A batch represents one execution of all of a file’s templates.

Fields

id: BatchId

file_id: Option<FileId>

created_at: DateTime<Utc>

metadata: Option<Value>

Metadata key-value pairs (OpenAI allows up to 16 pairs)

service_tier: Option<String>

Explicit scheduling tier. Some("background") identifies a background batch; None retains completion-window-driven SLA semantics.

completion_window: Option<String>

Completion window (e.g., “24h”). None for background batches.

endpoint: String

The API endpoint to use for all requests (e.g., “/v1/chat/completions”)

output_file_id: Option<FileId>

File ID containing the successful results

error_file_id: Option<FileId>

File ID containing the error results

created_by: String

User who created this batch

expires_at: Option<DateTime<Utc>>

When the batch will expire (created_at + completion_window). None for background batches, which do not have a completion SLA.

cancelling_at: Option<DateTime<Utc>>

When batch cancellation was initiated

errors: Option<Value>

Batch-level errors (validation errors, system errors, etc.)

total_requests: i64

Status fields

pending_requests: i64

in_progress_requests: i64

completed_requests: i64

failed_requests: i64

canceled_requests: i64

requests_started_at: Option<DateTime<Utc>>

finalizing_at: Option<DateTime<Utc>>

Terminal state timestamps (set once when batch enters that state)

completed_at: Option<DateTime<Utc>>

failed_at: Option<DateTime<Utc>>

cancelled_at: Option<DateTime<Utc>>

deleted_at: Option<DateTime<Utc>>

When batch was soft-deleted. NULL means active.

notification_sent_at: Option<DateTime<Utc>>

When batch completion notification was sent. NULL means not yet notified.

api_key_id: Option<Uuid>

API key UUID that created this batch, for per-member attribution within orgs

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 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.