Struct ClientConfig 

pub struct ClientConfig {
    pub api_key: String,
    pub base_url: String,
    pub organization: Option<String>,
    pub project: Option<String>,
    pub timeout_secs: u64,
    pub max_retries: u32,
    pub default_headers: Option<HeaderMap>,
    pub default_query: Option<Vec<(String, String)>>,
    /* private fields */
}

Configuration for the OpenAI client.

Fields

api_key: String

base_url: String

organization: Option<String>

project: Option<String>

timeout_secs: u64

max_retries: u32

default_headers: Option<HeaderMap>

Default headers sent with every request.

default_query: Option<Vec<(String, String)>>

Default query parameters appended to every request URL.

Implementations

impl ClientConfig

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

Create a new config with the given API key.

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

Create config from the OPENAI_API_KEY environment variable.

pub fn base_url(self, url: impl Into<String>) -> Self

pub fn organization(self, org: impl Into<String>) -> Self

pub fn project(self, project: impl Into<String>) -> Self

pub fn timeout_secs(self, secs: u64) -> Self

pub fn max_retries(self, retries: u32) -> Self

pub fn default_headers(self, headers: HeaderMap) -> Self

Set default headers sent with every request.

pub fn default_query(self, query: Vec<(String, String)>) -> Self

Set default query parameters appended to every request URL.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for ClientConfig

fn base_url(&self) -> &str

Returns the base URL for the API.

fn api_key(&self) -> &str

Returns the API key.

fn build_request(&self, req: RequestBuilder) -> RequestBuilder

Hook to modify or add provider-specific headers and auth to a request.

fn organization(&self) -> Option<&str>

Returns the organization ID, if any.

fn project(&self) -> Option<&str>

Returns the project ID, if any.

fn timeout_secs(&self) -> u64

Returns the timeout in seconds.

fn max_retries(&self) -> u32

Returns the maximum number of retries.

fn default_headers(&self) -> Option<&HeaderMap>

Returns default headers to append to all requests.

fn default_query(&self) -> Option<&[(String, String)]>

Returns default query parameters to append to all requests.

fn initial_options(&self) -> RequestOptions

Build the initial RequestOptions from config-level defaults.

impl Debug for ClientConfig

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

Formats the value using the given formatter.