Class BaseDocumentCompressor`Abstract`

Base Document Compression class. All compressors should extend this class.

Index

Constructors

Methods

compressDocuments isBaseDocumentCompressor

Constructors

constructor

new BaseDocumentCompressor(): BaseDocumentCompressor
Returns BaseDocumentCompressor

Methods

`Abstract`compressDocuments

compressDocuments(
    documents: DocumentInterface<Record<string, any>>[],
    query: string,
    callbacks?: Callbacks,
): Promise<DocumentInterface<Record<string, any>>[]>
Abstract method that must be implemented by any class that extends BaseDocumentCompressor. This method takes an array of Document objects and a query string as parameters and returns a Promise that resolves with an array of compressed Document objects.
Parameters
- documents: DocumentInterface<Record<string, any>>[]
  An array of Document objects to be compressed.
- query: string
  A query string.
- Optionalcallbacks: Callbacks
Returns Promise<DocumentInterface<Record<string, any>>[]>
A Promise that resolves with an array of compressed Document objects.
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/retrievers/document_compressors/base.ts:17

`Static`isBaseDocumentCompressor

isBaseDocumentCompressor(x: any): x is BaseDocumentCompressor
Parameters
- x: any
Returns x is BaseDocumentCompressor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-core/src/retrievers/document_compressors/base.ts:24