Skip to main content

Provider

llmrust::providers

Trait Provider 

Source 
pub trait Provider: Send + Sync {
    // Required methods
    fn chat<'life0, 'life1, 'async_trait>(
        &'life0 self,
        req: &'life1 ChatRequest,
    ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn stream<'life0, 'life1, 'async_trait>(
        &'life0 self,
        req: &'life1 ChatRequest,
    ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'static, Result<StreamChunk>>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;

    // Provided method
    fn embed<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _req: &'life1 EmbeddingRequest,
    ) -> Pin<Box<dyn Future<Output = Result<EmbeddingResponse>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait { ... }
}
Expand description

The core trait that all LLM providers must implement.

Required Methods§

Source

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

Send a chat completion request and get the full response.

Source

fn stream<'life0, 'life1, 'async_trait>( &'life0 self, req: &'life1 ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<BoxStream<'static, Result<StreamChunk>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Send a streaming chat completion request.

Provided Methods§

Source

fn embed<'life0, 'life1, 'async_trait>( &'life0 self, _req: &'life1 EmbeddingRequest, ) -> Pin<Box<dyn Future<Output = Result<EmbeddingResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generate embeddings for one or more input strings.

Default returns LlmError::Unsupported. Providers that support embeddings must override this method.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§