Struct ClientBuilder 

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

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) -> ClientBuilder<Ext, ApiKey, H>

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

pub fn http_headers(self, headers: HeaderMap) -> ClientBuilder<Ext, ApiKey, H>

Set the HTTP headers used in this client

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

pub fn ext(&self) -> &Ext

pub fn get_base_url(&self) -> &str

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

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

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

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

Create a new anthropic client using the builder

Example

use rig::providers::anthropic::{ClientBuilder, self};

// Initialize the Anthropic client
let anthropic_client = ClientBuilder::new("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, ) -> ClientBuilder<AnthropicBuilder, AnthropicKey, H>

pub fn anthropic_betas( self, anthropic_betas: &[&str], ) -> ClientBuilder<AnthropicBuilder, AnthropicKey, H>

pub fn anthropic_beta( self, anthropic_beta: &str, ) -> ClientBuilder<AnthropicBuilder, AnthropicKey, H>

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

pub fn api_version( self, api_version: &str, ) -> ClientBuilder<AzureExtBuilder, AzureOpenAIAuth, H>

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<AzureExtBuilder, AzureOpenAIAuth, 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, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

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

pub fn token_dir( self, path: impl AsRef<Path>, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

pub fn auth_file( self, path: impl AsRef<Path>, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

pub fn default_instructions( self, instructions: impl Into<String>, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

pub fn originator( self, originator: impl Into<String>, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

pub fn user_agent( self, user_agent: impl Into<String>, ) -> ClientBuilder<ChatGPTBuilder, ChatGPTAuth, H>

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, ) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

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

pub fn token_dir( self, path: impl AsRef<Path>, ) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

pub fn access_token_file( self, path: impl AsRef<Path>, ) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

pub fn api_key_file( self, path: impl AsRef<Path>, ) -> ClientBuilder<CopilotBuilder, CopilotAuth, H>

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

pub fn fine_tune_api_key<S>( self, fine_tune_api_key: S, ) -> ClientBuilder<GaladrielBuilder, BearerAuth, T>

where S: AsRef<str>,

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

pub fn subprovider( self, subprovider: SubProvider, ) -> ClientBuilder<HuggingFaceBuilder, BearerAuth, H>

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

pub fn global(self) -> ClientBuilder<MiniMaxBuilder, BearerAuth, H>

pub fn china(self) -> ClientBuilder<MiniMaxBuilder, BearerAuth, H>

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

pub fn global(self) -> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

pub fn china(self) -> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_version( self, anthropic_version: &str, ) -> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_betas( self, anthropic_betas: &[&str], ) -> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_beta( self, anthropic_beta: &str, ) -> ClientBuilder<MiniMaxAnthropicBuilder, AnthropicKey, H>

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

pub fn global(self) -> ClientBuilder<MoonshotBuilder, BearerAuth, H>

pub fn china(self) -> ClientBuilder<MoonshotBuilder, BearerAuth, H>

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

pub fn global(self) -> ClientBuilder<MoonshotAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_version( self, anthropic_version: &str, ) -> ClientBuilder<MoonshotAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_betas( self, anthropic_betas: &[&str], ) -> ClientBuilder<MoonshotAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_beta( self, anthropic_beta: &str, ) -> ClientBuilder<MoonshotAnthropicBuilder, AnthropicKey, H>

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

pub fn anthropic_version( self, anthropic_version: &str, ) -> ClientBuilder<XiaomiMimoAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_betas( self, anthropic_betas: &[&str], ) -> ClientBuilder<XiaomiMimoAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_beta( self, anthropic_beta: &str, ) -> ClientBuilder<XiaomiMimoAnthropicBuilder, AnthropicKey, H>

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

pub fn general(self) -> ClientBuilder<ZAiBuilder, BearerAuth, H>

pub fn coding(self) -> ClientBuilder<ZAiBuilder, BearerAuth, H>

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

pub fn general(self) -> ClientBuilder<ZAiAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_version( self, anthropic_version: &str, ) -> ClientBuilder<ZAiAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_betas( self, anthropic_betas: &[&str], ) -> ClientBuilder<ZAiAnthropicBuilder, AnthropicKey, H>

pub fn anthropic_beta( self, anthropic_beta: &str, ) -> ClientBuilder<ZAiAnthropicBuilder, AnthropicKey, H>

Trait Implementations

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

where Ext: Clone, ApiKey: Clone, H: Clone,

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, H> Default for ClientBuilder<ExtBuilder, Missing, H>

where H: Default, ExtBuilder: ProviderBuilder + Default,

fn default() -> ClientBuilder<ExtBuilder, Missing, H>

Returns the “default value” for a type.