Struct async_openai::Batches

source ·
pub struct Batches<'c, C: Config> { /* private fields */ }
Expand description

Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount.

Related guide: Batch

Implementations§

source§

impl<'c, C: Config> Batches<'c, C>

source

pub fn new(client: &'c Client<C>) -> Self

source

pub async fn create(&self, request: BatchRequest) -> Result<Batch, OpenAIError>

Creates and executes a batch from an uploaded file of requests

source

pub async fn list<Q>( &self, query: &Q ) -> Result<ListBatchesResponse, OpenAIError>
where Q: Serialize + ?Sized,

List your organization’s batches.

source

pub async fn retrieve(&self, batch_id: &str) -> Result<Batch, OpenAIError>

Retrieves a batch.

source

pub async fn cancel(&self, batch_id: &str) -> Result<Batch, OpenAIError>

Cancels an in-progress batch.

Auto Trait Implementations§

§

impl<'c, C> Freeze for Batches<'c, C>

§

impl<'c, C> !RefUnwindSafe for Batches<'c, C>

§

impl<'c, C> Send for Batches<'c, C>
where C: Sync,

§

impl<'c, C> Sync for Batches<'c, C>
where C: Sync,

§

impl<'c, C> Unpin for Batches<'c, C>

§

impl<'c, C> !UnwindSafe for Batches<'c, C>

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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

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

fn try_into<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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