Struct RefineDocumentsChain 

pub struct RefineDocumentsChain<M: BaseChatModel> { /* private fields */ }

RefineDocumentsChain

Iteratively refines the answer document by document. Generates an initial answer from the first document, then refines with each subsequent document.

Implementations

impl<M: BaseChatModel> RefineDocumentsChain<M>

pub fn new(llm: M) -> Self

pub fn with_initial_prompt(self, template: impl Into<String>) -> Self

pub fn with_refine_prompt(self, template: impl Into<String>) -> Self

pub fn with_document_variable(self, name: impl Into<String>) -> Self

pub fn with_input_key(self, key: impl Into<String>) -> Self

pub fn with_output_key(self, key: impl Into<String>) -> Self

pub fn with_name(self, name: impl Into<String>) -> Self

pub fn with_verbose(self, verbose: bool) -> Self

pub fn build_initial_prompt(&self, context: &str, input: &str) -> String

pub fn build_refine_prompt( &self, context: &str, input: &str, existing_answer: &str, ) -> String

pub async fn invoke_with_documents( &self, documents: Vec<Document>, input: &str, ) -> Result<String, ChainError>

where <M as Runnable<Vec<Message>, LLMResult>>::Error: Display,

Invoke with documents and input directly (iterative refinement).

Trait Implementations

impl<M: BaseChatModel + Send + Sync + 'static> BaseChain for RefineDocumentsChain<M>

where <M as Runnable<Vec<Message>, LLMResult>>::Error: Display,

fn stream<'life0, 'async_trait>( &'life0 self, inputs: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<ChainStream, ChainError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stream execution for RefineDocumentsChain.

Runs the initial + all intermediate refine steps via invoke (since their output feeds the next step), then streams the final refine step token by token via stream_chat.

fn input_keys(&self) -> Vec<&str>

Get input keys.

fn output_keys(&self) -> Vec<&str>

Get output keys.

fn invoke<'life0, 'async_trait>( &'life0 self, inputs: HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<ChainResult, ChainError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the Chain.

fn name(&self) -> &str

Get Chain name.

fn invoke_with_config<'life0, 'async_trait>( &'life0 self, inputs: HashMap<String, Value>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<ChainResult, ChainError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Execute the Chain with a RunnableConfig.

fn stream_with_config<'life0, 'async_trait>( &'life0 self, inputs: HashMap<String, Value>, config: Option<RunnableConfig>, ) -> Pin<Box<dyn Future<Output = Result<ChainStream, ChainError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stream execute the Chain with a RunnableConfig.

fn validate_inputs( &self, inputs: &HashMap<String, Value>, ) -> Result<(), ChainError>

Validate inputs.