Struct StuffDocumentsChain 

pub struct StuffDocumentsChain { /* private fields */ }

StuffDocumentsChain

Stuffs all documents into a single prompt for LLM processing. Suitable when the total document content fits within the LLM context window.

Implementations

impl StuffDocumentsChain

pub fn new<L>(llm: L) -> Self

where L: BaseChatModel + Send + Sync + 'static, L::Error: Into<ProviderError>,

Create a new StuffDocumentsChain with the given LLM.

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

Set the prompt template.

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

Set the document variable name used in the prompt.

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

Set the input key.

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

Set the output key.

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

Set the chain name.

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

Set verbose mode.

pub fn with_max_doc_length(self, max: usize) -> Self

Set the maximum character count per document (documents are truncated if exceeded).

pub fn format_documents(&self, documents: &[Document]) -> String

Format document list into context text.

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

Build prompt.

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

Invoke with documents and input directly.

Trait Implementations

impl BaseChain for StuffDocumentsChain

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 StuffDocumentsChain — token by token output.

Stuffs all documents into a single prompt, then streams the LLM response token by token.

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 with config propagation.

0.22.0 audit fix (H-C3): thread the chain’s RunnableConfig into stream_chat (sampling overrides / cancellation token / callbacks) instead of passing None.

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 validate_inputs( &self, inputs: &HashMap<String, Value>, ) -> Result<(), ChainError>

Validate inputs.