Trait rig::completion::Prompt

source ·
pub trait Prompt: Send + Sync {
    // Required method
    fn prompt(
        &self,
        prompt: &str,
    ) -> impl Future<Output = Result<String, PromptError>> + Send;
}
Expand description

Trait defining a high-level LLM simple prompt interface (i.e.: prompt in, response out).

Required Methods§

source

fn prompt( &self, prompt: &str, ) -> impl Future<Output = Result<String, PromptError>> + Send

Send a simple prompt to the underlying completion model.

If the completion model’s response is a message, then it is returned as a string.

If the completion model’s response is a tool call, then the tool is called and the result is returned as a string.

If the tool does not exist, or the tool call fails, then an error is returned.

Object Safety§

This trait is not object safe.

Implementors§