Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Client 的构建器。

Implementations

impl ClientBuilder

pub fn from_env() -> Self

从环境变量构建默认配置。

pub fn provider(self, provider: Provider) -> Self

设置 Provider。

pub fn http_client(self, client: Client) -> Self

注入一个自定义 reqwest::Client。

pub fn log_level(self, log_level: LogLevel) -> Self

设置 SDK 内部日志级别。

pub fn logger<L>(self, logger: L) -> Self

where L: Logger + 'static,

注入一个用户自定义日志器。

pub fn api_key<T>(self, api_key: T) -> Self

where T: Into<String>,

设置静态 API Key。

pub fn api_key_provider<F>(self, provider: F) -> Self

where F: Fn() -> Result<SecretString> + Send + Sync + 'static,

设置动态 API Key 回调。

pub fn api_key_async_provider<F, Fut>(self, provider: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<SecretString>> + Send + 'static,

设置异步 API Key 回调。

pub fn base_url<T>(self, base_url: T) -> Self

where T: Into<String>,

覆盖基础地址。

pub fn disable_proxy_for_local_base_url(self, disable: bool) -> Self

控制当 base_url 指向本机地址时，是否显式关闭系统代理。

该开关默认关闭。

pub fn azure_endpoint<T>(self, endpoint: T) -> Self

where T: Into<String>,

设置 Azure 资源级 endpoint。

该值应类似 https://example-resource.openai.azure.com， SDK 会在发送请求时自动补上 /openai。

pub fn azure_api_version<T>(self, api_version: T) -> Self

where T: Into<String>,

设置 Azure api-version。

pub fn azure_deployment<T>(self, deployment: T) -> Self

where T: Into<String>,

设置 Azure 默认 deployment。

pub fn azure_bearer_auth(self) -> Self

切换 Azure 为 Bearer Token 认证。

pub fn azure_ad_token<T>(self, token: T) -> Self

where T: Into<String>,

设置 Azure AD Bearer Token。

pub fn azure_ad_token_provider<F, Fut>(self, provider: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<SecretString>> + Send + 'static,

设置 Azure AD Bearer Token 异步提供器。

pub fn timeout(self, timeout: Duration) -> Self

覆盖默认超时时间。

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

覆盖默认最大重试次数。

pub fn default_header<T, U>(self, key: T, value: U) -> Self

where T: Into<String>, U: Into<String>,

添加默认请求头。

pub fn default_headers(self, headers: BTreeMap<String, String>) -> Self

批量设置默认请求头。

pub fn default_query<T, U>(self, key: T, value: U) -> Self

where T: Into<String>, U: Into<String>,

添加默认查询参数。

pub fn default_query_map(self, query: BTreeMap<String, String>) -> Self

批量设置默认查询参数。

pub fn webhook_secret<T>(self, secret: T) -> Self

where T: Into<String>,

设置 Webhook 密钥。

pub fn compatibility_mode(self, mode: CompatibilityMode) -> Self

设置兼容性模式。

pub fn build(self) -> Result<Client>

构建客户端。

Errors

当基础地址非法或底层 reqwest::Client 初始化失败时返回错误。

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.