Skip to main content

LLMClient

Struct LLMClient 

Source
pub struct LLMClient { /* private fields */ }
Expand description

LLM Client unified entry point

Wraps any BaseChatModel as Arc<dyn BaseChatModel<Error = ProviderError>>, providing zero-config auto-detection and explicit construction.

Implements Deref<Target = dyn BaseChatModel>, so you can call .chat() etc. directly.

Implementations§

Source§

impl LLMClient

Source

pub fn from_env() -> Result<Self, ProviderError>

Create LLM Client from environment variables (auto-detect)

Detection priority:

  1. OPENAI_API_KEY -> OpenAIChat
  2. ANTHROPIC_API_KEY -> AnthropicChat
  3. AZURE_OPENAI_API_KEY -> AzureOpenAIChat
  4. DEEPSEEK_API_KEY -> DeepSeekChat
  5. QWEN_API_KEY -> QwenChat
  6. MOONSHOT_API_KEY -> MoonshotChat
  7. ZHIPU_API_KEY -> ZhipuChat
  8. MISTRAL_API_KEY -> MistralChat
  9. COHERE_API_KEY -> CohereChat
  10. GEMINI_API_KEY (or GOOGLE_API_KEY) -> GeminiChat
  11. OLLAMA_BASE_URL -> OllamaChat
§Errors

Returns error if no known environment variable is set.

Source

pub fn openai(config: OpenAIConfig) -> Self

Create OpenAI Client

Source

pub fn anthropic(config: AnthropicConfig) -> Self

Create Anthropic Client

Source

pub fn ollama(config: OllamaConfig) -> Self

Create Ollama Client

Source

pub fn gemini(config: GeminiConfig) -> Self

Create Gemini Client

Source

pub fn deepseek(config: DeepSeekConfig) -> Self

Create DeepSeek Client

Source

pub fn qwen(config: QwenConfig) -> Self

Create Qwen Client

Source

pub fn moonshot(config: MoonshotConfig) -> Self

Create Moonshot Client

Source

pub fn zhipu(config: ZhipuConfig) -> Self

Create Zhipu Client

Source

pub fn mistral(config: MistralConfig) -> Self

Create Mistral Client

Source

pub fn azure(config: AzureOpenAIConfig) -> Self

Create Azure OpenAI Client

Source

pub fn cohere(config: CohereConfig) -> Self

Create Cohere Client

Source

pub fn from_llm<L>(llm: L) -> Self
where L: BaseChatModel + Send + Sync + 'static, L::Error: Into<ProviderError>,

Create Client from any BaseChatModel

Source

pub fn from_arc( llm: Arc<dyn BaseChatModel<Error = ProviderError> + Send + Sync>, ) -> Self

Create Client from Arc<dyn BaseChatModel>

Source

pub fn into_inner( self, ) -> Arc<dyn BaseChatModel<Error = ProviderError> + Send + Sync>

Get the inner Arc<dyn BaseChatModel>, can be passed directly to Agent

Source

pub fn inner( &self, ) -> &Arc<dyn BaseChatModel<Error = ProviderError> + Send + Sync>

Get inner reference

Trait Implementations§

Source§

impl BaseChatModel for LLMClient

Source§

fn chat<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, ProviderError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Chat with the model. Read more
Source§

fn stream_chat<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<StreamChunk, ProviderError>> + Send>>, ProviderError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stream chat with the model. Read more
Source§

fn bind_tools( &self, tools: Vec<ToolDefinition>, ) -> Option<Box<dyn BaseChatModel<Error = ProviderError> + Send + Sync>>

Bind tool definitions for function calling. Read more
Source§

