SequentialRetriever Class — langchain Architecture

Architecture documentation for the SequentialRetriever class in sequential_retriever.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  8e559c20_27b7_5797_9418_9482f2ef6869["SequentialRetriever"]
  3a20478a_3692_141f_433b_a32429b00020["BaseRetriever"]
  8e559c20_27b7_5797_9418_9482f2ef6869 -->|extends| 3a20478a_3692_141f_433b_a32429b00020
  a856570e_8448_e772_22d5_769ef1077161["sequential_retriever.py"]
  8e559c20_27b7_5797_9418_9482f2ef6869 -->|defined in| a856570e_8448_e772_22d5_769ef1077161
  eeda143c_f32f_82a4_6754_c66137c600b0["_get_relevant_documents()"]
  8e559c20_27b7_5797_9418_9482f2ef6869 -->|method| eeda143c_f32f_82a4_6754_c66137c600b0
  17edb308_3978_5d08_e7ed_ec353e6d2d0c["_aget_relevant_documents()"]
  8e559c20_27b7_5797_9418_9482f2ef6869 -->|method| 17edb308_3978_5d08_e7ed_ec353e6d2d0c

Relationship Graph

Source Code

libs/langchain/tests/unit_tests/retrievers/sequential_retriever.py lines 8–31

class SequentialRetriever(BaseRetriever):
    """Test util that returns a sequence of documents."""

    sequential_responses: list[list[Document]]
    response_index: int = 0

    @override
    def _get_relevant_documents(
        self,
        query: str,
        **kwargs: Any,
    ) -> list[Document]:
        if self.response_index >= len(self.sequential_responses):
            return []
        self.response_index += 1
        return self.sequential_responses[self.response_index - 1]

    @override
    async def _aget_relevant_documents(
        self,
        query: str,
        **kwargs: Any,
    ) -> list[Document]:
        return self._get_relevant_documents(query)