Interface ConversationalRetrievalQAChainInput

Interface for the input parameters of the ConversationalRetrievalQAChain class.

interface ConversationalRetrievalQAChainInput {
    combineDocumentsChain: BaseChain<ChainValues, ChainValues>;
    questionGeneratorChain: LLMChain<string, LLMType>;
    retriever: BaseRetrieverInterface<Record<string, any>>;
    callbackManager?: CallbackManager;
    inputKey?: string;
    memory?: BaseMemory;
    returnGeneratedQuestion?: boolean;
    returnSourceDocuments?: boolean;
}

Hierarchy (view full)

Implemented by

Properties

combineDocumentsChain questionGeneratorChain retriever callbackManager? inputKey? memory? returnGeneratedQuestion? returnSourceDocuments?

Properties

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

questionGeneratorChain

questionGeneratorChain: LLMChain<string, LLMType>

retriever

retriever: BaseRetrieverInterface<Record<string, any>>

Optional callbackManager

callbackManager?: CallbackManager

⚠️ Deprecated ⚠️

Use callbacks instead

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional inputKey

inputKey?: string

Optional memory

memory?: BaseMemory

Optional returnGeneratedQuestion

returnGeneratedQuestion?: boolean

Optional returnSourceDocuments

returnSourceDocuments?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc