Struct OpenaiEnvironmentImpl 

#[non_exhaustive]
pub struct OpenaiEnvironmentImpl {
    pub api_key: Secret,
    pub base_url: Url,
    pub organization_id: Option<String>,
    pub project_id: Option<String>,
    pub realtime_base_url: Url,
    pub diagnostics_config: Option<DiagnosticsConfig>,
}

Concrete implementation of OpenaiEnvironment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

api_key: Secret

The API key for authentication.

base_url: Url

The base URL for the OpenAI API.

organization_id: Option<String>

The organization ID, if applicable.

project_id: Option<String>

The project ID, if applicable.

realtime_base_url: Url

The base URL for the OpenAI Realtime API.

diagnostics_config: Option<DiagnosticsConfig>

Optional diagnostics configuration.

Implementations

impl OpenaiEnvironmentImpl

pub fn build( api_key: Secret, organization_id: Option<String>, project_id: Option<String>, base_url: String, realtime_base_url: String, ) -> Result<Self>

Creates a new OpenaiEnvironmentImpl instance.

Arguments

• api_key: The API key for authentication.
• organization_id: Optional organization ID.
• project_id: Optional project ID.
• base_url: Base URL for the OpenAI API. Use OpenAIRecommended::base_url() for official OpenAI API.
• realtime_base_url: Base URL for the OpenAI Realtime API. Use OpenAIRecommended::realtime_base_url() for official OpenAI Realtime API.

Errors

Returns OpenAIError::InvalidArgument if any provided URL is invalid.

pub fn build_with_diagnostics( api_key: Secret, organization_id: Option<String>, project_id: Option<String>, base_url: String, realtime_base_url: String, diagnostics_config: Option<DiagnosticsConfig>, ) -> Result<Self>

Creates a new OpenaiEnvironmentImpl instance with diagnostics configuration.

Arguments

• api_key: The API key for authentication.
• organization_id: Optional organization ID.
• project_id: Optional project ID.
• base_url: Base URL for the OpenAI API. Use OpenAIRecommended::base_url() for official OpenAI API.
• realtime_base_url: Base URL for the OpenAI Realtime API. Use OpenAIRecommended::realtime_base_url() for official OpenAI Realtime API.
• diagnostics_config: Optional diagnostics configuration.

Errors

Returns OpenAIError::InvalidArgument if any provided URL is invalid.

Trait Implementations

impl Clone for OpenaiEnvironmentImpl

fn clone(&self) -> OpenaiEnvironmentImpl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenaiEnvironmentImpl

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

Formats the value using the given formatter.

impl EnvironmentInterface for OpenaiEnvironmentImpl

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.

impl OpenaiEnvironment for OpenaiEnvironmentImpl

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.

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

Joins a path to the base URL.

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

Joins a path to the realtime base URL.