Interface ConversationalRetrievalQAChainInput

Interface for the input parameters of the ConversationalRetrievalQAChain class.

interface ConversationalRetrievalQAChainInput {
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    combineDocumentsChain: BaseChain<ChainValues, ChainValues>;
    inputKey?: string;
    memory?: BaseMemory;
    metadata?: Record<string, unknown>;
    questionGeneratorChain: LLMChain<string, LLMType>;
    retriever: BaseRetrieverInterface<Record<string, any>>;
    returnGeneratedQuestion?: boolean;
    returnSourceDocuments?: boolean;
    tags?: string[];
    verbose?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

callbackManager? callbacks? combineDocumentsChain inputKey? memory? metadata? questionGeneratorChain retriever returnGeneratedQuestion? returnSourceDocuments? tags? verbose?

Properties

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

OptionalinputKey

inputKey?: string

Optionalmemory

memory?: BaseMemory

Optionalmetadata

metadata?: Record<string, unknown>

questionGeneratorChain

questionGeneratorChain: LLMChain<string, LLMType>

retriever

retriever: BaseRetrieverInterface<Record<string, any>>

OptionalreturnGeneratedQuestion

returnGeneratedQuestion?: boolean

OptionalreturnSourceDocuments

returnSourceDocuments?: boolean

Optionaltags

tags?: string[]

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties