Class ParentDocumentRetriever

A type of document retriever that splits input documents into smaller chunks while separately storing and preserving the original documents. The small chunks are embedded, then on retrieval, the original "parent" documents are retrieved.

This strikes a balance between better targeted retrieval with small documents and the more context-rich larger documents.

Example

const retriever = new ParentDocumentRetriever({
  vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),
  byteStore: new InMemoryStore<Uint8Array>(),
  parentSplitter: new RecursiveCharacterTextSplitter({
    chunkOverlap: 0,
    chunkSize: 500,
  }),
  childSplitter: new RecursiveCharacterTextSplitter({
    chunkOverlap: 0,
    chunkSize: 50,
  }),
  childK: 20,
  parentK: 5,
});

const parentDocuments = await getDocuments();
await retriever.addDocuments(parentDocuments);
const retrievedDocs = await retriever.getRelevantDocuments("justice breyer");

Hierarchy (view full)

Constructors

constructor

Properties

childDocumentRetriever docstore documentCompressor vectorstore documentCompressorFilteringFn? childSplitter idKey childK? parentK? parentSplitter?

Methods

addDocuments

Constructors

constructor

Properties

childDocumentRetriever

childDocumentRetriever: undefined | VectorStoreRetrieverInterface<VectorStoreInterface>

docstore

docstore: BaseStoreInterface<string, Document<Record<string, any>>>

documentCompressor

documentCompressor: undefined | BaseDocumentCompressor

vectorstore

vectorstore: VectorStoreInterface

Optional documentCompressorFilteringFn

documentCompressorFilteringFn?: ((docs) => SubDocs)

Type declaration

Protected childSplitter

childSplitter: TextSplitter

Protected idKey

idKey: string = "doc_id"

Protected Optional childK

childK?: number

Protected Optional parentK

parentK?: number

Protected Optional parentSplitter

parentSplitter?: any

Methods

addDocuments

  • addDocuments(docs, config?): Promise<void>

  • Adds documents to the docstore and vectorstores. If a retriever is provided, it will be used to add documents instead of the vectorstore.

    Parameters

    • docs: Document<Record<string, any>>[]

      The documents to add

    • Optional config: {
          addToDocstore?: boolean;
          childDocChunkHeaderOptions?: any;
          ids?: string[];
      }
      • Optional addToDocstore?: boolean

        Boolean of whether to add documents to docstore. This can be false if and only if ids are provided. You may want to set this to False if the documents are already in the docstore and you don't want to re-add them.

      • Optional childDocChunkHeaderOptions?: any
      • Optional ids?: string[]

        Optional list of ids for documents. If provided should be the same length as the list of documents. Can provided if parent documents are already in the document store and you don't want to re-add to the docstore. If not provided, random UUIDs will be used as ids.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc