Struct OpenAiConfig 

pub struct OpenAiConfig { /* private fields */ }

OpenAI credentials and endpoint configuration.

let config = providers_kit::config::OpenAiConfig::new(
    providers_kit::config::ApiKey::new("sk-test")?,
);
let _ = config;

Implementations

impl OpenAiConfig

pub fn new(api_key: ApiKey) -> Self

Creates a configuration for the public OpenAI endpoint.

This only constructs configuration; provider operations perform network I/O.

Examples

use providers_kit::config::{ApiKey, OpenAiConfig};
let config = OpenAiConfig::new(ApiKey::new("example-key")?);
let _owned_configuration = config;

pub fn with_base_url(self, base_url: Url) -> Self

Replaces the API base URL.

This only constructs configuration; provider operations perform network I/O.

Examples

use providers_kit::config::{ApiKey, OpenAiConfig};
let config = OpenAiConfig::new(ApiKey::new("example-key")?);
let config = config.with_base_url("https://example.com/api".parse().unwrap());
let _owned_configuration = config;

pub fn with_organization( self, organization: impl Into<String>, ) -> Result<Self, KitError>

Sets the optional organization header.

Errors

Returns a configuration error for an empty or padded value, or one that cannot be represented as an HTTP header value.

Examples

use providers_kit::config::{ApiKey, OpenAiConfig};
let config = OpenAiConfig::new(ApiKey::new("example-key")?);
assert!(config.clone().with_organization(" padded ").is_err());
let _config = config.with_organization("team-1")?;

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

Sets the optional project header.

Errors

Returns a configuration error for an empty or padded value, or one that cannot be represented as an HTTP header value.

Examples

use providers_kit::config::{ApiKey, OpenAiConfig};
let config = OpenAiConfig::new(ApiKey::new("example-key")?);
assert!(config.clone().with_project(" padded ").is_err());
let _config = config.with_project("team-1")?;

Trait Implementations

impl Clone for OpenAiConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.