Struct llm_chain::step::Step

pub struct Step<Executor>where
    Executor: Executor,{ /* private fields */ }

A step in a chain of LLM invocations. It is a combination of a prompt and a configuration.

Implementations

impl<Executor> Step<Executor>where Executor: Executor,

pub fn for_prompt_template(prompt: PromptTemplate) -> Self

pub fn for_prompt_with_streaming(prompt: PromptTemplate) -> Self

pub fn for_prompt_and_options( prompt: PromptTemplate, options: Executor::PerInvocationOptions ) -> Self

pub fn prompt(&self) -> &PromptTemplate

pub fn options(&self) -> Option<&Executor::PerInvocationOptions>

pub fn is_streaming(&self) -> Option<bool>

pub fn to_chain(self) -> Chain<Executor>where Self: Sized,

Converts this step into a sequential chain with a single step.

Returns

A sequential chain containing this step.

pub fn format( &self, parameters: &Parameters ) -> Result<Prompt, StringTemplateError>

Formats the prompt for this step with the given parameters.

pub async fn run( &self, parameters: &Parameters, executor: &Executor ) -> Result<Executor::Output, FormatAndExecuteError<Executor::Error>>where Self: Sized,

Executes the step with the given parameters and executor.

Arguments

• parameters - A Parameters object containing the input parameters for the step.
• executor - An executor to use to execute the step.

Returns

The output of the executor.

Trait Implementations

impl<Executor> Clone for Step<Executor>where Executor: Executor + Clone, Executor::PerInvocationOptions: Clone,

fn clone(&self) -> Step<Executor>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Executor> Debug for Step<Executor>where Executor: Executor + Debug, Executor::PerInvocationOptions: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, E: Executor> Deserialize<'de> for Step<E>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: Executor> Serialize for Step<E>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.