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>
This commit is contained in:
ccurme
2024-04-22 11:14:53 -04:00
committed by GitHub
parent 939d113d10
commit c010ec8b71
171 changed files with 443 additions and 535 deletions

View File

@@ -27,7 +27,7 @@ def test_backends(request: Any, backend: Any) -> None:
content_field="title",
)
docs = retriever.get_relevant_documents("my docs")
docs = retriever.invoke("my docs")
assert len(docs) == 1
assert "My document" in docs[0].page_content
@@ -43,7 +43,7 @@ def test_backends(request: Any, backend: Any) -> None:
filters=filter_query,
)
docs = retriever.get_relevant_documents("my docs")
docs = retriever.invoke("my docs")
assert len(docs) == 1
assert "My document" in docs[0].page_content
@@ -61,7 +61,7 @@ def test_backends(request: Any, backend: Any) -> None:
filters=filter_query,
)
docs = retriever.get_relevant_documents("my docs")
docs = retriever.invoke("my docs")
assert len(docs) == 1
assert "My document" in docs[0].page_content