Struct llm_chain::chains::map_reduce::Chain

pub struct Chain<S: Step> { /* private fields */ }

The Chain struct represents a map-reduce chain, consisting of a map step and a reduce step.

The struct is generic over the type of the Step and provides methods for constructing and executing the chain using a given Executor.

Implementations

impl<S: Step> Chain<S>

pub fn new(map: S, reduce: S) -> Chain<S>

Constructs a new Chain with the given map and reduce steps.

The new function takes two instances of Step and returns a new Chain instance.

pub async fn run<E>( &self, documents: Vec<Parameters>, base_parameters: Parameters, executor: &E ) -> Result<E::Output, MapReduceChainError<E::Error>>where E: Executor<Step = S>,

Executes the map-reduce chain using the provided Executor.

The run function takes a vector of input documents, a base set of parameters, and a reference to an Executor. It processes the input documents using the map step and the reduce step, and returns the result as an Option<E::Output>.

The function is asynchronous and must be awaited.

Trait Implementations

impl<'de, S: Step + Deserialize<'de>> Deserialize<'de> for Chain<S>

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

Deserialize this value from the given Serde deserializer.

impl<S> StorableEntity for Chain<S>where S: Step + StorableEntity,

Implements the StorableEntity trait for the Chain struct.

This implementation provides a method for extracting metadata from a Chain instance, in order to identify it

fn get_metadata() -> Vec<(String, String)>

Returns metadata about the Chain instance.

The metadata is returned as a vector of tuples, where each tuple contains a key-value pair representing a metadata field and its value.

This method also extracts metadata from the Step instances associated with the Chain.