Type Alias ParentDocumentRetrieverFields

ParentDocumentRetrieverFields: {
    byteStore?: undefined | BaseStore<string, Uint8Array>;
    callbacks?: undefined | Callbacks;
    childDocumentRetriever?: undefined | VectorStoreRetrieverInterface<VectorStoreInterface>;
    childK?: undefined | number;
    childSplitter: TextSplitter;
    docstore?: undefined | BaseStoreInterface<string, Document<Record<string, any>>>;
    documentCompressor?: undefined | BaseDocumentCompressor;
    documentCompressorFilteringFn?: undefined | ((docs: SubDocs) => SubDocs);
    idKey?: undefined | string;
    metadata?: undefined | Record<string, unknown>;
    parentK?: undefined | number;
    parentSplitter?: undefined | TextSplitter;
    tags?: undefined | string[];
    vectorstore: VectorStoreInterface;
    verbose?: undefined | boolean;
}

Interface for the fields required to initialize a ParentDocumentRetriever instance.

Type declaration

  • OptionalbyteStore?: undefined | BaseStore<string, Uint8Array>
  • Optionalcallbacks?: undefined | Callbacks
  • OptionalchildDocumentRetriever?: undefined | VectorStoreRetrieverInterface<VectorStoreInterface>

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

  • OptionalchildK?: undefined | number
  • childSplitter: TextSplitter
  • Optionaldocstore?: undefined | BaseStoreInterface<string, Document<Record<string, any>>>

    Deprecated

    Prefer byteStore.

  • OptionaldocumentCompressor?: undefined | BaseDocumentCompressor
  • OptionaldocumentCompressorFilteringFn?: undefined | ((docs: SubDocs) => SubDocs)
  • OptionalidKey?: undefined | string
  • Optionalmetadata?: undefined | Record<string, unknown>
  • OptionalparentK?: undefined | number
  • OptionalparentSplitter?: undefined | TextSplitter
  • Optionaltags?: undefined | string[]
  • vectorstore: VectorStoreInterface
  • Optionalverbose?: undefined | boolean

Settings

Member Visibility