Class BaseDocumentCompressor`Abstract`

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

Hierarchy (view full)

BaseDocumentCompressor

Index

Constructors

Methods

compressDocuments isBaseDocumentCompressor

Constructors

constructor

new BaseDocumentCompressor(): BaseDocumentCompressor
Returns BaseDocumentCompressor

Methods

`Abstract` compressDocuments

compressDocuments(documents, query, callbacks?): Promise<DocumentInterface[]>
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[]
  An array of Document objects to be compressed.
- query: string
  A query string.
- Optional callbacks: any
Returns Promise<DocumentInterface[]>
A Promise that resolves with an array of compressed Document objects.
- Defined in langchain/src/retrievers/document_compressors/index.ts:18

`Static` isBaseDocumentCompressor

isBaseDocumentCompressor(x): x is BaseDocumentCompressor
Parameters
- x: any
Returns x is BaseDocumentCompressor
- Defined in langchain/src/retrievers/document_compressors/index.ts:25

Generated using TypeDoc