_get_relevant_documents() — langchain Function Reference

Architecture documentation for the _get_relevant_documents() function in multi_vector.py from the langchain codebase.

Function python LangChainCore MessageInterface

Entity Profile

LangChainCore→ MessageInterface→ _get_relevant_documents() — langchain Function Reference

Dependency Diagram

graph TD
  797e6097_1f8a_2d77_ccb0_62a0ea59a9f3["_get_relevant_documents()"]
  c7ceffe2_56b9_b96d_5de5_8e679b778e9a["MultiVectorRetriever"]
  797e6097_1f8a_2d77_ccb0_62a0ea59a9f3 -->|defined in| c7ceffe2_56b9_b96d_5de5_8e679b778e9a
  style 797e6097_1f8a_2d77_ccb0_62a0ea59a9f3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain/langchain_classic/retrievers/multi_vector.py lines 64–100

    def _get_relevant_documents(
        self,
        query: str,
        *,
        run_manager: CallbackManagerForRetrieverRun,
    ) -> list[Document]:
        """Get documents relevant to a query.

        Args:
            query: String to find relevant documents for
            run_manager: The callbacks handler to use
        Returns:
            List of relevant documents.
        """
        if self.search_type == SearchType.mmr:
            sub_docs = self.vectorstore.max_marginal_relevance_search(
                query,
                **self.search_kwargs,
            )
        elif self.search_type == SearchType.similarity_score_threshold:
            sub_docs_and_similarities = (
                self.vectorstore.similarity_search_with_relevance_scores(
                    query,
                    **self.search_kwargs,
                )
            )
            sub_docs = [sub_doc for sub_doc, _ in sub_docs_and_similarities]
        else:
            sub_docs = self.vectorstore.similarity_search(query, **self.search_kwargs)

        # We do this to maintain the order of the IDs that are returned
        ids = []
        for d in sub_docs:
            if self.id_key in d.metadata and d.metadata[self.id_key] not in ids:
                ids.append(d.metadata[self.id_key])
        docs = self.docstore.mget(ids)
        return [d for d in docs if d is not None]