Skip to content

Commit

Permalink
core[minor]: move document compressor base (langchain-ai#17910)
Browse files Browse the repository at this point in the history
  • Loading branch information
hwchase17 authored and al1p-R committed Feb 27, 2024
1 parent 7fc2c4d commit 481b08c
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 30 deletions.
3 changes: 2 additions & 1 deletion libs/core/langchain_core/documents/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"""
from langchain_core.documents.base import Document
from langchain_core.documents.compressor import BaseDocumentCompressor
from langchain_core.documents.transformers import BaseDocumentTransformer

__all__ = ["Document", "BaseDocumentTransformer"]
__all__ = ["Document", "BaseDocumentTransformer", "BaseDocumentCompressor"]
33 changes: 33 additions & 0 deletions libs/core/langchain_core/documents/compressor.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
from __future__ import annotations

from abc import ABC, abstractmethod
from typing import Optional, Sequence

from langchain_core.callbacks import Callbacks
from langchain_core.documents import Document
from langchain_core.pydantic_v1 import BaseModel
from langchain_core.runnables import run_in_executor


class BaseDocumentCompressor(BaseModel, ABC):
"""Base class for document compressors."""

@abstractmethod
def compress_documents(
self,
documents: Sequence[Document],
query: str,
callbacks: Optional[Callbacks] = None,
) -> Sequence[Document]:
"""Compress retrieved documents given the query context."""

async def acompress_documents(
self,
documents: Sequence[Document],
query: str,
callbacks: Optional[Callbacks] = None,
) -> Sequence[Document]:
"""Compress retrieved documents given the query context."""
return await run_in_executor(
None, self.compress_documents, documents, query, callbacks
)
2 changes: 1 addition & 1 deletion libs/core/tests/unit_tests/documents/test_imports.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from langchain_core.documents import __all__

EXPECTED_ALL = ["Document", "BaseDocumentTransformer"]
EXPECTED_ALL = ["Document", "BaseDocumentTransformer", "BaseDocumentCompressor"]


def test_all_imports() -> None:
Expand Down
33 changes: 5 additions & 28 deletions libs/langchain/langchain/retrievers/document_compressors/base.py
Original file line number Diff line number Diff line change
@@ -1,38 +1,15 @@
from abc import ABC, abstractmethod
from inspect import signature
from typing import List, Optional, Sequence, Union

from langchain_core.documents import BaseDocumentTransformer, Document
from langchain_core.pydantic_v1 import BaseModel
from langchain_core.runnables.config import run_in_executor
from langchain_core.documents import (
BaseDocumentCompressor,
BaseDocumentTransformer,
Document,
)

from langchain.callbacks.manager import Callbacks


class BaseDocumentCompressor(BaseModel, ABC):
"""Base class for document compressors."""

@abstractmethod
def compress_documents(
self,
documents: Sequence[Document],
query: str,
callbacks: Optional[Callbacks] = None,
) -> Sequence[Document]:
"""Compress retrieved documents given the query context."""

async def acompress_documents(
self,
documents: Sequence[Document],
query: str,
callbacks: Optional[Callbacks] = None,
) -> Sequence[Document]:
"""Compress retrieved documents given the query context."""
return await run_in_executor(
None, self.compress_documents, documents, query, callbacks
)


class DocumentCompressorPipeline(BaseDocumentCompressor):
"""Document compressor that uses a pipeline of Transformers."""

Expand Down

0 comments on commit 481b08c

Please sign in to comment.