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>

docs/docs/integrations/chat/maritalk.ipynb

@@ -184,7 +184,7 @@
     "\n",
     "query = \"Qual o tempo máximo para realização da prova?\"\n",
     "\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "\n",
     "chain.invoke(\n",
     "    {\"input_documents\": docs, \"query\": query}\n",

docs/docs/integrations/document_loaders/docugami.ipynb

@@ -630,7 +630,7 @@
    ],
    "source": [
     "# Query retriever, should return parents (using MMR since that was set as search_type above)\n",
-    "retrieved_parent_docs = retriever.get_relevant_documents(\n",
+    "retrieved_parent_docs = retriever.invoke(\n",
     "    \"what signs does Birch Street allow on their property?\"\n",
     ")\n",
     "for chunk in retrieved_parent_docs:\n",

docs/docs/integrations/document_loaders/figma.ipynb

@@ -97,7 +97,7 @@
     "    # delete the gpt-4 model_name to use the default gpt-3.5 turbo for faster results\n",
     "    gpt_4 = ChatOpenAI(temperature=0.02, model_name=\"gpt-4\")\n",
     "    # Use the retriever's 'get_relevant_documents' method if needed to filter down longer docs\n",
-    "    relevant_nodes = figma_doc_retriever.get_relevant_documents(human_input)\n",
+    "    relevant_nodes = figma_doc_retriever.invoke(human_input)\n",
     "    conversation = [system_message_prompt, human_message_prompt]\n",
     "    chat_prompt = ChatPromptTemplate.from_messages(conversation)\n",
     "    response = gpt_4(\n",

docs/docs/integrations/document_loaders/spreedly.ipynb

@@ -99,7 +99,7 @@
    ],
    "source": [
     "# Test the retriever\n",
-    "spreedly_doc_retriever.get_relevant_documents(\"CRC\")"
+    "spreedly_doc_retriever.invoke(\"CRC\")"
    ]
   },
   {

docs/docs/integrations/document_transformers/cross_encoder_reranker.ipynb

@@ -82,7 +82,7 @@
     ")\n",
     "\n",
     "query = \"What is the plan for the economy?\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -162,9 +162,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
-    "    \"What is the plan for the economy?\"\n",
-    ")\n",
+    "compressed_docs = compression_retriever.invoke(\"What is the plan for the economy?\")\n",
     "pretty_print_docs(compressed_docs)"
    ]
   },

docs/docs/integrations/document_transformers/openvino_rerank.ipynb