fn chat_with_system<'life0, 'async_trait>( &'life0 self, system: String, messages: Vec<Message>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, Self::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: Sync + 'async_trait,

Chat with system prompt. Read more
Source§

impl BaseLanguageModel<Vec<Message>, LLMResult> for LLMClient

Source§

fn model_name(&self) -> &str

Returns the model name.
Source§

fn get_num_tokens(&self, text: &str) -> usize

Calculates token count for text. Read more
Source§

fn temperature(&self) -> Option<f32>

Returns the temperature parameter.
Source§

fn max_tokens(&self) -> Option<usize>

Returns the max tokens limit.
Source§

fn with_temperature(self, temp: f32) -> Self
where Self: Sized,

Sets the temperature parameter.
Source§

fn with_max_tokens(self, max: usize) -> Self
where Self: Sized,

Sets the max tokens limit.
Source§

impl Debug for LLMClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Deref for LLMClient

Source§

type Target = dyn BaseChatModel<Error = ProviderError> + Send + Sync

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl Runnable<Vec<Message>, LLMResult> for LLMClient

Source§

type Error = ProviderError

Error type.
Source§

fn invoke<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<LLMResult, ProviderError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Transforms single input to output. Read more
Source§

fn batch<'life0, 'async_trait>( &'life0 self, inputs: Vec<Vec<Message>>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<LLMResult>, ProviderError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Batch processing - transforms multiple inputs to outputs. Read more
Source§

fn stream<'life0, 'async_trait>( &'life0 self, input: Vec<Message>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<LLMResult, ProviderError>> + Send>>, ProviderError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Streaming output - for real-time responses (LLM, etc). Read more
Source§

fn batch_as_completed<'life0, 'async_trait>( &'life0 self, inputs: Vec<Input>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Vec<(usize, Output)>, Self::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Batch processing that returns results in completion order. Read more
Source§

fn transform<'life0, 'async_trait>( &'life0 self, input: Pin<Box<dyn Stream<Item = Result<Input, Self::Error>> + Send>>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Output, Self::Error>> + Send + 'life0>>, Self::Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, Self: 'async_trait,

Stream-to-stream transformation - the core of LCEL streaming. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<I, O, R> RunnableExt<I, O> for R
where I: Send + Sync + 'static, O: Send + Sync + 'static, R: Runnable<I, O> + 'static, <R as Runnable<I, O>>::Error: Into<LcelError>,

Source§

fn pipe<O2, R2>(self, other: R2) -> RunnableSequence<Input, O2>
where O2: Send + Sync + 'static, R2: Runnable<Output, O2> + Send + Sync + 'static, <R2 as Runnable<Output, O2>>::Error: Into<LcelError>,

Pipe the output of this runnable into another runnable. Read more
Source§

fn into_sequence(self) -> RunnableSequence<Input, Output>

Create a RunnableSequence from this runnable as a single step. Read more
Source§

fn with_fallbacks<R>( self, fallbacks: Vec<R>, ) -> RunnableWithFallbacks<Input, Output>
where Input: Clone, R: Runnable<Input, Output> + Send + Sync + 'static, <R as Runnable<Input, Output>>::Error: Into<LcelError>,

Add fallback runnables that are tried if this one fails. Read more
Source§

fn with_retry(self, retry_config: RetryConfig) -> RunnableRetry<Input, Output>
where Input: Clone,

Wrap this runnable with retry logic using exponential backoff. Read more
Source§

fn configurable_alternatives<K, R>( self, which: impl Into<String>, default_key: impl Into<String>, alternatives: Vec<(K, R)>, ) -> RunnableConfigurable<Input, Output>
where K: Into<String>, R: Runnable<Input, Output> + Send + Sync + 'static, <R as Runnable<Input, Output>>::Error: Into<LcelError>,

Route between a default runnable and named alternatives at invoke time. Read more
Source§

fn configurable_fields(self) -> RunnableConfigurableFields<Input, Output>

Override recognized config fields at invoke time from config.configurable (Python’s Runnable.configurable_fields). Read more
Source§

impl<M> StreamingStructuredOutputExt for M
where M: BaseChatModel,

Source§

fn stream_structured_output<'life0, 'life1, 'async_trait, T>( &'life0 self, schema: Value, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<T, StructuredOutputError>> + Send>>, StructuredOutputError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, T: DeserializeOwned + Serialize + Clone + PartialEq + Unpin + Send + Sync + 'static + 'async_trait, Self: Sync + 'async_trait,

Stream structured output from a chat model. Read more
Source§

impl<M> StructuredOutputExt for M
where M: BaseChatModel,

Source§

fn with_structured_output<'life0, 'life1, 'async_trait, T>( &'life0 self, schema: Value, prompt: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<T, StructuredOutputError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait + DeserializeOwned + Serialize + Send + Sync + 'static, Self: Sync + 'async_trait,

Call the LLM with a JSON schema and prompt, returning a parsed result of type T. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more