Struct LLMBuilder 

pub struct LLMBuilder { /* private fields */ }

re-export the llm types so downstream code can use the same structs/enums. Builder for configuring and instantiating LLM providers.

Provides a fluent interface for setting various configuration options like model selection, API keys, generation parameters, etc.

Implementations

impl LLMBuilder

pub fn new() -> LLMBuilder

Creates a new empty builder instance with default values.

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

Sets the backend provider to use.

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

Sets the API key for authentication.

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

Sets the base URL for API requests.

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

Sets the model identifier to use.

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

Sets the maximum number of tokens to generate.

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

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

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

Sets the system prompt/context.

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

Sets the reasoning flag.

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

Sets the reasoning flag.

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

Sets the reasoning budget tokens.

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

Sets the request timeout in seconds.

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

👎Deprecated: This method is deprecated and will be removed in a future release. Streaming is defined by the function used (e.g. chat_stream)

Enables or disables streaming responses, stub kept for compatibility.

Deprecation

This method is deprecated and will be removed in a future release. Streaming is defined by the function called (e.g. chat_stream).

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

Sets the top-p (nucleus) sampling parameter.

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

Sets the top-k sampling parameter.

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

Sets the encoding format for embeddings.

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

Sets the dimensions for embeddings.

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

Sets the JSON schema for structured output.

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

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

Sets a validation function to verify LLM responses.

Arguments

• f - Function that takes a response string and returns Ok(()) if valid, or Err with error message if invalid

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

Sets the number of retry attempts for validation failures.

Arguments

• attempts - Maximum number of times to retry generating a valid response

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

Adds a function tool to the builder

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

Enable parallel tool use

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

Set tool choice. Note that if the choice is given as Tool(name), and that tool isn’t available, the builder will fail.

pub fn disable_tools(self) -> LLMBuilder

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

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

Set the API version.

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

Set the deployment id. Used in Azure OpenAI.

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

Set the voice.

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

Enable web search

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

Set the web search context

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

Set the web search user location type

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

Set the web search user location approximate country

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

Set the web search user location approximate city

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

Set the web search user location approximate region

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

Enables or disables the resilience wrapper (retry/backoff).

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

Sets the maximum number of attempts for resilience (including the first try).

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

Sets the backoff bounds in milliseconds for resilience.

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

Enables or disables jitter for backoff delays.

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

👎Deprecated: Renamed to xai_search_mode.

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

Sets the search mode for search-enabled providers.

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

Adds a search source with optional excluded websites.

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

Sets the maximum number of search results.

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

Sets the date range for search results.

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

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

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

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

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

Sets a custom memory provider for storing conversation history.

Arguments

• memory - A boxed memory provider implementing the MemoryProvider trait

Examples

use llm::builder::{LLMBuilder, LLMBackend};
use llm::memory::SlidingWindowMemory;

let memory = SlidingWindowMemory::new(10);
let builder = LLMBuilder::new()
    .backend(LLMBackend::OpenAI)
    .memory(memory);

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

Sets a sliding window memory instance directly (convenience method).

Arguments

• memory - A SlidingWindowMemory instance

Examples

use llm::builder::{LLMBuilder, LLMBackend};
use llm::memory::SlidingWindowMemory;

let memory = SlidingWindowMemory::new(10);
let builder = LLMBuilder::new()
    .backend(LLMBackend::OpenAI)
    .sliding_memory(memory);

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

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

This is a convenience method for creating a SlidingWindowMemory instance.

Arguments

• window_size - Maximum number of messages to keep in memory

Examples

use llm::builder::{LLMBuilder, LLMBackend};

let builder = LLMBuilder::new()
    .backend(LLMBackend::OpenAI)
    .sliding_window_memory(5); // Keep last 5 messages

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

Sets up a sliding window memory with specified trim strategy.

Arguments

• window_size - Maximum number of messages to keep in memory
• strategy - How to handle overflow when window is full

Examples

use llm::builder::{LLMBuilder, LLMBackend};
use llm::memory::TrimStrategy;

let builder = LLMBuilder::new()
    .backend(LLMBackend::OpenAI)
    .sliding_window_with_strategy(5, TrimStrategy::Summarize);

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

Builds and returns a configured LLM provider instance.

Errors

Returns an error if:

• No backend is specified
• Required backend feature is not enabled
• Required configuration like API keys are missing

Trait Implementations

impl Default for LLMBuilder

fn default() -> LLMBuilder

Returns the “default value” for a type.