Trait LanguageModel

pub trait LanguageModel:
    Sized
    + Send
    + Sync
    + 'static {
    type Error: Error + Send + Sync + 'static;

    // Required methods
    fn respond(&self, request: Request) -> impl TextStream<Error = Self::Error>;
    fn complete(&self, prefix: &str) -> impl TextStream<Error = Self::Error>;
    fn profile(&self) -> Profile;

    // Provided methods
    fn generate<T: JsonSchema + DeserializeOwned>(
        &self,
        request: Request,
    ) -> impl Future<Output = Result<T>> + Send { ... }
    fn summarize(&self, text: &str) -> impl TextStream<Error = Self::Error> { ... }
    fn categorize<T: JsonSchema + DeserializeOwned>(
        &self,
        text: &str,
    ) -> impl Future<Output = Result<T>> + Send { ... }
}

Language models for text generation and conversation.

See the module documentation for examples and usage patterns.

Required Associated Types

type Error: Error + Send + Sync + 'static

The error type returned by this language model.

Required Methods

fn respond(&self, request: Request) -> impl TextStream<Error = Self::Error>

Generates streaming response to conversation.

fn complete(&self, prefix: &str) -> impl TextStream<Error = Self::Error>

Completes given text prefix.

fn profile(&self) -> Profile

Returns model profile and capabilities.

See Profile for details on model metadata.

Provided Methods

fn generate<T: JsonSchema + DeserializeOwned>( &self, request: Request, ) -> impl Future<Output = Result<T>> + Send

Generates structured output conforming to JSON schema.

fn summarize(&self, text: &str) -> impl TextStream<Error = Self::Error>

Summarizes text.

fn categorize<T: JsonSchema + DeserializeOwned>( &self, text: &str, ) -> impl Future<Output = Result<T>> + Send

Categorizes text.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: LanguageModel> LanguageModel for Box<T>

type Error = <T as LanguageModel>::Error

fn respond(&self, request: Request) -> impl TextStream<Error = T::Error>

fn generate<U: JsonSchema + DeserializeOwned>( &self, request: Request, ) -> impl Future<Output = Result<U>> + Send

fn complete(&self, prefix: &str) -> impl TextStream<Error = T::Error>

fn summarize(&self, text: &str) -> impl TextStream<Error = T::Error>

fn categorize<U: JsonSchema + DeserializeOwned>( &self, text: &str, ) -> impl Future<Output = Result<U>> + Send

fn profile(&self) -> Profile

impl<T: LanguageModel> LanguageModel for Arc<T>

type Error = <T as LanguageModel>::Error

fn respond(&self, request: Request) -> impl TextStream<Error = T::Error>

fn generate<U: JsonSchema + DeserializeOwned>( &self, request: Request, ) -> impl Future<Output = Result<U>> + Send

fn complete(&self, prefix: &str) -> impl TextStream<Error = T::Error>

fn summarize(&self, text: &str) -> impl TextStream<Error = T::Error>

fn categorize<U: JsonSchema + DeserializeOwned>( &self, text: &str, ) -> impl Future<Output = Result<U>> + Send

fn profile(&self) -> Profile

Implementors