Trait ChatModel 

pub trait ChatModel: Send + Sync {
    // Required method
    fn chat<'life0, 'async_trait>(
        &'life0 self,
        request: ChatRequest,
    ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;

    // Provided methods
    fn profile(&self) -> Option<ModelProfile> { ... }
    fn stream_chat(
        &self,
        request: ChatRequest,
    ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>> { ... }
}

The core trait for language model providers. Implementations provide chat() for single responses and optionally stream_chat() for streaming.

Required Methods

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Provided Methods

fn profile(&self) -> Option<ModelProfile>

Return the model’s capability profile, if known.

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

Implementations on Foreign Types

impl ChatModel for BoundToolsChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, BoundToolsChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl ChatModel for RateLimitedChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, RateLimitedChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl ChatModel for RetryChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, RetryChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl ChatModel for ScriptedChatModel

fn chat<'life0, 'async_trait>( &'life0 self, _request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, ScriptedChatModel: 'async_trait,

impl ChatModel for TokenBucketChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, TokenBucketChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl ChatModel for AzureOpenAiChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, AzureOpenAiChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl ChatModel for OpenAiChatModel

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, OpenAiChatModel: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

impl<T> ChatModel for StructuredOutputChatModel<T>

where T: DeserializeOwned + Send + Sync + 'static,

fn chat<'life0, 'async_trait>( &'life0 self, request: ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse, SynapticError>> + Send + 'async_trait>>

where 'life0: 'async_trait, StructuredOutputChatModel<T>: 'async_trait,

fn stream_chat( &self, request: ChatRequest, ) -> Pin<Box<dyn Stream<Item = Result<AIMessageChunk, SynapticError>> + Send + '_>>

Implementors

impl ChatModel for PerplexityChatModel