Skip to main content

BaseChatModel

agent_io::llm

Trait BaseChatModel 

Source 
pub trait BaseChatModel: Send + Sync {
    // Required methods
    fn model(&self) -> &str;
    fn provider(&self) -> &str;
    fn invoke<'life0, 'async_trait>(
        &'life0 self,
        messages: Vec<Message>,
        tools: Option<Vec<ToolDefinition>>,
        tool_choice: Option<ToolChoice>,
    ) -> Pin<Box<dyn Future<Output = Result<ChatCompletion, LlmError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn invoke_stream<'life0, 'async_trait>(
        &'life0 self,
        messages: Vec<Message>,
        tools: Option<Vec<ToolDefinition>>,
        tool_choice: Option<ToolChoice>,
    ) -> Pin<Box<dyn Future<Output = Result<ChatStream, LlmError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

    // Provided methods
    fn context_window(&self) -> Option<u64> { ... }
    fn count_tokens<'life0, 'life1, 'async_trait>(
        &'life0 self,
        messages: &'life1 [Message],
    ) -> Pin<Box<dyn Future<Output = u64> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
    fn supports_tools(&self) -> bool { ... }
    fn supports_streaming(&self) -> bool { ... }
    fn supports_vision(&self) -> bool { ... }
}
Expand description

Base trait for chat model implementations

Required Methods§

Source

fn model(&self) -> &str

Get the model name

Source

fn provider(&self) -> &str

Get the provider name

Source

fn invoke<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, tools: Option<Vec<ToolDefinition>>, tool_choice: Option<ToolChoice>, ) -> Pin<Box<dyn Future<Output = Result<ChatCompletion, LlmError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Invoke the model with messages

Source

fn invoke_stream<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, tools: Option<Vec<ToolDefinition>>, tool_choice: Option<ToolChoice>, ) -> Pin<Box<dyn Future<Output = Result<ChatStream, LlmError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Invoke the model with streaming response

Provided Methods§

Source

fn context_window(&self) -> Option<u64>

Get the context window size (max input tokens)

Source

fn count_tokens<'life0, 'life1, 'async_trait>( &'life0 self, messages: &'life1 [Message], ) -> Pin<Box<dyn Future<Output = u64> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Count tokens in messages (approximate)

Source

fn supports_tools(&self) -> bool

Check if the model supports tools

Source

fn supports_streaming(&self) -> bool

Check if the model supports streaming

Source

fn supports_vision(&self) -> bool

Check if the model supports vision

Implementors§