Skip to main content

OpenAI

Struct OpenAI 

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

The main OpenAI client.

Implementations§

Source§

impl OpenAI

Source

pub fn new(api_key: impl Into<String>) -> Self

Create a new client with the given API key.

Source

pub fn with_config(config: ClientConfig) -> Self

Create a client from a full config.

Source

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

Create a client using the OPENAI_API_KEY environment variable.

Source

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

Access the Batches resource.

Source

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

Access the Uploads resource.

Source

pub fn beta(&self) -> Beta<'_>

Access the Beta resources (Assistants, Threads, Runs, Vector Stores).

Source

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

Access the Audio resource.

Source

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

Access the Chat resource.

Source

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

Access the Models resource.

Source

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

Access the Fine-tuning resource.

Source

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

Access the Files resource.

Source

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

Access the Images resource.

Source

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

Access the Moderations resource.

Source

pub fn responses(&self) -> Responses<'_>

Access the Responses resource.

Source

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

Access the Embeddings resource.

Trait Implementations§

Source§

impl Clone for OpenAI

Source§

fn clone(&self) -> OpenAI

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 OpenAI

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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