Struct Batches 

pub struct Batches<'a> { /* private fields */ }

Available on crate feature async only.

Namespace handle for the Batches API.

Implementations

impl<'a> Batches<'a>

pub async fn create(&self, requests: Vec<BatchRequest>) -> Result<MessageBatch>

Submit a batch of BatchRequest entries. Returns the initial MessageBatch status (typically processing_status: in_progress).

pub async fn get(&self, id: &str) -> Result<MessageBatch>

Fetch the current status of a batch by id.

pub async fn list( &self, params: ListBatchesParams, ) -> Result<Paginated<MessageBatch>>

Fetch one page of batches.

pub async fn list_all(&self) -> Result<Vec<MessageBatch>>

Fetch every batch, transparently paging.

pub async fn cancel(&self, id: &str) -> Result<MessageBatch>

Request cancellation of a batch. Already-running entries continue until they finish; the batch transitions to Canceling and then to Ended once those settle.

pub async fn delete(&self, id: &str) -> Result<BatchDeleted>

Delete a batch. Allowed only after the batch has ended.

pub async fn wait_for( &self, id: &str, options: WaitOptions, ) -> Result<MessageBatch>

Poll Self::get until the batch’s processing_status is ProcessingStatus::Ended (or any other terminal status the server reports). Returns the final MessageBatch.

Honors WaitOptions::poll_interval between calls and WaitOptions::timeout as an overall ceiling.

pub async fn results(&self, id: &str) -> Result<Vec<BatchResultItem>>

Fetch all batch results into a Vec. Convenience wrapper over Self::results_stream for callers that don’t need streaming.

pub async fn results_stream( &self, id: &str, ) -> Result<BoxStream<'static, Result<BatchResultItem>>>

Stream the JSONL results body line-by-line, decoding each line as a BatchResultItem. Returns immediately after the connection is established; consumes lazily as the caller polls the stream.

Mid-stream connection failures are surfaced as stream items; retries are not applied (consistent with the SSE streaming design – silent retry would drop content).