Client

Struct Client 

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

Main client for interacting with the OpenAI API.

The client provides ergonomic methods for all OpenAI API endpoints, with built-in retry logic, rate limiting, and error handling.

§Example

let client = Client::new(Config::default())?;
// TODO: Add usage example once builders are implemented

Implementations§

Source§

impl Client

Source

pub fn new(config: Config) -> Result<Self>

Create a new client with the given configuration.

Source

pub fn from_env() -> Result<Self>

Create a new client with default configuration from environment variables.

Source

pub fn config(&self) -> &Config

Get a reference to the client configuration.

Source

pub fn http_client(&self) -> &HttpClient

Get a reference to the HTTP client.

Source§

impl Client

Source

pub fn chat(&self) -> ChatCompletionBuilder

Create a chat completion builder.

Source

pub fn chat_simple(&self, message: impl Into<String>) -> ChatCompletionBuilder

Create a chat completion with a simple user message.

Source

pub fn chat_with_system( &self, system: impl Into<String>, user: impl Into<String>, ) -> ChatCompletionBuilder

Create a chat completion with system and user messages.

Source§

impl Client

Source

pub fn responses(&self) -> ResponseBuilder

Create a responses builder for structured outputs.

Source§

impl Client

Source

pub fn assistants(&self) -> AssistantsClient<'_>

Get assistants client (placeholder).

Source

pub fn audio(&self) -> AudioClient<'_>

Get audio client (placeholder).

Source

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

Get embeddings client (placeholder).

Source

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

Get images client (placeholder).

Source

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

Get files client (placeholder).

Source

pub fn fine_tuning(&self) -> FineTuningClient<'_>

Get fine-tuning client (placeholder).

Source

pub fn batch(&self) -> BatchClient<'_>

Get batch client (placeholder).

Source

pub fn vector_stores(&self) -> VectorStoresClient<'_>

Get vector stores client (placeholder).

Source

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

Get moderations client (placeholder).

Source

pub fn threads(&self) -> ThreadsClient<'_>

Get threads client (placeholder).

Source

pub fn uploads(&self) -> UploadsClient<'_>

Get uploads client (placeholder).

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate 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 Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: 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: 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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,