From a34e650f8babf88d377806366a8ab0c84b25dc30 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Wed, 19 Jun 2024 11:03:49 -0400 Subject: [PATCH] core[patch]: Add doc-string to document compressor (#23085) --- libs/core/langchain_core/documents/compressor.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/libs/core/langchain_core/documents/compressor.py b/libs/core/langchain_core/documents/compressor.py index 228caf660a..6ed597a1e5 100644 --- a/libs/core/langchain_core/documents/compressor.py +++ b/libs/core/langchain_core/documents/compressor.py @@ -10,7 +10,20 @@ from langchain_core.runnables import run_in_executor class BaseDocumentCompressor(BaseModel, ABC): - """Base class for document compressors.""" + """Base class for document compressors. + + This abstraction is primarily used for + post-processing of retrieved documents. + + Documents matching a given query are first retrieved. + Then the list of documents can be further processed. + + For example, one could re-rank the retrieved documents + using an LLM. + + **Note** users should favor using a RunnableLambda + instead of sub-classing from this interface. + """ @abstractmethod def compress_documents(