Trait OpenaiEnvironment 

pub trait OpenaiEnvironment:
    Send
    + Sync
    + 'static {
    // Required methods
    fn api_key(&self) -> &Secret;
    fn organization_id(&self) -> Option<&str>;
    fn project_id(&self) -> Option<&str>;
    fn base_url(&self) -> &Url;
    fn realtime_base_url(&self) -> &Url;
    fn diagnostics_config(&self) -> Option<&DiagnosticsConfig>;
    fn headers(&self) -> Result<HeaderMap>;
    fn join_base_url(&self, path: &str) -> Result<Url>;
    fn join_realtime_base_url(&self, path: &str) -> Result<Url>;
}

A trait defining the interface for OpenAI environment configuration.

Required Methods

fn api_key(&self) -> &Secret

Returns the API key.

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

Returns the organization ID, if available.

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

Returns the project ID, if available.

fn base_url(&self) -> &Url

Returns the base URL for the OpenAI API.

fn realtime_base_url(&self) -> &Url

Returns the base URL for the OpenAI Realtime API.

fn diagnostics_config(&self) -> Option<&DiagnosticsConfig>

Returns the diagnostics configuration, if available.

fn headers(&self) -> Result<HeaderMap>

Returns the HTTP headers for the OpenAI API.

Errors

Returns OpenAIError::InvalidArgument if headers contain invalid values.

fn join_base_url(&self, path: &str) -> Result<Url>

Joins a path to the base URL.

Errors

Returns OpenAIError::Internal if URL joining fails.

fn join_realtime_base_url(&self, path: &str) -> Result<Url>

Joins a path to the realtime base URL.

Errors

Returns OpenAIError::Internal if URL joining fails.

Implementors

impl OpenaiEnvironment for OpenaiEnvironmentImpl