Struct Step

pub struct Step { /* private fields */ }

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

Implementations

impl Step

pub fn for_prompt_template(prompt: Data<StringTemplate>) -> Step

pub fn for_prompt_with_streaming(prompt: Data<StringTemplate>) -> Step

pub fn for_prompt_and_options( prompt: Data<StringTemplate>, options: Options, ) -> Step

pub fn prompt(&self) -> &Data<StringTemplate>

pub fn options(&self) -> &Options

pub fn to_chain(self) -> Chain

where Step: 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<Data<String>, StringTemplateError>

Formats the prompt for this step with the given parameters.

pub async fn run<E>( &self, parameters: &Parameters, executor: &E, ) -> Result<Output, FormatAndExecuteError>

where Step: Sized, E: Executor,

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 Clone for Step

fn clone(&self) -> Step

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Step

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Step

fn deserialize<__D>( __deserializer: __D, ) -> Result<Step, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Step

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.