StuffDocumentsQAChain class

Stuffs documents with a question answering prompt.

Inheritance

Constructors

StuffDocumentsQAChain.new({BasePromptTemplate? prompt, required BaseLanguageModel<Object, LanguageModelOptions, LanguageModelResult<Object>> llm, String inputKey = StuffDocumentsChain.defaultInputKey, String outputKey = StuffDocumentsChain.defaultOutputKey, BasePromptTemplate documentPrompt = StuffDocumentsChain.defaultDocumentPrompt, String documentSeparator = StuffDocumentsChain.defaultDocumentSeparator})
Stuffs documents with a question answering prompt.

Properties

chainType → String
Return the string type key uniquely identifying this class of chain.
no setterinherited
defaultOptions → ChainOptions
The default options to use when invoking the Runnable.
finalinherited
documentPrompt → BasePromptTemplate
Prompt to use to format each document.
finalinherited
documentSeparator → String
The string with which to join the formatted documents.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
inputKey → String
Key to use for input documents.
finalinherited
inputKeys → Set<String>
Input keys for this chain.
no setterinherited
llmChain → LLMChain<BaseLanguageModel<Object, LanguageModelOptions, LanguageModelResult<Object>>, LanguageModelOptions, BaseMemory>
LLM wrapper to use after formatting documents.
finalinherited
llmChainStuffedDocumentPromptVar ↔ String
The variable name in the LLMChain.prompt where to put the documents in. If only one variable in the llmChain, this doesn't need to be provided.
getter/setter pairinherited
memory → BaseMemory?
Memory to use for this chain.
finalinherited
outputKey → String
Key to use for output text.
finalinherited
outputKeys → Set<String>
Output keys for this chain.
no setterinherited
runOutputKey → String
Output key from where the run method needs to take the return value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

apply(List<ChainValues> inputs) → Future<List<ChainValues>>
Call the chain on all inputs in the list.
inherited
batch(List<ChainValues> inputs, {List<ChainOptions>? options}) → Future<List<ChainValues>>
Batches the invocation of the Runnable on the given inputs.
inherited
bind(ChainOptions options) → RunnableBinding<ChainValues, ChainOptions, ChainValues>
Binds the Runnable to the given options.
inherited
call(dynamic input, {bool returnOnlyOutputs = false}) → Future<ChainValues>
Runs the core logic of this chain with the given values. If memory is not null, it will be used to load and save values.
inherited
callInternal(ChainValues inputs) → Future<ChainValues>
Call method to be implemented by subclasses (called by call). This is where the core logic of the chain should be implemented.
inherited
close() → void
Cleans up any resources associated with it the Runnable.
inherited
combineDocs(List<Document> docs, {InputValues inputs = const {}}) → Future<ChainValues>
Stuff all documents into one prompt and pass to LLM.
inherited
formatDocument(Document doc, BasePromptTemplate prompt) → String
Formats a document into a string based on a prompt template.
inherited
getCompatibleOptions(RunnableOptions? options) → ChainOptions?
Returns the given options if they are compatible with the Runnable, otherwise returns null.
inherited
invoke(ChainValues input, {ChainOptions? options}) → Future<ChainValues>
Runs the core logic of this chain with the given input.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe<NewRunOutput extends Object?, NewCallOptions extends RunnableOptions>(Runnable<ChainValues, NewCallOptions, NewRunOutput> next) → RunnableSequence<ChainValues, NewRunOutput>
Pipes the output of this Runnable into another Runnable using a RunnableSequence.
inherited
promptLength(List<Document> docs, {InputValues inputs = const {}}) → Future<int?>
Returns the prompt length (number of tokens) given the documents passed in.
inherited
run(dynamic input) → Future<String>
Convenience method for executing chain when there's a single string output.
inherited
stream(ChainValues input, {ChainOptions? options}) → Stream<ChainValues>
Streams the output of invoking the Runnable on the given input.
inherited
streamFromInputStream(Stream<ChainValues> inputStream, {ChainOptions? options}) → Stream<ChainValues>
Streams the output of invoking the Runnable on the given inputStream.
inherited
toString() → String
A string representation of this object.
inherited
withFallbacks(List<Runnable<ChainValues, RunnableOptions, ChainValues>> fallbacks) → RunnableWithFallback<ChainValues, ChainValues>
Adds fallback runnables to be invoked if the primary runnable fails.
inherited
withRetry({int maxRetries = 3, FutureOr<bool> retryIf(Object e)?, List<Duration?>? delayDurations, bool addJitter = false}) → RunnableRetry<ChainValues, ChainValues>
Adds retry logic to an existing runnable.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited