Package com.hw.langchain.chains.combine.documents.stuff

Class StuffDocumentsChain

java.lang.Object

com.hw.langchain.chains.base.Chain

com.hw.langchain.chains.combine.documents.base.BaseCombineDocumentsChain

com.hw.langchain.chains.combine.documents.stuff.StuffDocumentsChain

public class StuffDocumentsChain
extends BaseCombineDocumentsChain

Chain that combines documents by stuffing into context.

Author:

HamaWhite

Field Summary

Fields inherited from class com.hw.langchain.chains.combine.documents.base.BaseCombineDocumentsChain

inputKey, outputKey

Fields inherited from class com.hw.langchain.chains.base.Chain

memory

Constructor Summary

Constructors

Constructor	Description
StuffDocumentsChain(LLMChain llmChain, BasePromptTemplate documentPrompt, String documentVariableName, String documentSeparator)
StuffDocumentsChain(LLMChain llmChain, String documentVariableName)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Flux<org.apache.commons.lang3.tuple.Pair<String,Map<String,String>>>	asyncCombineDocs(List<Document> docs, Map<String,Object> kwargs)	Combine documents into a single string async.
String	chainType()
org.apache.commons.lang3.tuple.Pair<String,Map<String,String>>	combineDocs(List<Document> docs, Map<String,Object> kwargs)	Stuff all documents into one prompt and pass to LLM.

Methods inherited from class com.hw.langchain.chains.combine.documents.base.BaseCombineDocumentsChain

asyncInnerCall, innerCall, inputKeys, outputKeys, promptLength

Methods inherited from class com.hw.langchain.chains.base.Chain

asyncCall, asyncCall, asyncRun, asyncRun, call, call, prepInputs, run, run

Methods inherited from class java.lang.Object

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

Constructor Details

StuffDocumentsChain

public StuffDocumentsChain(LLMChain llmChain,
 String documentVariableName)

StuffDocumentsChain

public StuffDocumentsChain(LLMChain llmChain,
 BasePromptTemplate documentPrompt,
 String documentVariableName,
 String documentSeparator)

Method Details

combineDocs

public org.apache.commons.lang3.tuple.Pair<String,Map<String,String>> combineDocs(List<Document> docs,
 Map<String,Object> kwargs)

Stuff all documents into one prompt and pass to LLM.

Specified by:

combineDocs in class BaseCombineDocumentsChain

asyncCombineDocs

public reactor.core.publisher.Flux<org.apache.commons.lang3.tuple.Pair<String,Map<String,String>>> asyncCombineDocs(List<Document> docs,
 Map<String,Object> kwargs)

Description copied from class: BaseCombineDocumentsChain

Combine documents into a single string async.

Specified by:

asyncCombineDocs in class BaseCombineDocumentsChain

chainType

public String chainType()

Specified by:

chainType in class Chain