Skip to main content

Model

serdes_ai

Trait Model 

Source 
pub trait Model: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn system(&self) -> &str;
    fn request<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        messages: &'life1 [ModelRequest],
        settings: &'life2 ModelSettings,
        params: &'life3 ModelRequestParameters,
    ) -> Pin<Box<dyn Future<Output = Result<ModelResponse, ModelError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait,
             Self: 'async_trait;
    fn request_stream<'life0, 'life1, 'life2, 'life3, 'async_trait>(
        &'life0 self,
        messages: &'life1 [ModelRequest],
        settings: &'life2 ModelSettings,
        params: &'life3 ModelRequestParameters,
    ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<ModelResponseStreamEvent, ModelError>> + Send>>, ModelError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait,
             'life3: 'async_trait,
             Self: 'async_trait;
    fn profile(&self) -> &ModelProfile;

    // Provided methods
    fn identifier(&self) -> String { ... }
    fn count_tokens<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _messages: &'life1 [ModelRequest],
    ) -> Pin<Box<dyn Future<Output = Result<u64, ModelError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait { ... }
    fn supports(&self, capability: ModelCapability) -> bool { ... }
}
Expand description

Core model trait.

This trait defines the interface for all language model implementations. It supports both synchronous requests and streaming.

Required Methods§

Source

fn name(&self) -> &str

Get the model name.

Source

fn system(&self) -> &str

Get the model system/provider (openai, anthropic, etc).

Source

fn request<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ModelRequest], settings: &'life2 ModelSettings, params: &'life3 ModelRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<ModelResponse, ModelError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Make a request to the model.

Source

fn request_stream<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [ModelRequest], settings: &'life2 ModelSettings, params: &'life3 ModelRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<ModelResponseStreamEvent, ModelError>> + Send>>, ModelError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: 'async_trait,

Make a streaming request to the model.

Returns a stream of response events. Implementations may fall back to non-streaming if streaming is not supported.

Source

fn profile(&self) -> &ModelProfile

Get the model profile (capabilities, schema transforms).

Provided Methods§

Source

fn identifier(&self) -> String

Get the full model identifier.

Source

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

Count tokens for messages (if supported).

Returns an error if token counting is not supported.

Source

fn supports(&self, capability: ModelCapability) -> bool

Check if the model supports a specific capability.

Implementors§