Struct Client 

pub struct Client { /* private fields */ }

Asynchronous client for OpenAI-compatible APIs.

Construct with Client::new (environment variables) or Client::builder. Cloning is cheap (shared connection pool).

Implementations

impl Client

pub fn new() -> Result<Self, OpenAIError>

Build a client from environment variables (OPENAI_API_KEY, OPENAI_BASE_URL, OPENAI_ORG_ID, OPENAI_PROJECT_ID).

pub fn builder() -> ClientBuilder

Start configuring a client.

pub fn base_url(&self) -> &str

The resolved base URL (no trailing slash).

pub fn chat(&self) -> Chat

Chat endpoints: client.chat().completions().

pub fn embeddings(&self) -> Embeddings

The embeddings resource.

pub fn models(&self) -> Models

The models resource.

pub fn moderations(&self) -> Moderations

The moderations resource.

pub fn completions(&self) -> Completions

The legacy completions resource.

pub fn images(&self) -> Images

The images resource.

pub fn files(&self) -> Files

The files resource.

pub fn audio(&self) -> Audio

Audio endpoints (speech, transcriptions).

pub fn batches(&self) -> Batches

The batches resource.

pub fn uploads(&self) -> Uploads

The resumable uploads resource.

pub fn fine_tuning(&self) -> FineTuning

Fine-tuning endpoints: client.fine_tuning().jobs().

pub fn vector_stores(&self) -> VectorStores

The vector stores resource.

pub fn assistants(&self) -> Assistants

The assistants resource (beta v2): client.assistants().

pub fn threads(&self) -> Threads

The threads resource (beta v2): client.threads(), with nested .messages() and .runs().

pub async fn connect_realtime( &self, model: &str, ) -> Result<RealtimeSession, RealtimeError>

Open a realtime WebSocket session for model, using this client’s API key, base URL, and organization/project settings.

Azure realtime (deployment paths, api-version query, api-key header over WebSocket) is not supported; Azure-configured clients return an error.

impl Client

pub async fn get<T: DeserializeOwned>( &self, path: &str, query: &[(&str, &str)], ) -> Result<T, OpenAIError>

Escape hatch: GET an arbitrary API path with query parameters.

T may be serde_json::Value for untyped access.

pub async fn post<B: Serialize, T: DeserializeOwned>( &self, path: &str, body: &B, ) -> Result<T, OpenAIError>

Escape hatch: POST an arbitrary API path with a JSON body.

T may be serde_json::Value for untyped access.

pub async fn delete<T: DeserializeOwned>( &self, path: &str, ) -> Result<T, OpenAIError>

Escape hatch: DELETE an arbitrary API path.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate 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.