Skip to main content

BatchClient

Struct BatchClient 

Source
pub struct BatchClient { /* private fields */ }
Expand description

Client for submitting, polling, and retrieving batch results.

Implementations§

Source§

impl BatchClient

Source

pub fn new(provider: BatchProvider, api_key: impl Into<String>) -> Self

Creates a new BatchClient for the given provider.

Source

pub fn with_base_url(self, url: impl Into<String>) -> Self

Overrides the base URL (useful for proxies or compatible endpoints).

Source

pub async fn submit( &self, requests: Vec<BatchRequest>, ) -> Result<BatchId, BatchError>

Submit a batch of requests. Returns the batch ID.

For OpenAI: uploads a JSONL file via the Files API, then creates a batch via POST /v1/batches referencing the uploaded file.

For Anthropic: creates a batch via POST /v1/messages/batches with the requests array inline.

Source

pub async fn poll(&self, id: &BatchId) -> Result<BatchStatus, BatchError>

Poll the status of a batch job.

Source

pub async fn results( &self, id: &BatchId, ) -> Result<Vec<BatchResult>, BatchError>

Retrieve results of a completed batch.

Source

pub async fn cancel(&self, id: &BatchId) -> Result<(), BatchError>

Cancel a batch job.

Source

pub async fn submit_and_wait( &self, requests: Vec<BatchRequest>, poll_interval_ms: u64, max_wait_ms: u64, ) -> Result<Vec<BatchResult>, BatchError>

Submit and wait until complete, then return results.

Polls every poll_interval_ms milliseconds. Returns BatchError::Timeout if max_wait_ms is exceeded.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more