Struct ClientBuilder 

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

Implementations

impl<Ext, H> ClientBuilder<Ext, NeedsApiKey, 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

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

pub fn ext(&self) -> &Ext

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

where ExtBuilder: Clone + ProviderBuilder<Output = Ext, ApiKey = Key> + Default, Ext: Provider<Builder = ExtBuilder>, Key: ApiKey, H: Default,

pub fn build( self, ) -> Result<Client<<ExtBuilder as ProviderBuilder>::Output, 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<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>

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, NeedsApiKey, H>

where H: Default, ExtBuilder: ProviderBuilder + Default,

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

Returns the “default value” for a type.