@@ -350,7 +350,7 @@
     "retriever = FAISS.from_documents(texts, embedding).as_retriever(search_kwargs={\"k\": 20})\n",
     "\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -388,7 +388,7 @@
     "    base_compressor=ov_compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "print([doc.metadata[\"id\"] for doc in compressed_docs])"

docs/docs/integrations/document_transformers/voyageai-reranker.ipynb

@@ -320,7 +320,7 @@
     ").as_retriever(search_kwargs={\"k\": 20})\n",
     "\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -382,7 +382,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"

docs/docs/integrations/platforms/google.mdx

@@ -623,7 +623,7 @@ docai_wh_retriever = GoogleDocumentAIWarehouseRetriever(
     project_number=...
 )
 query = ...
-documents = docai_wh_retriever.get_relevant_documents(
+documents = docai_wh_retriever.invoke(
     query, user_ldap=...
 )
 ```

docs/docs/integrations/providers/cohere.mdx

@@ -83,7 +83,7 @@ from langchain.retrievers import CohereRagRetriever
 from langchain_core.documents import Document
 
 rag = CohereRagRetriever(llm=ChatCohere())
-print(rag.get_relevant_documents("What is cohere ai?"))
+print(rag.invoke("What is cohere ai?"))
 ```
 
 Usage of the Cohere [RAG Retriever](/docs/integrations/retrievers/cohere)

docs/docs/integrations/providers/metal.mdx

@@ -22,5 +22,5 @@ from metal_sdk.metal import Metal
 metal = Metal("API_KEY", "CLIENT_ID", "INDEX_ID");
 retriever = MetalRetriever(metal, params={"limit": 2})
 
-docs = retriever.get_relevant_documents("search term")
+docs = retriever.invoke("search term")
 ```

docs/docs/integrations/providers/ragatouille.ipynb

@@ -199,7 +199,7 @@
     "    base_compressor=RAG.as_langchain_document_compressor(), base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What animation studio did Miyazaki found\"\n",
     ")"
    ]

docs/docs/integrations/providers/vectara/vectara_chat.ipynb

@@ -154,9 +154,7 @@
     "openai_api_key = os.environ[\"OPENAI_API_KEY\"]\n",
     "llm = OpenAI(openai_api_key=openai_api_key, temperature=0)\n",
     "retriever = vectara.as_retriever()\n",
-    "d = retriever.get_relevant_documents(\n",
-    "    \"What did the president say about Ketanji Brown Jackson\", k=2\n",
-    ")\n",
+    "d = retriever.invoke(\"What did the president say about Ketanji Brown Jackson\", k=2)\n",
     "print(d)"
    ]
   },

docs/docs/integrations/retrievers/amazon_kendra_retriever.ipynb

@@ -69,7 +69,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retriever.get_relevant_documents(\"what is langchain\")"
+    "retriever.invoke(\"what is langchain\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/arcee.ipynb

@@ -83,7 +83,7 @@
    "outputs": [],
    "source": [
     "query = \"Can AI-driven music therapy contribute to the rehabilitation of patients with disorders of consciousness?\"\n",
-    "documents = retriever.get_relevant_documents(query=query)"
+    "documents = retriever.invoke(query)"
    ]
   },
   {
@@ -108,7 +108,7 @@
     "]\n",
     "\n",
     "# Retrieve documents with filters and size params\n",
-    "documents = retriever.get_relevant_documents(query=query, size=5, filters=filters)"
+    "documents = retriever.invoke(query, size=5, filters=filters)"
    ]
   }
  ],

docs/docs/integrations/retrievers/arxiv.ipynb

@@ -97,7 +97,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "docs = retriever.get_relevant_documents(query=\"1605.08386\")"
+    "docs = retriever.invoke(\"1605.08386\")"
    ]
   },
   {
@@ -162,7 +162,7 @@
    },
    "outputs": [
     {
-     "name": "stdin",
+     "name": "stdout",
      "output_type": "stream",
      "text": [
       " ········\n"

docs/docs/integrations/retrievers/azure_ai_search.ipynb

@@ -117,7 +117,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retriever.get_relevant_documents(\"what is langchain?\")"
+    "retriever.invoke(\"what is langchain?\")"
    ]
   },
   {
@@ -263,7 +263,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"What is Azure OpenAI?\")"
+    "retriever.invoke(\"What is Azure OpenAI?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/bedrock.ipynb

@@ -58,7 +58,7 @@
    "source": [
     "query = \"What did the president say about Ketanji Brown?\"\n",
     "\n",
-    "retriever.get_relevant_documents(query=query)"
+    "retriever.invoke(query)"
    ]
   },
   {

docs/docs/integrations/retrievers/bm25.ipynb

@@ -103,7 +103,7 @@
    },
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/breebs.ipynb

@@ -64,7 +64,7 @@
    "source": [
     "breeb_key = \"Parivoyage\"\n",
     "retriever = BreebsRetriever(breeb_key)\n",
-    "documents = retriever.get_relevant_documents(\n",
+    "documents = retriever.invoke(\n",
     "    \"What are some unique, lesser-known spots to explore in Paris?\"\n",
     ")\n",
     "print(documents)"

docs/docs/integrations/retrievers/chaindesk.ipynb

@@ -83,7 +83,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"What is Daftpage?\")"
+    "retriever.invoke(\"What is Daftpage?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/chatgpt-plugin.ipynb

@@ -150,7 +150,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"alice's phone number\")"
+    "retriever.invoke(\"alice's phone number\")"
    ]
   },
   {

docs/docs/integrations/retrievers/cohere-reranker.ipynb

@@ -314,7 +314,7 @@
     ")\n",
     "\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -344,7 +344,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"

docs/docs/integrations/retrievers/cohere.ipynb

@@ -118,7 +118,7 @@
     }
    ],
    "source": [
-    "_pretty_print(rag.get_relevant_documents(\"What is cohere ai?\"))"
+    "_pretty_print(rag.invoke(\"What is cohere ai?\"))"
    ]
   },
   {
@@ -172,7 +172,7 @@
     }
    ],
    "source": [
-    "_pretty_print(await rag.aget_relevant_documents(\"What is cohere ai?\"))  # async version"
+    "_pretty_print(await rag.ainvoke(\"What is cohere ai?\"))  # async version"
    ]
   },
   {
@@ -198,7 +198,7 @@
     }
    ],
    "source": [
-    "docs = rag.get_relevant_documents(\n",
+    "docs = rag.invoke(\n",
     "    \"Does langchain support cohere RAG?\",\n",
     "    source_documents=[\n",
     "        Document(page_content=\"Langchain supports cohere RAG!\"),\n",

docs/docs/integrations/retrievers/docarray_retriever.ipynb

@@ -143,7 +143,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"some query\")\n",
+    "doc = retriever.invoke(\"some query\")\n",
     "print(doc)"
    ]
   },
@@ -216,7 +216,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"some query\")\n",
+    "doc = retriever.invoke(\"some query\")\n",
     "print(doc)"
    ]
   },
@@ -313,7 +313,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"some query\")\n",
+    "doc = retriever.invoke(\"some query\")\n",
     "print(doc)"
    ]
   },
@@ -388,7 +388,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"some query\")\n",
+    "doc = retriever.invoke(\"some query\")\n",
     "print(doc)"
    ]
   },
@@ -481,7 +481,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"some query\")\n",
+    "doc = retriever.invoke(\"some query\")\n",
     "print(doc)"
    ]
   },
@@ -658,7 +658,7 @@
     ")\n",
     "\n",
     "# find the relevant document\n",
-    "doc = retriever.get_relevant_documents(\"movie about dreams\")\n",
+    "doc = retriever.invoke(\"movie about dreams\")\n",
     "print(doc)"
    ]
   },
@@ -700,7 +700,7 @@
     ")\n",
     "\n",
     "# find relevant documents\n",
-    "docs = retriever.get_relevant_documents(\"space travel\")\n",
+    "docs = retriever.invoke(\"space travel\")\n",
     "print(docs)"
    ]
   },
@@ -743,7 +743,7 @@
     ")\n",
     "\n",
     "# find relevant documents\n",
-    "docs = retriever.get_relevant_documents(\"action movies\")\n",
+    "docs = retriever.invoke(\"action movies\")\n",
     "print(docs)"
    ]
   },

docs/docs/integrations/retrievers/dria_index.ipynb

@@ -158,7 +158,7 @@
    "outputs": [],
    "source": [
     "query = \"Find information about Dria.\"\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]

docs/docs/integrations/retrievers/elastic_search_bm25.ipynb

@@ -130,7 +130,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/elasticsearch_retriever.ipynb

@@ -263,7 +263,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "vector_retriever.get_relevant_documents(\"foo\")"
+    "vector_retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -313,7 +313,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "bm25_retriever.get_relevant_documents(\"foo\")"
+    "bm25_retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -371,7 +371,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "hybrid_retriever.get_relevant_documents(\"foo\")"
+    "hybrid_retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -424,7 +424,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "fuzzy_retriever.get_relevant_documents(\"fox\")  # note the character tolernace"
+    "fuzzy_retriever.invoke(\"fox\")  # note the character tolernace"
    ]
   },
   {
@@ -483,7 +483,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "filtering_retriever.get_relevant_documents(\"foo\")"
+    "filtering_retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -541,7 +541,7 @@
     "    url=es_url,\n",
     ")\n",
     "\n",
-    "custom_mapped_retriever.get_relevant_documents(\"foo\")"
+    "custom_mapped_retriever.invoke(\"foo\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/embedchain.ipynb

@@ -194,9 +194,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\n",
-    "    \"How many companies does Elon Musk run and name those?\"\n",
-    ")"
+    "result = retriever.invoke(\"How many companies does Elon Musk run and name those?\")"
    ]
   },
   {

docs/docs/integrations/retrievers/flashrank-reranker.ipynb

@@ -328,7 +328,7 @@
     "retriever = FAISS.from_documents(texts, embedding).as_retriever(search_kwargs={\"k\": 20})\n",
     "\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -375,7 +375,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "print([doc.metadata[\"id\"] for doc in compressed_docs])"

docs/docs/integrations/retrievers/fleet_context.ipynb

@@ -131,7 +131,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "vecstore_retriever.get_relevant_documents(\"How does the multi vector retriever work\")"
+    "vecstore_retriever.invoke(\"How does the multi vector retriever work\")"
    ]
   },
   {
@@ -176,7 +176,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "parent_retriever.get_relevant_documents(\"How does the multi vector retriever work\")"
+    "parent_retriever.invoke(\"How does the multi vector retriever work\")"
    ]
   },
   {

docs/docs/integrations/retrievers/google_drive.ipynb

@@ -114,7 +114,7 @@
    },
    "outputs": [],
    "source": [
-    "retriever.get_relevant_documents(\"machine learning\")"
+    "retriever.invoke(\"machine learning\")"
    ]
   },
   {
@@ -149,7 +149,7 @@
     "    template=\"gdrive-query\",  # Search everywhere\n",
     "    num_results=2,  # But take only 2 documents\n",
     ")\n",
-    "for doc in retriever.get_relevant_documents(\"machine learning\"):\n",
+    "for doc in retriever.invoke(\"machine learning\"):\n",
     "    print(\"---\")\n",
     "    print(doc.page_content.strip()[:60] + \"...\")"
    ]
@@ -187,7 +187,7 @@
     "    includeItemsFromAllDrives=False,\n",
     "    supportsAllDrives=False,\n",
     ")\n",
-    "for doc in retriever.get_relevant_documents(\"machine learning\"):\n",
+    "for doc in retriever.invoke(\"machine learning\"):\n",
     "    print(f\"{doc.metadata['name']}:\")\n",
     "    print(\"---\")\n",
     "    print(doc.page_content.strip()[:60] + \"...\")"
@@ -222,7 +222,7 @@
     "    includeItemsFromAllDrives=False,\n",
     "    supportsAllDrives=False,\n",
     ")\n",
-    "retriever.get_relevant_documents(\"machine learning\")"
+    "retriever.invoke(\"machine learning\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/google_vertex_ai_search.ipynb

@@ -198,7 +198,7 @@
    "source": [
     "query = \"What are Alphabet's Other Bets?\"\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]
@@ -225,7 +225,7 @@
     "    get_extractive_answers=True,\n",
     ")\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]
@@ -251,7 +251,7 @@
     "    engine_data_type=1,\n",
     ")\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]
@@ -279,7 +279,7 @@
     "    engine_data_type=2,\n",
     ")\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]
@@ -305,7 +305,7 @@
     "    engine_data_type=3,\n",
     ")\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]
@@ -329,7 +329,7 @@
     "    project_id=PROJECT_ID, location_id=LOCATION_ID, data_store_id=DATA_STORE_ID\n",
     ")\n",
     "\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "for doc in result:\n",
     "    print(doc)"
    ]

docs/docs/integrations/retrievers/kay.ipynb

@@ -92,7 +92,7 @@
     "retriever = KayAiRetriever.create(\n",
     "    dataset_id=\"company\", data_types=[\"10-K\", \"10-Q\", \"PressRelease\"], num_contexts=3\n",
     ")\n",
-    "docs = retriever.get_relevant_documents(\n",
+    "docs = retriever.invoke(\n",
     "    \"What were the biggest strategy changes and partnerships made by Roku in 2023??\"\n",
     ")"
    ]

docs/docs/integrations/retrievers/knn.ipynb

@@ -62,7 +62,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/llmlingua.ipynb

@@ -296,7 +296,7 @@
     "retriever = FAISS.from_documents(texts, embedding).as_retriever(search_kwargs={\"k\": 20})\n",
     "\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -350,7 +350,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"

docs/docs/integrations/retrievers/metal.ipynb

@@ -123,7 +123,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"foo1\")"
+    "retriever.invoke(\"foo1\")"
    ]
   },
   {

docs/docs/integrations/retrievers/outline.ipynb

@@ -109,7 +109,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(query=\"LangChain\", doc_content_chars_max=100)"
+    "retriever.invoke(\"LangChain\", doc_content_chars_max=100)"
    ]
   },
   {

docs/docs/integrations/retrievers/pinecone_hybrid_search.ipynb

@@ -295,7 +295,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/pubmed.ipynb

@@ -53,7 +53,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"chatgpt\")"
+    "retriever.invoke(\"chatgpt\")"
    ]
   },
   {

docs/docs/integrations/retrievers/qdrant-sparse.ipynb

@@ -227,7 +227,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"Life and ethical dilemmas of AI\",\n",
     ")"
    ]

docs/docs/integrations/retrievers/re_phrase.ipynb

@@ -100,7 +100,7 @@
     }
    ],
    "source": [
-    "docs = retriever_from_llm.get_relevant_documents(\n",
+    "docs = retriever_from_llm.invoke(\n",
     "    \"Hi I'm Lance. What are the approaches to Task Decomposition?\"\n",
     ")"
    ]
@@ -120,7 +120,7 @@
     }
    ],
    "source": [
-    "docs = retriever_from_llm.get_relevant_documents(\n",
+    "docs = retriever_from_llm.invoke(\n",
     "    \"I live in San Francisco. What are the Types of Memory?\"\n",
     ")"
    ]
@@ -182,7 +182,7 @@
     }
    ],
    "source": [
-    "docs = retriever_from_llm_chain.get_relevant_documents(\n",
+    "docs = retriever_from_llm_chain.invoke(\n",
     "    \"Hi I'm Lance. What is Maximum Inner Product Search?\"\n",
     ")"
    ]

docs/docs/integrations/retrievers/self_query/activeloop_deeplake_self_query.ipynb

@@ -270,7 +270,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -300,7 +300,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")\n",
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")\n",
     "\n",
     "# in case if this example errored out, consider installing libdeeplake manually: `pip install libdeeplake`, and then restart notebook."
    ]
@@ -331,7 +331,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -360,9 +360,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -391,7 +389,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -457,7 +455,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/astradb.ipynb

@@ -192,7 +192,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs?\")"
+    "retriever.invoke(\"What are some movies about dinosaurs?\")"
    ]
   },
   {
@@ -202,7 +202,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -212,7 +212,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -222,9 +222,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5), science fiction movie ?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5), science fiction movie ?\")"
    ]
   },
   {
@@ -234,7 +232,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie about toys after 1990 but before 2005, and is animated\"\n",
     ")"
    ]
@@ -273,7 +271,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs?\")"
+    "retriever.invoke(\"What are two movies about dinosaurs?\")"
    ]
   },
   {

docs/docs/integrations/retrievers/self_query/chroma_self_query.ipynb

@@ -232,7 +232,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -262,7 +262,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -291,7 +291,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -320,9 +320,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -351,7 +349,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -418,7 +416,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   },
   {

docs/docs/integrations/retrievers/self_query/dashvector.ipynb

@@ -269,7 +269,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -308,7 +308,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -346,7 +346,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -384,9 +384,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -468,7 +466,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   },
   {

docs/docs/integrations/retrievers/self_query/databricks_vector_search.ipynb

@@ -352,7 +352,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -384,7 +384,7 @@
    ],
    "source": [
     "# This example specifies a filter\n",
-    "retriever.get_relevant_documents(\"What are some highly rated movies (above 9)?\")"
+    "retriever.invoke(\"What are some highly rated movies (above 9)?\")"
    ]
   },
   {
@@ -416,7 +416,7 @@
    ],
    "source": [
     "# This example specifies both a relevant query and a filter\n",
-    "retriever.get_relevant_documents(\"What are the thriller movies that are highly rated?\")"
+    "retriever.invoke(\"What are the thriller movies that are highly rated?\")"
    ]
   },
   {
@@ -438,7 +438,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about dinosaurs, \\\n",
     "    and preferably has a lot of action\"\n",
     ")"
@@ -520,7 +520,7 @@
    },
    "outputs": [],
    "source": [
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs?\")"
+    "retriever.invoke(\"What are two movies about dinosaurs?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/dingo.ipynb

@@ -265,7 +265,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -296,7 +296,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -326,7 +326,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -357,9 +357,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -389,7 +387,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -450,7 +448,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs\")"
+    "retriever.invoke(\"What are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/elasticsearch_self_query.ipynb

@@ -197,7 +197,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -219,7 +219,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -275,7 +275,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   },
   {
@@ -305,7 +305,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"what animated or comedy movies have been released in the last 30 years about animated toys?\"\n",
     ")"
    ]

docs/docs/integrations/retrievers/self_query/milvus_self_query.ipynb

@@ -190,7 +190,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -219,7 +219,7 @@
    ],
    "source": [
     "# This example specifies a filter\n",
-    "retriever.get_relevant_documents(\"What are some highly rated movies (above 9)?\")"
+    "retriever.invoke(\"What are some highly rated movies (above 9)?\")"
    ]
   },
   {
@@ -248,9 +248,7 @@
    ],
    "source": [
     "# This example only specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"I want to watch a movie about toys rated higher than 9\"\n",
-    ")"
+    "retriever.invoke(\"I want to watch a movie about toys rated higher than 9\")"
    ]
   },
   {
@@ -278,9 +276,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above or equal 9) thriller film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above or equal 9) thriller film?\")"
    ]
   },
   {
@@ -308,7 +304,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about dinosaurs, \\\n",
     "    and preferably has a lot of action\"\n",
     ")"
@@ -367,7 +363,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs?\")"
+    "retriever.invoke(\"What are two movies about dinosaurs?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/mongodb_atlas.ipynb

@@ -209,7 +209,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -219,7 +219,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a filter\n",
-    "retriever.get_relevant_documents(\"What are some highly rated movies (above 9)?\")"
+    "retriever.invoke(\"What are some highly rated movies (above 9)?\")"
    ]
   },
   {
@@ -229,9 +229,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"I want to watch a movie about toys rated higher than 9\"\n",
-    ")"
+    "retriever.invoke(\"I want to watch a movie about toys rated higher than 9\")"
    ]
   },
   {
@@ -241,9 +239,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above or equal 9) thriller film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above or equal 9) thriller film?\")"
    ]
   },
   {
@@ -253,7 +249,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about dinosaurs, \\\n",
     "    and preferably has a lot of action\"\n",
     ")"
@@ -293,7 +289,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs?\")"
+    "retriever.invoke(\"What are two movies about dinosaurs?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/myscale_self_query.ipynb

@@ -216,7 +216,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -227,7 +227,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -238,7 +238,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -249,9 +249,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -262,7 +260,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -285,7 +283,7 @@
    "outputs": [],
    "source": [
     "# You can use length(genres) to do anything you want\n",
-    "retriever.get_relevant_documents(\"What's a movie that have more than 1 genres?\")"
+    "retriever.invoke(\"What's a movie that have more than 1 genres?\")"
    ]
   },
   {
@@ -296,7 +294,7 @@
    "outputs": [],
    "source": [
     "# Fine-grained datetime? You got it already.\n",
-    "retriever.get_relevant_documents(\"What's a movie that release after feb 1995?\")"
+    "retriever.invoke(\"What's a movie that release after feb 1995?\")"
    ]
   },
   {
@@ -307,7 +305,7 @@
    "outputs": [],
    "source": [
     "# Don't know what your exact filter should be? Use string pattern match!\n",
-    "retriever.get_relevant_documents(\"What's a movie whose name is like Andrei?\")"
+    "retriever.invoke(\"What's a movie whose name is like Andrei?\")"
    ]
   },
   {
@@ -318,9 +316,7 @@
    "outputs": [],
    "source": [
     "# Contain works for lists: so you can match a list with contain comparator!\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a movie who has genres science fiction and adventure?\"\n",
-    ")"
+    "retriever.invoke(\"What's a movie who has genres science fiction and adventure?\")"
    ]
   },
   {
@@ -364,7 +360,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/opensearch_self_query.ipynb

@@ -203,7 +203,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -233,7 +233,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -262,7 +262,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -291,9 +291,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -356,7 +354,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   },
   {
@@ -393,7 +391,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"what animated or comedy movies have been released in the last 30 years about animated toys?\"\n",
     ")"
    ]

docs/docs/integrations/retrievers/self_query/pgvector_self_query.ipynb

@@ -188,7 +188,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -199,7 +199,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -210,7 +210,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -221,9 +221,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -234,7 +232,7 @@
    "outputs": [],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -280,7 +278,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/pinecone.ipynb

@@ -214,7 +214,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -244,7 +244,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -273,7 +273,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -302,9 +302,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -333,7 +331,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -375,7 +373,7 @@
    "outputs": [],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are two movies about dinosaurs\")"
+    "retriever.invoke(\"What are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/qdrant_self_query.ipynb

@@ -214,7 +214,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -244,7 +244,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -273,7 +273,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -302,9 +302,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -333,7 +331,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -399,7 +397,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/redis_self_query.ipynb

@@ -279,7 +279,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -310,7 +310,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.4\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.4\")"
    ]
   },
   {
@@ -339,7 +339,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -369,9 +369,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -400,7 +398,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -465,7 +463,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/supabase_self_query.ipynb

@@ -374,7 +374,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -404,7 +404,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -433,7 +433,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women?\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women?\")"
    ]
   },
   {
@@ -462,9 +462,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -493,7 +491,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before (or on) 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -558,7 +556,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/tencentvectordb.ipynb

@@ -297,7 +297,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"movies about a superhero\")"
+    "retriever.invoke(\"movies about a superhero\")"
    ]
   },
   {
@@ -323,7 +323,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"movies that were released after 2010\")"
+    "retriever.invoke(\"movies that were released after 2010\")"
    ]
   },
   {
@@ -349,9 +349,7 @@
    ],
    "source": [
     "# This example specifies both a relevant query and a filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"movies about a superhero which were released after 2010\"\n",
-    ")"
+    "retriever.invoke(\"movies about a superhero which were released after 2010\")"
    ]
   },
   {
@@ -413,7 +411,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"what are two movies about a superhero\")"
+    "retriever.invoke(\"what are two movies about a superhero\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/timescalevector_self_query.ipynb

@@ -334,7 +334,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -366,7 +366,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -396,7 +396,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -426,9 +426,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -457,7 +455,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -523,7 +521,7 @@
    ],
    "source": [
     "# This example specifies a query with a LIMIT value\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/vectara_self_query.ipynb

@@ -225,7 +225,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -248,7 +248,7 @@
    ],
    "source": [
     "# This example only specifies a filter\n",
-    "retriever.get_relevant_documents(\"I want to watch a movie rated higher than 8.5\")"
+    "retriever.invoke(\"I want to watch a movie rated higher than 8.5\")"
    ]
   },
   {
@@ -270,7 +270,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -292,9 +292,7 @@
    ],
    "source": [
     "# This example specifies a composite filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What's a highly rated (above 8.5) science fiction film?\"\n",
-    ")"
+    "retriever.invoke(\"What's a highly rated (above 8.5) science fiction film?\")"
    ]
   },
   {
@@ -316,7 +314,7 @@
    ],
    "source": [
     "# This example specifies a query and composite filter\n",
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"What's a movie after 1990 but before 2005 that's all about toys, and preferably is animated\"\n",
     ")"
    ]
@@ -374,7 +372,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/self_query/weaviate_self_query.ipynb

@@ -184,7 +184,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are some movies about dinosaurs\")"
+    "retriever.invoke(\"What are some movies about dinosaurs\")"
    ]
   },
   {
@@ -213,7 +213,7 @@
    ],
    "source": [
     "# This example specifies a query and a filter\n",
-    "retriever.get_relevant_documents(\"Has Greta Gerwig directed any movies about women\")"
+    "retriever.invoke(\"Has Greta Gerwig directed any movies about women\")"
    ]
   },
   {
@@ -276,7 +276,7 @@
    ],
    "source": [
     "# This example only specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"what are two movies about dinosaurs\")"
+    "retriever.invoke(\"what are two movies about dinosaurs\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/singlestoredb.ipynb

@@ -91,9 +91,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\n",
-    "    \"What did the president say about Ketanji Brown Jackson\"\n",
-    ")\n",
+    "result = retriever.invoke(\"What did the president say about Ketanji Brown Jackson\")\n",
     "print(docs[0].page_content)"
    ]
   }

docs/docs/integrations/retrievers/svm.ipynb

@@ -125,7 +125,7 @@
    },
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/tf_idf.ipynb

@@ -105,7 +105,7 @@
    },
    "outputs": [],
    "source": [
-    "result = retriever.get_relevant_documents(\"foo\")"
+    "result = retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -185,7 +185,7 @@
     }
    ],
    "source": [
-    "retriever_copy.get_relevant_documents(\"foo\")"
+    "retriever_copy.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/retrievers/thirdai_neuraldb.ipynb

@@ -95,7 +95,7 @@
    "outputs": [],
    "source": [
     "# This returns a list of LangChain Document objects\n",
-    "documents = retriever.get_relevant_documents(\"query\", top_k=10)"
+    "documents = retriever.invoke(\"query\", top_k=10)"
    ]
   },
   {

docs/docs/integrations/retrievers/vespa.ipynb

@@ -110,7 +110,7 @@
    },
    "outputs": [],
    "source": [
-    "retriever.get_relevant_documents(\"what is vespa?\")"
+    "retriever.invoke(\"what is vespa?\")"
    ]
   }
  ],

docs/docs/integrations/retrievers/weaviate-hybrid.ipynb

@@ -202,7 +202,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"the ethical implications of AI\")"
+    "retriever.invoke(\"the ethical implications of AI\")"
    ]
   },
   {
@@ -233,7 +233,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"AI integration in society\",\n",
     "    where_filter={\n",
     "        \"path\": [\"author\"],\n",
@@ -272,7 +272,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\n",
+    "retriever.invoke(\n",
     "    \"AI integration in society\",\n",
     "    score=True,\n",
     ")"

docs/docs/integrations/retrievers/wikipedia.ipynb

@@ -98,7 +98,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "docs = retriever.get_relevant_documents(query=\"HUNTER X HUNTER\")"
+    "docs = retriever.invoke(\"HUNTER X HUNTER\")"
    ]
   },
   {

docs/docs/integrations/retrievers/zep_memorystore.ipynb

@@ -314,7 +314,7 @@
     "    api_key=zep_api_key,\n",
     ")\n",
     "\n",
-    "await zep_retriever.aget_relevant_documents(\"Who wrote Parable of the Sower?\")"
+    "await zep_retriever.ainvoke(\"Who wrote Parable of the Sower?\")"
    ]
   },
   {
@@ -355,7 +355,7 @@
     }
    ],
    "source": [
-    "zep_retriever.get_relevant_documents(\"Who wrote Parable of the Sower?\")"
+    "zep_retriever.invoke(\"Who wrote Parable of the Sower?\")"
    ]
   },
   {
@@ -407,7 +407,7 @@
     "    mmr_lambda=0.5,\n",
     ")\n",
     "\n",
-    "await zep_retriever.aget_relevant_documents(\"Who wrote Parable of the Sower?\")"
+    "await zep_retriever.ainvoke(\"Who wrote Parable of the Sower?\")"
    ]
   },
   {
@@ -445,9 +445,7 @@
    "source": [
     "filter = {\"where\": {\"jsonpath\": '$[*] ? (@.Label == \"WORK_OF_ART\")'}}\n",
     "\n",
-    "await zep_retriever.aget_relevant_documents(\n",
-    "    \"Who wrote Parable of the Sower?\", metadata=filter\n",
-    ")"
+    "await zep_retriever.ainvoke(\"Who wrote Parable of the Sower?\", metadata=filter)"
    ]
   },
   {
@@ -491,7 +489,7 @@
     "    mmr_lambda=0.5,\n",
     ")\n",
     "\n",
-    "await zep_retriever.aget_relevant_documents(\"Who wrote Parable of the Sower?\")"
+    "await zep_retriever.ainvoke(\"Who wrote Parable of the Sower?\")"
    ]
   },
   {

docs/docs/integrations/text_embedding/upstage.ipynb

@@ -187,7 +187,7 @@
     "    embedding=UpstageEmbeddings(),\n",
     ")\n",
     "retriever = vectorstore.as_retriever()\n",
-    "docs = retriever.get_relevant_documents(\"Where did Harrison work?\")\n",
+    "docs = retriever.invoke(\"Where did Harrison work?\")\n",
     "print(docs)"
    ]
   }

docs/docs/integrations/text_embedding/voyageai.ipynb

@@ -196,7 +196,7 @@
     "retriever = KNNRetriever.from_texts(documents, embeddings)\n",
     "\n",
     "# retrieve the most relevant documents\n",
-    "result = retriever.get_relevant_documents(query)\n",
+    "result = retriever.invoke(query)\n",
     "top1_retrieved_doc = result[0].page_content  # return the top1 retrieved result\n",
     "\n",
     "print(top1_retrieved_doc)"

docs/docs/integrations/vectorstores/chroma.ipynb

@@ -510,7 +510,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   },
   {

docs/docs/integrations/vectorstores/dingo.ipynb

@@ -197,7 +197,7 @@
    "outputs": [],
    "source": [
     "retriever = docsearch.as_retriever(search_type=\"mmr\")\n",
-    "matched_docs = retriever.get_relevant_documents(query)\n",
+    "matched_docs = retriever.invoke(query)\n",
     "for i, d in enumerate(matched_docs):\n",
     "    print(f\"\\n## Document {i}\\n\")\n",
     "    print(d.page_content)"

docs/docs/integrations/vectorstores/google_vertex_ai_vector_search.ipynb

@@ -487,7 +487,7 @@
    "outputs": [],
    "source": [
     "# perform simple similarity search on retriever\n",
-    "retriever.get_relevant_documents(\"What are my options in breathable fabric?\")"
+    "retriever.invoke(\"What are my options in breathable fabric?\")"
    ]
   },
   {
@@ -503,7 +503,7 @@
     "retriever.search_kwargs = {\"filter\": filters}\n",
     "\n",
     "# perform similarity search with filters on retriever\n",
-    "retriever.get_relevant_documents(\"What are my options in breathable fabric?\")"
+    "retriever.invoke(\"What are my options in breathable fabric?\")"
    ]
   },
   {
@@ -520,7 +520,7 @@
     "\n",
     "retriever.search_kwargs = {\"filter\": filters, \"numeric_filter\": numeric_filters}\n",
     "\n",
-    "retriever.get_relevant_documents(\"What are my options in breathable fabric?\")"
+    "retriever.invoke(\"What are my options in breathable fabric?\")"
    ]
   },
   {

docs/docs/integrations/vectorstores/milvus.ipynb

@@ -291,9 +291,9 @@
    ],
    "source": [
     "# This will only get documents for Ankush\n",
-    "vectorstore.as_retriever(\n",
-    "    search_kwargs={\"expr\": 'namespace == \"ankush\"'}\n",
-    ").get_relevant_documents(\"where did i work?\")"
+    "vectorstore.as_retriever(search_kwargs={\"expr\": 'namespace == \"ankush\"'}).invoke(\n",
+    "    \"where did i work?\"\n",
+    ")"
    ]
   },
   {
@@ -320,9 +320,9 @@
    ],
    "source": [
     "# This will only get documents for Harrison\n",
-    "vectorstore.as_retriever(\n",
-    "    search_kwargs={\"expr\": 'namespace == \"harrison\"'}\n",
-    ").get_relevant_documents(\"where did i work?\")"
+    "vectorstore.as_retriever(search_kwargs={\"expr\": 'namespace == \"harrison\"'}).invoke(\n",
+    "    \"where did i work?\"\n",
+    ")"
    ]
   },
   {

docs/docs/integrations/vectorstores/neo4jvector.ipynb

@@ -694,7 +694,7 @@
    ],
    "source": [
     "retriever = store.as_retriever()\n",
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   },
   {

docs/docs/integrations/vectorstores/pinecone.ipynb

@@ -256,7 +256,7 @@
    ],
    "source": [
     "retriever = docsearch.as_retriever(search_type=\"mmr\")\n",
-    "matched_docs = retriever.get_relevant_documents(query)\n",
+    "matched_docs = retriever.invoke(query)\n",
     "for i, d in enumerate(matched_docs):\n",
     "    print(f\"\\n## Document {i}\\n\")\n",
     "    print(d.page_content)"

docs/docs/integrations/vectorstores/qdrant.ipynb

@@ -605,7 +605,7 @@
    ],
    "source": [
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   },
   {

docs/docs/integrations/vectorstores/redis.ipynb

@@ -1078,7 +1078,7 @@
     }
    ],
    "source": [
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "docs"
    ]
   },
@@ -1120,7 +1120,7 @@
     }
    ],
    "source": [
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "docs"
    ]
   },
@@ -1162,7 +1162,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"foo\")"
+    "retriever.invoke(\"foo\")"
    ]
   },
   {
@@ -1196,7 +1196,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"foo\")"
+    "retriever.invoke(\"foo\")"
    ]
   },
   {

docs/docs/integrations/vectorstores/supabase.ipynb

@@ -362,7 +362,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "matched_docs = retriever.get_relevant_documents(query)"
+    "matched_docs = retriever.invoke(query)"
    ]
   },
   {

docs/docs/integrations/vectorstores/tidb_vector.ipynb

@@ -418,7 +418,7 @@
     "    search_type=\"similarity_score_threshold\",\n",
     "    search_kwargs={\"k\": 3, \"score_threshold\": 0.8},\n",
     ")\n",
-    "docs_retrieved = retriever.get_relevant_documents(query)\n",
+    "docs_retrieved = retriever.invoke(query)\n",
     "for doc in docs_retrieved:\n",
     "    print(\"-\" * 80)\n",
     "    print(doc.page_content)\n",
@@ -538,7 +538,7 @@
     "    search_kwargs={\"k\": 3, \"score_threshold\": 0.85},\n",
     ")\n",
     "semantic_query = \"Could you recommend a US airport with clean lounges and good vegetarian dining options?\"\n",
-    "reviews = retriever.get_relevant_documents(semantic_query)\n",
+    "reviews = retriever.invoke(semantic_query)\n",
     "for r in reviews:\n",
     "    print(\"-\" * 80)\n",
     "    print(r.page_content)\n",

docs/docs/integrations/vectorstores/tiledb.ipynb

@@ -132,7 +132,7 @@
    "outputs": [],
    "source": [
     "retriever = db.as_retriever(search_type=\"mmr\")\n",
-    "retriever.get_relevant_documents(query)"
+    "retriever.invoke(query)"
    ]
   },
   {

docs/docs/integrations/vectorstores/timescalevector.ipynb

@@ -1350,7 +1350,7 @@
    ],
    "source": [
     "# This example specifies a relevant query\n",
-    "retriever.get_relevant_documents(\"What are improvements made to continuous aggregates?\")"
+    "retriever.invoke(\"What are improvements made to continuous aggregates?\")"
    ]
   },
   {
@@ -1381,7 +1381,7 @@
    ],
    "source": [
     "# This example specifies a filter\n",
-    "retriever.get_relevant_documents(\"What commits did Sven Klemm add?\")"
+    "retriever.invoke(\"What commits did Sven Klemm add?\")"
    ]
   },
   {
@@ -1412,9 +1412,7 @@
    ],
    "source": [
     "# This example specifies a query and filter\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What commits about timescaledb_functions did Sven Klemm add?\"\n",
-    ")"
+    "retriever.invoke(\"What commits about timescaledb_functions did Sven Klemm add?\")"
    ]
   },
   {
@@ -1445,7 +1443,7 @@
    ],
    "source": [
     "# This example specifies a time-based filter\n",
-    "retriever.get_relevant_documents(\"What commits were added in July 2023?\")"
+    "retriever.invoke(\"What commits were added in July 2023?\")"
    ]
   },
   {
@@ -1474,9 +1472,7 @@
    ],
    "source": [
     "# This example specifies a query and a LIMIT value\n",
-    "retriever.get_relevant_documents(\n",
-    "    \"What are two commits about hierarchical continuous aggregates?\"\n",
-    ")"
+    "retriever.invoke(\"What are two commits about hierarchical continuous aggregates?\")"
    ]
   },
   {

docs/docs/integrations/vectorstores/typesense.ipynb

@@ -216,7 +216,7 @@
    "outputs": [],
    "source": [
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   }
  ],

docs/docs/integrations/vectorstores/vald.ipynb

@@ -129,7 +129,7 @@
    "outputs": [],
    "source": [
     "retriever = db.as_retriever(search_type=\"mmr\")\n",
-    "retriever.get_relevant_documents(query)"
+    "retriever.invoke(query)"
    ]
   },
   {
@@ -279,7 +279,7 @@
     "retriever = db.as_retriever(\n",
     "    search_kwargs={\"search_type\": \"mmr\", \"grpc_metadata\": metadata}\n",
     ")\n",
-    "retriever.get_relevant_documents(query, grpc_metadata=metadata)"
+    "retriever.invoke(query, grpc_metadata=metadata)"
    ]
   },
   {

docs/docs/integrations/vectorstores/vdms.ipynb

@@ -895,7 +895,7 @@
    ],
    "source": [
     "retriever = db.as_retriever()\n",
-    "relevant_docs = retriever.get_relevant_documents(query)[0]\n",
+    "relevant_docs = retriever.invoke(query)[0]\n",
     "\n",
     "print_document_details(relevant_docs)"
    ]
@@ -940,7 +940,7 @@
    ],
    "source": [
     "retriever = db.as_retriever(search_type=\"mmr\")\n",
-    "relevant_docs = retriever.get_relevant_documents(query)[0]\n",
+    "relevant_docs = retriever.invoke(query)[0]\n",
     "\n",
     "print_document_details(relevant_docs)"
    ]

docs/docs/integrations/vectorstores/vectara.ipynb

@@ -522,7 +522,7 @@
    ],
    "source": [
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   },
   {

docs/docs/integrations/vectorstores/vespa.ipynb

@@ -408,7 +408,7 @@
     "db = VespaStore.from_documents(docs, embedding_function, app=vespa_app, **vespa_config)\n",
     "retriever = db.as_retriever()\n",
     "query = \"What did the president say about Ketanji Brown Jackson\"\n",
-    "results = retriever.get_relevant_documents(query)\n",
+    "results = retriever.invoke(query)\n",
     "\n",
     "# results[0].metadata[\"id\"] == \"id:testapp:testapp::32\""
    ]

docs/docs/integrations/vectorstores/weaviate.ipynb

@@ -536,7 +536,7 @@
    ],
    "source": [
     "retriever = db.as_retriever(search_type=\"mmr\")\n",
-    "retriever.get_relevant_documents(query)[0]"
+    "retriever.invoke(query)[0]"
    ]
   },
   {

docs/docs/modules/agents/quick_start.ipynb

@@ -155,7 +155,7 @@
     }
    ],
    "source": [
-    "retriever.get_relevant_documents(\"how to upload a dataset\")[0]"
+    "retriever.invoke(\"how to upload a dataset\")[0]"
    ]
   },
   {

docs/docs/modules/data_connection/retrievers/MultiQueryRetriever.ipynb

@@ -104,7 +104,7 @@
     }
    ],
    "source": [
-    "unique_docs = retriever_from_llm.get_relevant_documents(query=question)\n",
+    "unique_docs = retriever_from_llm.invoke(question)\n",
     "len(unique_docs)"
    ]
   },
@@ -199,9 +199,7 @@
     ")  # \"lines\" is the key (attribute name) of the parsed output\n",
     "\n",
     "# Results\n",
-    "unique_docs = retriever.get_relevant_documents(\n",
-    "    query=\"What does the course say about regression?\"\n",
-    ")\n",
+    "unique_docs = retriever.invoke(query=\"What does the course say about regression?\")\n",
     "len(unique_docs)"
    ]
   }

docs/docs/modules/data_connection/retrievers/contextual_compression.ipynb

@@ -128,9 +128,7 @@
     "texts = text_splitter.split_documents(documents)\n",
     "retriever = FAISS.from_documents(texts, OpenAIEmbeddings()).as_retriever()\n",
     "\n",
-    "docs = retriever.get_relevant_documents(\n",
-    "    \"What did the president say about Ketanji Brown Jackson\"\n",
-    ")\n",
+    "docs = retriever.invoke(\"What did the president say about Ketanji Brown Jackson\")\n",
     "pretty_print_docs(docs)"
    ]
   },
@@ -184,7 +182,7 @@
     "    base_compressor=compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"
@@ -245,7 +243,7 @@
     "    base_compressor=_filter, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"
@@ -321,7 +319,7 @@
     "    base_compressor=embeddings_filter, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"
@@ -398,7 +396,7 @@
     "    base_compressor=pipeline_compressor, base_retriever=retriever\n",
     ")\n",
     "\n",
-    "compressed_docs = compression_retriever.get_relevant_documents(\n",
+    "compressed_docs = compression_retriever.invoke(\n",
     "    \"What did the president say about Ketanji Jackson Brown\"\n",
     ")\n",
     "pretty_print_docs(compressed_docs)"

docs/docs/modules/data_connection/retrievers/long_context_reorder.ipynb

@@ -83,7 +83,7 @@
     "query = \"What can you tell me about the Celtics?\"\n",
     "\n",
     "# Get relevant documents ordered by relevance score\n",
-    "docs = retriever.get_relevant_documents(query)\n",
+    "docs = retriever.invoke(query)\n",
     "docs"
    ]
   },

docs/docs/modules/data_connection/retrievers/multi_vector.ipynb

@@ -175,7 +175,7 @@
    ],
    "source": [
     "# Retriever returns larger chunks\n",
-    "len(retriever.get_relevant_documents(\"justice breyer\")[0].page_content)"
+    "len(retriever.invoke(\"justice breyer\")[0].page_content)"
    ]
   },
   {
@@ -208,7 +208,7 @@
     "\n",
     "retriever.search_type = SearchType.mmr\n",
     "\n",
-    "len(retriever.get_relevant_documents(\"justice breyer\")[0].page_content)"
+    "len(retriever.invoke(\"justice breyer\")[0].page_content)"
    ]
   },
   {
@@ -357,7 +357,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retrieved_docs = retriever.get_relevant_documents(\"justice breyer\")"
+    "retrieved_docs = retriever.invoke(\"justice breyer\")"
    ]
   },
   {
@@ -560,7 +560,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retrieved_docs = retriever.get_relevant_documents(\"justice breyer\")"
+    "retrieved_docs = retriever.invoke(\"justice breyer\")"
    ]
   },
   {

docs/docs/modules/data_connection/retrievers/parent_document_retriever.ipynb

@@ -190,7 +190,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retrieved_docs = retriever.get_relevant_documents(\"justice breyer\")"
+    "retrieved_docs = retriever.invoke(\"justice breyer\")"
    ]
   },
   {
@@ -343,7 +343,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "retrieved_docs = retriever.get_relevant_documents(\"justice breyer\")"
+    "retrieved_docs = retriever.invoke(\"justice breyer\")"
    ]
   },
   {

docs/docs/modules/data_connection/retrievers/time_weighted_vectorstore.ipynb

@@ -107,7 +107,7 @@
    ],
    "source": [
     "# \"Hello World\" is returned first because it is most salient, and the decay rate is close to 0., meaning it's still recent enough\n",
-    "retriever.get_relevant_documents(\"hello world\")"
+    "retriever.invoke(\"hello world\")"
    ]
   },
   {
@@ -183,7 +183,7 @@
    ],
    "source": [
     "# \"Hello Foo\" is returned first because \"hello world\" is mostly forgotten\n",
-    "retriever.get_relevant_documents(\"hello world\")"
+    "retriever.invoke(\"hello world\")"
    ]
   },
   {
@@ -225,7 +225,7 @@
    "source": [
     "# Notice the last access time is that date time\n",
     "with mock_now(datetime.datetime(2024, 2, 3, 10, 11)):\n",
-    "    print(retriever.get_relevant_documents(\"hello world\"))"
+    "    print(retriever.invoke(\"hello world\"))"
    ]
   },
   {

docs/docs/modules/data_connection/retrievers/vectorstore.ipynb

@@ -70,7 +70,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "docs = retriever.get_relevant_documents(\"what did he say about ketanji brown jackson\")"
+    "docs = retriever.invoke(\"what did he say about ketanji brown jackson\")"
    ]
   },
   {
@@ -100,7 +100,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "docs = retriever.get_relevant_documents(\"what did he say about ketanji brown jackson\")"
+    "docs = retriever.invoke(\"what did he say about ketanji brown jackson\")"
    ]
   },
   {
@@ -133,7 +133,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "docs = retriever.get_relevant_documents(\"what did he say about ketanji brown jackson\")"
+    "docs = retriever.invoke(\"what did he say about ketanji brown jackson\")"
    ]
   },
   {
@@ -174,7 +174,7 @@
     }
    ],
    "source": [
-    "docs = retriever.get_relevant_documents(\"what did he say about ketanji brown jackson\")\n",
+    "docs = retriever.invoke(\"what did he say about ketanji brown jackson\")\n",
     "len(docs)"
    ]
   },

docs/docs/use_cases/question_answering/per_user.ipynb

@@ -105,7 +105,7 @@
    ],
    "source": [
     "# This will only get documents for Ankush\n",
-    "vectorstore.as_retriever(search_kwargs={\"namespace\": \"ankush\"}).get_relevant_documents(\n",
+    "vectorstore.as_retriever(search_kwargs={\"namespace\": \"ankush\"}).invoke(\n",
     "    \"where did i work?\"\n",
     ")"
    ]
@@ -129,9 +129,9 @@
    ],
    "source": [
     "# This will only get documents for Harrison\n",
-    "vectorstore.as_retriever(\n",
-    "    search_kwargs={\"namespace\": \"harrison\"}\n",
-    ").get_relevant_documents(\"where did i work?\")"
+    "vectorstore.as_retriever(search_kwargs={\"namespace\": \"harrison\"}).invoke(\n",
+    "    \"where did i work?\"\n",
+    ")"
    ]
   },
   {