Struct OpenAI 

pub struct OpenAI { /* private fields */ }

Root async-first SDK client scaffold.

Implementations

impl OpenAI

pub fn new() -> Self

Creates a client with default scaffold configuration.

pub fn builder() -> OpenAIBuilder

Starts building a client configuration.

pub fn config(&self) -> &ClientConfig

Returns the current client configuration scaffold.

pub fn resolved_config(&self) -> Result<ResolvedClientConfig, OpenAIError>

Resolves the current configuration against environment defaults.

pub fn prepare_request( &self, method: impl AsRef<str>, path: impl AsRef<str>, ) -> Result<PreparedRequest, OpenAIError>

Prepares an authenticated REST request before any transport is attempted.

pub fn resolve_request_options( &self, options: &RequestOptions, ) -> Result<ResolvedRequestOptions, OpenAIError>

Resolves per-request execution options against client defaults.

pub fn execute_json<T>( &self, method: impl AsRef<str>, path: impl AsRef<str>, options: RequestOptions, ) -> Result<ApiResponse<T>, OpenAIError>

where T: DeserializeOwned,

Executes a JSON request through the shared transport path.

pub fn responses(&self) -> &Responses

Accesses the responses family handle.

pub fn conversations(&self) -> &Conversations

Accesses the conversations family handle.

pub fn chat(&self) -> &Chat

Accesses the chat completions compatibility handle.

pub fn completions(&self) -> &Completions

Accesses the legacy completions compatibility handle.

pub fn embeddings(&self) -> &Embeddings

Accesses the embeddings family handle.

pub fn models(&self) -> &Models

Accesses the models family handle.

pub fn moderations(&self) -> &Moderations

Accesses the moderations family handle.

pub fn images(&self) -> &Images

Accesses the images family handle.

pub fn audio(&self) -> &Audio

Accesses the audio family handle.

pub fn files(&self) -> &Files

Accesses the files family handle.

pub fn uploads(&self) -> &Uploads

Accesses the uploads family handle.

pub fn vector_stores(&self) -> &VectorStores

Accesses the vector stores family handle.

pub fn batches(&self) -> &Batches

Accesses the batches family handle.

pub fn webhooks(&self) -> &Webhooks

Accesses the webhook helpers handle.

pub fn fine_tuning(&self) -> &FineTuning

Accesses the fine-tuning family handle.

pub fn evals(&self) -> &Evals

Accesses the evals family handle.

pub fn containers(&self) -> &Containers

Accesses the containers family handle.

pub fn skills(&self) -> &Skills

Accesses the skills family handle.

pub fn videos(&self) -> &Videos

Accesses the videos family handle.

pub fn realtime(&self) -> &Realtime

Accesses realtime support scaffolding.

Trait Implementations

impl Clone for OpenAI

fn clone(&self) -> OpenAI

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAI

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

Formats the value using the given formatter.

impl Default for OpenAI

fn default() -> Self

Returns the “default value” for a type.