Struct ClientBuilder 

pub struct ClientBuilder<Ext, ApiKey = Missing, H = Missing> { /* private fields */ }

Type-state builder for Client.

Each generic slot encodes a separate “has the user supplied this yet?” question:

• ApiKey = Missing means the caller has not yet called Self::api_key; transitioning to a concrete ApiKey type is required before Self::build is reachable.
• H = Missing means the caller has not yet called Self::http_client; in that state build() substitutes the canonical reqwest::Client backend at construction time. Once a backend has been supplied, H is the concrete HTTP client type and build() uses it directly.

Keeping Missing as the type-level placeholder (rather than reusing reqwest::Client) means the builder’s generics describe what the caller has actually provided, instead of pretending a default value is already present. It also avoids carrying an Option<H> whose None branch existed only to model the same “user hasn’t picked a backend” state.

Implementations

impl<Ext, H> ClientBuilder<Ext, Missing, H>

pub fn api_key<ApiKey>( self, api_key: impl Into<ApiKey>, ) -> ClientBuilder<Ext, ApiKey, H>

Set the API key for this client. This must be done before the build method can be called

impl<Ext, ApiKey, H> ClientBuilder<Ext, ApiKey, H>

where Ext: Clone,

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

where S: AsRef<str>,

Set the base URL for this client

pub fn http_client<U>(self, http_client: U) -> ClientBuilder<Ext, ApiKey, U>

Set the HTTP backend used in this client.

Calling this advances the builder’s H slot from whatever it was (typically Missing) to the supplied client’s type, which selects the H-generic Self::build impl below.

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

Set the HTTP headers used in this client

impl<Ext, Key, H> ClientBuilder<Ext, Key, H>

pub fn ext(&self) -> &Ext

Returns the provider extension builder state.

pub fn get_base_url(&self) -> &str

Returns the configured base URL.

impl<ExtBuilder, Key> ClientBuilder<ExtBuilder, Key, Missing>

where ExtBuilder: ProviderBuilder<ApiKey = Key>, Key: ApiKey,

Default-backend build: when the caller never called ClientBuilder::http_client, the builder’s H slot is still Missing, and we substitute the canonical reqwest::Client at build time. This is the only place in the crate that knows about that default, and it is disjoint by trait bound from the H-generic build below (Missing does not implement HttpClientExt).

pub fn build(self) -> Result<Client<ExtBuilder::Extension<Client>, Client>>

Build a client using the default reqwest::Client backend.

impl<ExtBuilder, Key, H> ClientBuilder<ExtBuilder, Key, H>

where ExtBuilder: ProviderBuilder<ApiKey = Key>, Key: ApiKey, H: HttpClientExt,

Concrete-backend build: the caller supplied an HTTP client via ClientBuilder::http_client, so H is a real HttpClientExt type and we use it directly.

pub fn build(self) -> Result<Client<ExtBuilder::Extension<H>, H>>

Build a client using the HTTP backend supplied with ClientBuilder::http_client.

impl<H> ClientBuilder<AnthropicBuilder, AnthropicKey, H>

Create a new anthropic client using the builder

Example

use rig_core::providers::anthropic::{Client, self};
use rig_core::providers::anthropic::completion::ANTHROPIC_VERSION_LATEST;

// Initialize the Anthropic client
let anthropic_client = Client::builder()
   .api_key("your-claude-api-key")
   .anthropic_version(ANTHROPIC_VERSION_LATEST)
   .anthropic_beta("prompt-caching-2024-07-31")
   .build()?;

pub fn anthropic_version(self, anthropic_version: &str) -> Self

pub fn anthropic_betas(self, anthropic_betas: &[&str]) -> Self

pub fn anthropic_beta(self, anthropic_beta: &str) -> Self

impl<H> ClientBuilder<AzureExtBuilder, AzureOpenAIAuth, H>

pub fn api_version(self, api_version: &str) -> Self

