Struct Batch 

pub struct Batch {

    pub id: String,
    pub object: Option<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: u64,
    pub in_progress_at: Option<u64>,
    pub expires_at: Option<u64>,
    pub finalizing_at: Option<u64>,
    pub completed_at: Option<u64>,
    pub failed_at: Option<u64>,
    pub expired_at: Option<u64>,
    pub cancelling_at: Option<u64>,
    pub cancelled_at: Option<u64>,
    pub request_counts: Option<BatchRequestCounts>,
    pub metadata: Option<HashMap<String, String>>,
}

A batch processing job.

Fields

id: String

The batch ID, e.g. batch_....

object: Option<String>

The object type, always batch.

endpoint: String

The API endpoint the batch runs against, e.g. /v1/chat/completions.

errors: Option<BatchErrors>

Errors of the batch, if any.

input_file_id: String

The ID of the input JSONL file.

completion_window: String

The time window within which the batch should be processed, e.g. 24h.

status: BatchStatus

The current lifecycle status.

output_file_id: Option<String>

The ID of the output JSONL file, once the batch completes.

error_file_id: Option<String>

The ID of the JSONL file carrying the per-request errors, when some requests failed.

created_at: u64

Unix timestamp (seconds) of when the batch was created.

in_progress_at: Option<u64>

Unix timestamp (seconds) of when the batch started processing.

expires_at: Option<u64>

Unix timestamp (seconds) of when the batch expires if not completed.

finalizing_at: Option<u64>

Unix timestamp (seconds) of when the batch started finalizing.

completed_at: Option<u64>

Unix timestamp (seconds) of when the batch completed.

failed_at: Option<u64>

Unix timestamp (seconds) of when the batch failed.

expired_at: Option<u64>

Unix timestamp (seconds) of when the batch expired.

cancelling_at: Option<u64>

Unix timestamp (seconds) of when the batch started cancelling.

cancelled_at: Option<u64>

Unix timestamp (seconds) of when the batch was cancelled.

request_counts: Option<BatchRequestCounts>

Per-request result counts, once available.

metadata: Option<HashMap<String, String>>

Arbitrary key-value metadata attached to 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 FromStr for Batch

type Err = OapiError

The associated error which can be returned from parsing.

fn from_str(content: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.