pub struct Executor { /* private fields */ }
Expand description

The Executor struct for the ChatGPT model. This executor uses the async_openai crate to communicate with the OpenAI API.

Implementations§

source§

impl Executor

source

pub fn for_client( client: Client, per_invocation_options: Option<PerInvocation> ) -> Self

Creates a new Executor with the given client.

Trait Implementations§

source§

impl Clone for Executor

source§

fn clone(&self) -> Executor

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Default for Executor

source§

fn default() -> Executor

Returns the “default value” for a type. Read more
source§

impl Executor for Executor

source§

fn max_tokens_allowed(&self, step: &Step<Self>) -> i32

Get the context size from the model or return default context size

§

type PerInvocationOptions = PerInvocation

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

type PerExecutorOptions = PerExecutor

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.
§

type Output = Output

The output type produced by this executor.
§

type Token = usize

The token type used by this executor.
§

type StepTokenizer<'a> = OpenAITokenizer

§

type TextSplitter<'a> = OpenAITextSplitter

§

type Error = Error

The error type produced by this executor.
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. Read more
source§

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,

Executes the given input and returns the resulting output. Read more
source§

fn tokens_used( &self, step: &Step<Self>, parameters: &Parameters ) -> Result<TokenCount, PromptTokensError>

Calculates the number of tokens used by the step given a set of parameters. Read more
source§

fn get_tokenizer( &self, step: &Step<Self> ) -> Result<OpenAITokenizer, TokenizerError>

Creates a tokenizer, depending on the model used by step. Read more
source§

fn get_text_splitter( &self, step: &Step<Self> ) -> Result<Self::TextSplitter<'_>, Self::Error>

Creates a text splitter, depending on the model used by ‘step’ Read more
source§

fn new() -> Result<Self, ExecutorCreationError>

source§

fn new_with_default() -> Self

👎Deprecated since 0.7.0: Use new() instead, this call has an unsafe unwrap

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<E, O, T, N> ExecutorTokenCountExt<O, T, N> for Ewhere E: Executor<Output = O, Token = T>, T: Clone,

source§

fn split_to_fit( &self, step: &Step<Self>, doc: &Parameters, chunk_overlap: Option<usize> ) -> Result<Vec<Parameters, Global>, PromptTokensError>

Splits a Parameters object into multiple smaller Parameters objects that fit within the context window size supported by the given model. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more