Struct LLMBuilder 

pub struct LLMBuilder { /* private fields */ }

Builder for configuring and instantiating LLM providers.

Implementations

impl LLMBuilder

pub fn new() -> Self

Creates a new empty builder instance with default values.

pub fn backend(self, backend: LLMBackend) -> Self

Sets the backend provider to use.

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

Sets the API key for authentication.

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

Sets the base URL for API requests.

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

Sets the model identifier to use.

pub fn max_tokens(self, max_tokens: u32) -> Self

Sets the maximum number of tokens to generate.

pub fn temperature(self, temperature: f32) -> Self

Sets the temperature for controlling response randomness (0.0-1.0).

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

Sets the system prompt/context.

pub fn reasoning_effort(self, reasoning_effort: ReasoningEffort) -> Self

Sets the reasoning effort level.

pub fn reasoning(self, reasoning: bool) -> Self

Sets the reasoning flag.

pub fn reasoning_budget_tokens(self, reasoning_budget_tokens: u32) -> Self

Sets the reasoning budget tokens.

pub fn timeout_seconds(self, timeout_seconds: u64) -> Self

Sets the request timeout in seconds.

pub fn stream(self, _stream: bool) -> Self

No-op for compatibility (streaming handled by provider traits).

pub fn normalize_response(self, normalize_response: bool) -> Self

Sets whether to normalize responses.

pub fn top_p(self, top_p: f32) -> Self

Sets the top_p sampling parameter.

pub fn top_k(self, top_k: u32) -> Self

Sets the top_k sampling parameter.

impl LLMBuilder

pub fn validator<F>(self, f: F) -> Self

where F: Fn(&str) -> Result<(), String> + Send + Sync + 'static,

Adds a validator function for responses.

pub fn validator_attempts(self, attempts: usize) -> Self

Sets the number of validation attempts.

impl LLMBuilder

pub fn schema(self, schema: impl Into<StructuredOutputFormat>) -> Self

Sets the JSON schema for structured output.

pub fn function(self, function_builder: FunctionBuilder) -> Self

Adds a function tool to the builder.

pub fn enable_parallel_tool_use(self, enable: bool) -> Self

Enable parallel tool use.

pub fn tool_choice(self, choice: ToolChoice) -> Self

Set tool choice.

pub fn disable_tools(self) -> Self

Explicitly disable the use of tools, even if they are provided.

pub fn extra_body(self, extra_body: impl Serialize) -> Self

Set extra body JSON for compatible providers.

impl LLMBuilder

pub fn build(self) -> Result<Box<dyn LLMProvider>, LLMError>

impl LLMBuilder

pub fn memory(self, memory: impl MemoryProvider + 'static) -> Self

Sets a custom memory provider for conversation history.

pub fn sliding_memory(self, memory: SlidingWindowMemory) -> Self

Sets a sliding window memory provider.

pub fn sliding_window_memory(self, window_size: usize) -> Self

Sets up a sliding window memory with the specified window size.

pub fn sliding_window_with_strategy( self, window_size: usize, strategy: TrimStrategy, ) -> Self

Sets up a sliding window memory with specified trim strategy.

impl LLMBuilder

pub fn resilient(self, enable: bool) -> Self

Enable resilience retry/backoff wrapper.

pub fn resilient_attempts(self, attempts: usize) -> Self

Sets the number of retry attempts for resilience.

pub fn resilient_backoff(self, base_delay_ms: u64, max_delay_ms: u64) -> Self

Sets base and max backoff delays in milliseconds.

pub fn resilient_jitter(self, jitter: bool) -> Self

Sets jitter toggle for backoff.

impl LLMBuilder

pub fn openai_enable_web_search(self, enable: bool) -> Self

Enable web search for OpenAI-compatible providers.

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

Set the web search context size.

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

Set the web search user location type.

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

Set the web search user location approximate country.

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

Set the web search user location approximate city.

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

Set the web search user location approximate region.

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

👎Deprecated:

Renamed to xai_search_mode.

Backward compatible alias for xAI search mode.

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

Sets the search mode for search-enabled providers.

pub fn xai_search_source( self, source_type: impl Into<String>, excluded_websites: Option<Vec<String>>, ) -> Self

Adds a search source with optional excluded websites.

pub fn xai_max_search_results(self, max: u32) -> Self

Sets the maximum number of search results.

pub fn xai_search_date_range( self, from: impl Into<String>, to: impl Into<String>, ) -> Self

Sets the date range for search results.

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

Sets the start date for search results (format: “YYYY-MM-DD”).

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

Sets the end date for search results (format: “YYYY-MM-DD”).

impl LLMBuilder

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

Set the API version (Azure OpenAI).

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

Set the deployment id (Azure OpenAI).

impl LLMBuilder

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

Sets the encoding format for embedding outputs.

pub fn embedding_dimensions(self, embedding_dimensions: u32) -> Self

Sets the dimensions for embedding outputs.

impl LLMBuilder

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

Set the voice for TTS providers.

Trait Implementations

impl Default for LLMBuilder

fn default() -> Self

Returns the “default value” for a type.