Trait LlmClient

Source

pub trait LlmClient: Send + Sync {
    // Required methods
    fn complete<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        messages: &'life1 [Message],
        system: Option<&'life2 str>,
        tools: &'life3 [ToolDefinition],
    ) -> Pin<Box<dyn Future<Output = Result<LlmResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait;
    fn complete_streaming<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        messages: &'life1 [Message],
        system: Option<&'life2 str>,
        tools: &'life3 [ToolDefinition],
        cancel_token: CancellationToken,
    ) -> Pin<Box<dyn Future<Output = Result<Receiver<StreamEvent>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait;

    // Provided methods
    fn native_structured_support(&self) -> NativeStructuredSupport { ... }
    fn complete_structured<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
        &'life0 self,
        messages: &'life1 [Message],
        system: Option<&'life2 str>,
        tools: &'life3 [ToolDefinition],
        _directive: &'life4 StructuredDirective,
    ) -> Pin<Box<dyn Future<Output = Result<LlmResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait,
             'life4: 'async_trait { ... }
    fn complete_streaming_structured<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
        &'life0 self,
        messages: &'life1 [Message],
        system: Option<&'life2 str>,
        tools: &'life3 [ToolDefinition],
        _directive: &'life4 StructuredDirective,
        cancel_token: CancellationToken,
    ) -> Pin<Box<dyn Future<Output = Result<Receiver<StreamEvent>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait,
             'life4: 'async_trait { ... }
}

Expand description

LLM client trait

Required Methods§

Source

fn complete<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [Message], system: Option<&'life2 str>, tools: &'life3 [ToolDefinition], ) -> Pin<Box<dyn Future<Output = Result<LlmResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Complete a conversation (non-streaming)

Source

fn complete_streaming<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [Message], system: Option<&'life2 str>, tools: &'life3 [ToolDefinition], cancel_token: CancellationToken, ) -> Pin<Box<dyn Future<Output = Result<Receiver<StreamEvent>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Complete a conversation with streaming Returns a receiver for streaming events. The cancel_token is checked during the HTTP request; if cancelled, the request is aborted.

Provided Methods§

Source

fn native_structured_support(&self) -> NativeStructuredSupport

Report the strongest provider-native structured-output enforcement this client supports. Used by structured to decide whether to force a tool call, request a native response_format, or fall back to prompt-and-parse. Defaults to no native support.

Source

fn complete_structured<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, messages: &'life1 [Message], system: Option<&'life2 str>, tools: &'life3 [ToolDefinition], _directive: &'life4 StructuredDirective, ) -> Pin<Box<dyn Future<Output = Result<LlmResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Complete a conversation while honoring a structured-output directive (forced tool_choice and/or native response_format).

The default implementation ignores the directive and behaves exactly like LlmClient::complete, so existing clients keep working unchanged; providers that support native structured output override this.

Source