Struct DynClientBuilder 

pub struct DynClientBuilder { /* private fields */ }

A dynamic client builder. Use this when you need to support creating any kind of client from a range of LLM providers (that Rig supports). Usage:

use rig::{
    client::builder::DynClientBuilder, completion::Prompt, providers::anthropic::CLAUDE_3_7_SONNET,
};
#[tokio::main]
async fn main() {
    let multi_client = DynClientBuilder::new();
    // set up OpenAI client
    let completion_openai = multi_client.agent("openai", "gpt-4o").unwrap();
    let agent_openai = completion_openai
        .preamble("You are a helpful assistant")
        .build();
    // set up Anthropic client
    let completion_anthropic = multi_client.agent("anthropic", CLAUDE_3_7_SONNET).unwrap();
    let agent_anthropic = completion_anthropic
        .preamble("You are a helpful assistant")
        .max_tokens(1024)
        .build();
    println!("Sending prompt: 'Hello world!'");
    let res_openai = agent_openai.prompt("Hello world!").await.unwrap();
    println!("Response from OpenAI (using gpt-4o): {res_openai}");
    let res_anthropic = agent_anthropic.prompt("Hello world!").await.unwrap();
    println!("Response from Anthropic (using Claude 3.7 Sonnet): {res_anthropic}");
}

Implementations

impl DynClientBuilder

pub fn image_generation<'a>( &self, provider: &str, model: &str, ) -> Result<BoxImageGenerationModel<'a>, ClientBuildError>

Available on crate feature image only.

impl DynClientBuilder

pub fn audio_generation<'a>( &self, provider: &str, model: &str, ) -> Result<BoxAudioGenerationModel<'a>, ClientBuildError>

Available on crate feature audio only.

impl<'a> DynClientBuilder

pub fn new() -> Self

Generate a new instance of DynClientBuilder. By default, every single possible client that can be registered will be registered to the client builder.

pub fn empty() -> Self

Generate a new instance of DynClientBuilder with no client factories registered.

pub fn register(self, client_factory: ClientFactory) -> Self

Register a new ClientFactory

pub fn register_all( self, factories: impl IntoIterator<Item = ClientFactory>, ) -> Self

Register multiple ClientFactories

pub fn build( &self, provider: &str, ) -> Result<Box<dyn ProviderClient>, ClientBuildError>

Returns a (boxed) specific provider based on the given provider.

pub fn build_val( &self, provider: &str, provider_value: ProviderValue, ) -> Result<Box<dyn ProviderClient>, ClientBuildError>

Returns a (boxed) specific provider based on the given provider.

pub fn parse(&self, id: &'a str) -> Result<(&'a str, &'a str), ClientBuildError>

Parses a provider:model string to the provider and the model separately. For example, openai:gpt-4o will return (“openai”, “gpt-4o”).

pub fn completion( &self, provider: &str, model: &str, ) -> Result<BoxCompletionModel<'a>, ClientBuildError>

Get a boxed completion model based on the provider and model.

pub fn agent( &self, provider: &str, model: &str, ) -> Result<BoxAgentBuilder<'a>, ClientBuildError>

Get a boxed agent based on the provider and model..

pub fn agent_with_api_key_val<P>( &self, provider: &str, model: &str, provider_value: P, ) -> Result<BoxAgentBuilder<'a>, ClientBuildError>

where P: Into<ProviderValue>,

Get a boxed agent based on the provider and model, as well as an API key.

pub fn embeddings( &self, provider: &str, model: &str, ) -> Result<Box<dyn EmbeddingModelDyn + 'a>, ClientBuildError>

Get a boxed embedding model based on the provider and model.

pub fn embeddings_with_api_key_val<P>( &self, provider: &str, model: &str, provider_value: P, ) -> Result<Box<dyn EmbeddingModelDyn + 'a>, ClientBuildError>

where P: Into<ProviderValue>,

Get a boxed embedding model based on the provider and model.

pub fn transcription( &self, provider: &str, model: &str, ) -> Result<Box<dyn TranscriptionModelDyn + 'a>, ClientBuildError>

Get a boxed transcription model based on the provider and model.

pub fn transcription_with_api_key_val<P>( &self, provider: &str, model: &str, provider_value: P, ) -> Result<Box<dyn TranscriptionModelDyn + 'a>, ClientBuildError>

where P: Into<ProviderValue>,

Get a boxed transcription model based on the provider and model.

pub fn id<'id>( &'a self, id: &'id str, ) -> Result<ProviderModelId<'a, 'id>, ClientBuildError>

Get the ID of a provider model based on a provider:model ID.

pub async fn stream_completion( &self, provider: &str, model: &str, request: CompletionRequest, ) -> Result<StreamingCompletionResponse<()>, ClientBuildError>

Stream a completion request to the specified provider and model.

Arguments

• provider - The name of the provider (e.g., “openai”, “anthropic”)
• model - The name of the model (e.g., “gpt-4o”, “claude-3-sonnet”)
• request - The completion request containing prompt, parameters, etc.

Returns

A future that resolves to a streaming completion response

pub async fn stream_prompt( &self, provider: &str, model: &str, prompt: impl Into<Message> + Send, ) -> Result<StreamingCompletionResponse<()>, ClientBuildError>

Stream a simple prompt to the specified provider and model.

Arguments

• provider - The name of the provider (e.g., “openai”, “anthropic”)
• model - The name of the model (e.g., “gpt-4o”, “claude-3-sonnet”)
• prompt - The prompt to send to the model

Returns

A future that resolves to a streaming completion response

pub async fn stream_chat( &self, provider: &str, model: &str, prompt: impl Into<Message> + Send, chat_history: Vec<Message>, ) -> Result<StreamingCompletionResponse<()>, ClientBuildError>

Stream a chat with history to the specified provider and model.

Arguments

• provider - The name of the provider (e.g., “openai”, “anthropic”)
• model - The name of the model (e.g., “gpt-4o”, “claude-3-sonnet”)
• prompt - The new prompt to send to the model
• chat_history - The chat history to include with the request

Returns

A future that resolves to a streaming completion response

Trait Implementations

impl Default for DynClientBuilder

fn default() -> Self

Returns the “default value” for a type.