Package com.github.hakenadu.javalangchains.chains.retrieval

Class CombineDocumentsChain

java.lang.Object

com.github.hakenadu.javalangchains.chains.retrieval.CombineDocumentsChain

All Implemented Interfaces:

Chain<Stream<Map<String,String>>,Map<String,String>>

public class CombineDocumentsChain
extends Object
implements Chain<Stream<Map<String,String>>,Map<String,String>>

This Chain is used to combine multiple retrieved documents into one prompt which can then be used to target a LLM in subsequent steps.

Field Summary

Fields inherited from interface com.github.hakenadu.javalangchains.chains.Chain

LOGGER

Constructor Summary

Constructors

Constructor	Description
CombineDocumentsChain()	creates an instance of the CombineDocumentsChain
CombineDocumentsChain(String documentPromptTemplate)	creates an instance of the CombineDocumentsChain

Method Summary

Modifier and Type	Method	Description
Map<String,String>	run(Stream<Map<String,String>> input)	Execute this Chain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.hakenadu.javalangchains.chains.Chain

chain

Constructor Details

CombineDocumentsChain

public CombineDocumentsChain(String documentPromptTemplate)

creates an instance of the CombineDocumentsChain

Parameters:

documentPromptTemplate - documentPromptTemplate

CombineDocumentsChain

public CombineDocumentsChain()

creates an instance of the CombineDocumentsChain

Method Details

run

public Map<String,String> run(Stream<Map<String,String>> input)

Description copied from interface: Chain

Execute this Chain

Specified by:

run in interface Chain<Stream<Map<String,String>>,Map<String,String>>

Parameters:

input - this chain's input

Returns:

this chain's output