llm_chain_openai::chatgpt

Struct Executor

Source
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<OpenAIConfig>, options: Options) -> 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() -> Self

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

impl Executor for Executor

Source§

fn new_with_options(options: Options) -> Result<Self, ExecutorCreationError>

Creates a new Executor with the given options.

if the OPENAI_ORG_ID environment variable is present, it will be used as the org_ig for the OpenAI client.

Source§

fn max_tokens_allowed(&self, opts: &Options) -> i32

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

Source§

type StepTokenizer<'a> = OpenAITokenizer

Source§

fn execute<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, options: &'life1 Options, prompt: &'life2 Prompt, ) -> Pin<Box<dyn Future<Output = Result<Output, ExecutorError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source§

fn tokens_used( &self, opts: &Options, prompt: &Prompt, ) -> Result<TokenCount, PromptTokensError>

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

fn answer_prefix(&self, _prompt: &Prompt) -> Option<String>

Returns a possible answer prefix inserted by the model, during a certain prompt mode Read more
Source§

fn get_tokenizer( &self, options: &Options, ) -> Result<OpenAITokenizer, TokenizerError>

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

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<E> ExecutorTokenCountExt for E
where E: Executor,

Source§

fn split_to_fit( &self, step: &Step, doc: &Parameters, base_parameters: &Parameters, chunk_overlap: Option<usize>, ) -> Result<Vec<Parameters>, 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 T
where 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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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

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

Source§

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

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

fn try_into<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<U, <U as TryFrom<T>>::Error>> + 'async_trait>>
where T: 'async_trait,

Performs the conversion.
Source§

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

Source§

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