patch: deprecate (a)get_relevant_documents (#20477)

- `.get_relevant_documents(query)` -> `.invoke(query)`
- `.get_relevant_documents(query=query)` -> `.invoke(query)`
- `.get_relevant_documents(query, callbacks=callbacks)` ->
`.invoke(query, config={"callbacks": callbacks})`
- `.get_relevant_documents(query, **kwargs)` -> `.invoke(query,
**kwargs)`

---------

Co-authored-by: Erick Friis <erick@langchain.dev>

libs/core/langchain_core/retrievers.py

@@ -25,6 +25,7 @@ from abc import ABC, abstractmethod
 from inspect import signature
 from typing import TYPE_CHECKING, Any, Dict, List, Optional
 
+from langchain_core._api import deprecated
 from langchain_core.documents import Document
 from langchain_core.load.dump import dumpd
 from langchain_core.runnables import (
@@ -262,6 +263,7 @@ class BaseRetriever(RunnableSerializable[RetrieverInput, RetrieverOutput], ABC):
             run_manager=run_manager.get_sync(),
         )
 
+    @deprecated(since="0.1.46", alternative="invoke", removal="0.3.0")
     def get_relevant_documents(
         self,
         query: str,
@@ -325,6 +327,7 @@ class BaseRetriever(RunnableSerializable[RetrieverInput, RetrieverOutput], ABC):
             )
             return result
 
+    @deprecated(since="0.1.46", alternative="ainvoke", removal="0.3.0")
     async def aget_relevant_documents(
         self,
         query: str,

libs/core/langchain_core/tools.py

@@ -945,7 +945,7 @@ def _get_relevant_documents(
     document_separator: str,
     callbacks: Callbacks = None,
 ) -> str:
-    docs = retriever.get_relevant_documents(query, callbacks=callbacks)
+    docs = retriever.invoke(query, config={"callbacks": callbacks})
     return document_separator.join(
         format_document(doc, document_prompt) for doc in docs
     )
@@ -958,7 +958,7 @@ async def _aget_relevant_documents(
     document_separator: str,
     callbacks: Callbacks = None,
 ) -> str:
-    docs = await retriever.aget_relevant_documents(query, callbacks=callbacks)
+    docs = await retriever.ainvoke(query, config={"callbacks": callbacks})
     return document_separator.join(
         [await aformat_document(doc, document_prompt) for doc in docs]
     )