Struct async_openai::Client

source ·
pub struct Client<C: Config> { /* private fields */ }
Expand description

Client is a container for config, backoff and http_client used to make API calls.

Implementations§

source§

impl Client<OpenAIConfig>

source

pub fn new() -> Self

Client with default OpenAIConfig

source§

impl<C: Config> Client<C>

source

pub fn build( http_client: Client, config: C, backoff: ExponentialBackoff ) -> Self

Create client with a custom HTTP client, OpenAI config, and backoff.

source

pub fn with_config(config: C) -> Self

source

pub fn with_http_client(self, http_client: Client) -> Self

Provide your own client to make HTTP requests with.

source

pub fn with_backoff(self, backoff: ExponentialBackoff) -> Self

Exponential backoff for retrying rate limited requests.

source

pub fn models(&self) -> Models<'_, C>

To call Models group related APIs using this client.

source

pub fn completions(&self) -> Completions<'_, C>

To call Completions group related APIs using this client.

source

pub fn chat(&self) -> Chat<'_, C>

To call Chat group related APIs using this client.

source

pub fn images(&self) -> Images<'_, C>

To call Images group related APIs using this client.

source

pub fn moderations(&self) -> Moderations<'_, C>

To call Moderations group related APIs using this client.

source

pub fn files(&self) -> Files<'_, C>

To call Files group related APIs using this client.

source

pub fn fine_tuning(&self) -> FineTuning<'_, C>

To call FineTuning group related APIs using this client.

source

pub fn embeddings(&self) -> Embeddings<'_, C>

To call Embeddings group related APIs using this client.

source

pub fn audio(&self) -> Audio<'_, C>

To call Audio group related APIs using this client.

source

pub fn assistants(&self) -> Assistants<'_, C>

To call Assistants group related APIs using this client.

source

pub fn threads(&self) -> Threads<'_, C>

To call Threads group related APIs using this client.

source

pub fn vector_stores(&self) -> VectorStores<'_, C>

To call VectorStores group related APIs using this client.

source

pub fn batches(&self) -> Batches<'_, C>

To call Batches group related APIs using this client.

source

pub fn config(&self) -> &C

Trait Implementations§

source§

impl<C: Clone + Config> Clone for Client<C>

source§

fn clone(&self) -> Client<C>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<C: Debug + Config> Debug for Client<C>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<C> Freeze for Client<C>
where C: Freeze,

§

impl<C> !RefUnwindSafe for Client<C>

§

impl<C> Send for Client<C>
where C: Send,

§

impl<C> Sync for Client<C>
where C: Sync,

§

impl<C> Unpin for Client<C>
where C: Unpin,

§

impl<C> !UnwindSafe for Client<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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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