Type Alias ParentDocumentRetrieverFields

ParentDocumentRetrieverFields: {
    childSplitter: TextSplitter;
    vectorstore: VectorStoreInterface;
    byteStore?: any;
    childDocumentRetriever?: any;
    childK?: undefined | number;
    docstore?: any;
    documentCompressor?: undefined | BaseDocumentCompressor;
    documentCompressorFilteringFn?: undefined | ((docs: SubDocs) => SubDocs);
    idKey?: undefined | string;
    parentK?: undefined | number;
    parentSplitter?: any;
}

Interface for the fields required to initialize a ParentDocumentRetriever instance.

Type declaration

  • childSplitter: TextSplitter
  • vectorstore: VectorStoreInterface
  • OptionalbyteStore?: any
  • OptionalchildDocumentRetriever?: any

    A custom retriever to use when retrieving instead of the .similaritySearch method of the vectorstore.

  • OptionalchildK?: undefined | number
  • Optionaldocstore?: any

    Deprecated

    Prefer byteStore.

  • OptionaldocumentCompressor?: undefined | BaseDocumentCompressor
  • OptionaldocumentCompressorFilteringFn?: undefined | ((docs: SubDocs) => SubDocs)
  • OptionalidKey?: undefined | string
  • OptionalparentK?: undefined | number
  • OptionalparentSplitter?: any

Settings

Member Visibility