Struct async_openai::Client

pub struct Client { /* private fields */ }

Client is a container for api key, base url, organization id, and backoff configuration used to make API calls.

Implementations

impl Client

pub fn new() -> Self

Create client with default API_BASE url and default API key from OPENAI_API_KEY env var

pub fn with_api_key<S: Into<String>>(self, api_key: S) -> Self

To use a different API key different from default OPENAI_API_KEY env var

pub fn with_org_id<S: Into<String>>(self, org_id: S) -> Self

To use a different organization id other than default

pub fn with_api_base<S: Into<String>>(self, api_base: S) -> Self

To use a API base url different from default API_BASE

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

Exponential backoff for retrying rate limited requests. Form submissions are not retried.

pub fn api_base(&self) -> &str

pub fn api_key(&self) -> &str

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

To call Models group related APIs using this client.

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

To call Completions group related APIs using this client.

pub fn edits(&self) -> Edits<'_>

To call Edits group related APIs using this client.

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

To call Images group related APIs using this client.

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

To call Moderations group related APIs using this client.

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

To call Files group related APIs using this client.

pub fn fine_tunes(&self) -> FineTunes<'_>

To call FineTunes group related APIs using this client.

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

To call Embeddings group related APIs using this client.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Client

Returns the “default value” for a type.