Enum BatchOperationError 

pub enum BatchOperationError {
    Request(Error),
    Submission {
        input_file_id: String,
        idempotency_key: String,
        source: Error,
    },
    WaitTimeout {
        batch_id: String,
        last_batch: Option<Box<Batch>>,
    },
    NotReady {
        batch: Box<Batch>,
    },
    ResultLine {
        file_id: String,
        line: usize,
        source: Error,
    },
}

Typed failures of the opt-in workflow helpers. Debug/Display omit documents, bodies and keys.

Variants

Request(Error)

Ordinary request/transport failure, with its original details explicitly available.

Submission

Upload succeeded but creation did not return a usable batch. Creation may have succeeded remotely. Resume using this file id and the same key; never automatically delete the uploaded input.

Fields

input_file_id: String

Uploaded file, usable with CreateBatchRequest::new.

idempotency_key: String

Reuse this key together with the same metadata and output retention.

source: Error

Original request failure.

WaitTimeout

The entire wait budget elapsed; no server cancellation was requested.

Fields

batch_id: String

Durable batch identifier.

last_batch: Option<Box<Batch>>

Last successfully observed state, when any retrieval finished.

NotReady

Results require a terminal batch. Inspect this state or explicitly call wait.

Fields

batch: Box<Batch>

Current batch, including counters and validation errors.

ResultLine

One downloaded JSONL record did not match the result contract.

Fields

file_id: String

File containing the malformed record.

line: usize

One-based physical line number.

source: Error

Parser or envelope validation failure.

Trait Implementations

impl Debug for BatchOperationError

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

Formats the value using the given formatter.

impl Display for BatchOperationError

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

Formats the value using the given formatter.

impl Error for BatchOperationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for BatchOperationError

fn from(value: Error) -> Self

Converts to this type from the input type.