Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn builder(api_key: &str) -> ClientBuilder<'_>

Create a new OpenAI client builder.

Example

use rig::providers::openai::{ClientBuilder, self};

// Initialize the OpenAI client
let openai_client = Client::builder("your-open-ai-api-key")
   .build()

pub fn new(api_key: &str) -> Self

Create a new OpenAI client. For more control, use the builder method.

Panics

• If the reqwest client cannot be built (if the TLS backend cannot be initialized).

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 CompletionClient for Client

fn completion_model(&self, model: &str) -> ResponsesCompletionModel

Create a completion model with the given name.

Example

use rig::providers::openai::{Client, self};

// Initialize the OpenAI client
let openai = Client::new("your-open-ai-api-key");

let gpt4 = openai.completion_model(openai::GPT_4);

type CompletionModel = ResponsesCompletionModel

The type of CompletionModel used by the client.

fn agent(&self, model: &str) -> AgentBuilder<Self::CompletionModel>

Create an agent builder with the given completion model.

fn extractor<T: JsonSchema + for<'a> Deserialize<'a> + Serialize + Send + Sync>( &self, model: &str, ) -> ExtractorBuilder<T, Self::CompletionModel>

Create an extractor builder with the given completion model.

impl Debug for Client

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

Formats the value using the given formatter.

impl EmbeddingsClient for Client

type EmbeddingModel = EmbeddingModel

The type of EmbeddingModel used by the Client

fn embedding_model(&self, model: &str) -> Self::EmbeddingModel

Create an embedding model with the given name. Note: default embedding dimension of 0 will be used if model is not known. If this is the case, it’s better to use function embedding_model_with_ndims

fn embedding_model_with_ndims( &self, model: &str, ndims: usize, ) -> Self::EmbeddingModel

Create an embedding model with the given name and the number of dimensions in the embedding generated by the model.

fn embeddings<D: Embed>( &self, model: &str, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

Create an embedding builder with the given embedding model.

fn embeddings_with_ndims<D: Embed>( &self, model: &str, ndims: usize, ) -> EmbeddingsBuilder<Self::EmbeddingModel, D>

Create an embedding builder with the given name and the number of dimensions in the embedding generated by the model.

impl ProviderClient for Client

fn from_env() -> Self

Create a new OpenAI client from the OPENAI_API_KEY environment variable. Panics if the environment variable is not set.

fn from_val(input: ProviderValue) -> Self

fn boxed(self) -> Box<dyn ProviderClient>

where Self: Sized + 'static,

A helper method to box the client.

fn from_env_boxed<'a>() -> Box<dyn ProviderClient + 'a>

where Self: Sized + 'a,

Create a boxed client from the process’s environment. Panics if an environment is improperly configured.

fn from_val_boxed<'a>(input: ProviderValue) -> Box<dyn ProviderClient + 'a>

where Self: Sized + 'a,

Create a boxed client from the process’s environment. Panics if an environment is improperly configured.

impl TranscriptionClient for Client

fn transcription_model(&self, model: &str) -> TranscriptionModel

Create a transcription model with the given name.

Example

use rig::providers::openai::{Client, self};

// Initialize the OpenAI client
let openai = Client::new("your-open-ai-api-key");

let gpt4 = openai.transcription_model(openai::WHISPER_1);

type TranscriptionModel = TranscriptionModel

The type of TranscriptionModel used by the Client