Trait llm_chain::traits::Executor

source ·

pub trait Executor: Sized {
    type PerInvocationOptions: Options;
    type PerExecutorOptions: Options;
    type Output: Output;
    type Error: ExecutorError + Debug + Error + From<StepError>;
    type Token: Clone;
    type StepTokenizer<'a>: Tokenizer<Self::Token>
       where Self: 'a;
    type TextSplitter<'a>: TextSplitter<Self::Token>
       where Self: 'a;

    // Required methods
    fn new_with_options(
        executor_options: Option<Self::PerExecutorOptions>,
        invocation_options: Option<Self::PerInvocationOptions>
    ) -> Result<Self, ExecutorCreationError>;
    fn execute<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        step: &'life1 Step<Self>,
        parameters: &'life2 Parameters
    ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait;
    fn tokens_used(
        &self,
        step: &Step<Self>,
        parameters: &Parameters
    ) -> Result<TokenCount, PromptTokensError>;
    fn max_tokens_allowed(&self, step: &Step<Self>) -> i32;
    fn get_tokenizer(
        &self,
        step: &Step<Self>
    ) -> Result<Self::StepTokenizer<'_>, TokenizerError>;
    fn get_text_splitter(
        &self,
        step: &Step<Self>
    ) -> Result<Self::TextSplitter<'_>, Self::Error>;

    // Provided methods
    fn new() -> Result<Self, ExecutorCreationError> { ... }
    fn new_with_default() -> Self { ... }
}

Expand description

The Executor trait represents an executor that performs a single step in a chain. It takes a step, executes it, and returns the output.

Required Associated Types§

source

type PerInvocationOptions: Options

The per-invocation options type used by this executor. These are the options you can send to each step.

source

type PerExecutorOptions: Options

The per-executor options type used by this executor. These are the options you can send to the executor and can’t be set per step.

source

type Output: Output

The output type produced by this executor.

source

type Error: ExecutorError + Debug + Error + From<StepError>

The error type produced by this executor.

source

type Token: Clone

The token type used by this executor.

source

type StepTokenizer<'a>: Tokenizer<Self::Token> where Self: 'a

source

type TextSplitter<'a>: TextSplitter<Self::Token> where Self: 'a

Required Methods§

source

fn new_with_options( executor_options: Option<Self::PerExecutorOptions>, invocation_options: Option<Self::PerInvocationOptions> ) -> Result<Self, ExecutorCreationError>

Create a new executor with the given executor options and invocation options. If you don’t need to set any options, you can use the new method instead.