rig::completion

Trait CompletionModel

Source 
pub trait CompletionModel:
    Clone
    + Send
    + Sync {
    type Response: Send + Sync;

    // Required method
    fn completion(
        &self,
        request: CompletionRequest,
    ) -> impl Future<Output = Result<CompletionResponse<Self::Response>, CompletionError>> + Send;

    // Provided method
    fn completion_request(&self, prompt: &str) -> CompletionRequestBuilder<Self> { ... }
}
Expand description

Trait defining a completion model that can be used to generate completion responses. This trait is meant to be implemented by the user to define a custom completion model, either from a third party provider (e.g.: OpenAI) or a local model.

Required Associated Types§

Source

type Response: Send + Sync

The raw response type returned by the underlying completion model.

Required Methods§

Source

fn completion( &self, request: CompletionRequest, ) -> impl Future<Output = Result<CompletionResponse<Self::Response>, CompletionError>> + Send

Generates a completion response for the given completion request.

Provided Methods§

Source

fn completion_request(&self, prompt: &str) -> CompletionRequestBuilder<Self>

Generates a completion request builder for the given prompt.

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.

Implementors§