Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Build a Client. Start with Client::builder. Debug redacts the API key.

Implementations

impl ClientBuilder

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

Override the provider base URL. Blank/whitespace falls back to the provider default; a trailing / is trimmed.

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

Set the API key explicitly instead of reading it from the environment. Consulted by every keyed provider (Voyage, OpenAI, Gemini); ignored by keyless Ollama.

pub fn output_dimension(self, dim: usize) -> Self

Request a specific embedding width: Voyage output_dimension, OpenAI dimensions, Gemini outputDimensionality (Ollama is model-fixed and ignores it). Whatever the provider, every returned vector is validated against it, so a drift becomes an Error::DimMismatch rather than a silent schema desync.

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

Override the request timeout (default 120s).

pub fn max_batch(self, max_batch: usize) -> Self

Cap inputs per HTTP request; larger batches are split into sequential requests and their results concatenated in order. Unset sends every input in a single request. 0 is treated as 1.

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

Finish building. Installs the ring TLS provider, constructs the HTTP client, and - for a keyed provider - resolves the API key (erroring with Error::MissingApiKey if it is neither passed nor in the provider’s environment variable).

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.