API version to use (e.g., “2024-10-21” for GA, “2024-10-01-preview” for preview)

impl<H> ClientBuilder<AzureExtBuilder, AzureOpenAIAuth, H>

pub fn azure_endpoint(self, endpoint: String) -> ClientBuilder<H>

Azure OpenAI endpoint URL, for example: https://{your-resource-name}.openai.azure.com

impl<H> ClientBuilder<ChatGPTBuilder, Missing, H>

pub fn oauth(self) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

impl<H> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

pub fn on_device_code<F>(self, handler: F) -> Self

where F: Fn(DeviceCodePrompt) + Send + Sync + 'static,

pub fn token_dir(self, path: impl AsRef<Path>) -> Self

pub fn auth_file(self, path: impl AsRef<Path>) -> Self

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

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

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

impl<H> ClientBuilder<CopilotBuilder, Missing, H>

pub fn github_access_token( self, access_token: impl Into<String>, ) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

pub fn oauth(self) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

impl<H> ClientBuilder<CopilotBuilder, CopilotAuth, H>

pub fn on_device_code<F>(self, handler: F) -> Self

where F: Fn(DeviceCodePrompt) + Send + Sync + 'static,

pub fn token_dir(self, path: impl AsRef<Path>) -> Self

pub fn access_token_file(self, path: impl AsRef<Path>) -> Self

pub fn api_key_file(self, path: impl AsRef<Path>) -> Self

impl<T> ClientBuilder<GaladrielBuilder, BearerAuth, T>

pub fn fine_tune_api_key<S>(self, fine_tune_api_key: S) -> Self

where S: AsRef<str>,

impl<H> ClientBuilder<HuggingFaceBuilder, BearerAuth, H>

pub fn subprovider(self, subprovider: SubProvider) -> Self

impl<H> ClientBuilder<MiniMaxBuilder, BearerAuth, H>

pub fn global(self) -> Self

pub fn china(self) -> Self

impl<H> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

pub fn global(self) -> Self

pub fn china(self) -> Self

pub fn anthropic_version(self, anthropic_version: &str) -> Self

pub fn anthropic_betas(self, anthropic_betas: &[&str]) -> Self

pub fn anthropic_beta(self, anthropic_beta: &str) -> Self

impl<H> ClientBuilder<MoonshotBuilder, BearerAuth, H>

pub fn global(self) -> Self

pub fn china(self) -> Self

impl<H> ClientBuilder<MoonshotAnthropicBuilder, AnthropicKey, H>

pub fn global(self) -> Self

pub fn anthropic_version(self, anthropic_version: &str) -> Self

pub fn anthropic_betas(self, anthropic_betas: &[&str]) -> Self

pub fn anthropic_beta(self, anthropic_beta: &str) -> Self

impl<H> ClientBuilder<XiaomiMimoAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_version(self, anthropic_version: &str) -> Self

pub fn anthropic_betas(self, anthropic_betas: &[&str]) -> Self

pub fn anthropic_beta(self, anthropic_beta: &str) -> Self

impl<H> ClientBuilder<ZAiBuilder, BearerAuth, H>

pub fn general(self) -> Self

pub fn coding(self) -> Self

impl<H> ClientBuilder<ZAiAnthropicBuilder, AnthropicKey, H>

pub fn general(self) -> Self

pub fn anthropic_version(self, anthropic_version: &str) -> Self

pub fn anthropic_betas(self, anthropic_betas: &[&str]) -> Self

pub fn anthropic_beta(self, anthropic_beta: &str) -> Self

Trait Implementations

impl<Ext: Clone, ApiKey: Clone, H: Clone> Clone for ClientBuilder<Ext, ApiKey, H>

fn clone(&self) -> ClientBuilder<Ext, ApiKey, H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ExtBuilder> Default for ClientBuilder<ExtBuilder, Missing, Missing>

where ExtBuilder: ProviderBuilder + Default,

fn default() -> Self

Returns the “default value” for a type.