RetrieversIntegrationTests

If the retriever doesn't support configuring the number of results returned via the constructor, this test can be skipped using a pytest xfail on the test class:

@pytest.mark.xfail(
    reason="This retriever doesn't support setting "
    "the number of results via the constructor."
)
def test_k_constructor_param(self) -> None:
    raise NotImplementedError

If this test fails, the retriever constructor does not accept a number of results parameter, or the retriever does not return the correct number of documents ( of the one set in num_results_arg_name) when it is set.

For example, a retriever like...

MyRetriever(k=3).invoke("query")

...should return 3 documents when invoked with a query.

If the retriever doesn't support configuring the number of results returned via the invoke method, this test can be skipped using a pytest xfail on the test class:

@pytest.mark.xfail(
    reason="This retriever doesn't support setting "
    "the number of results in the invoke method."
)
def test_invoke_with_k_kwarg(self) -> None:
    raise NotImplementedError

If this test fails, the retriever's invoke method does not accept a number of results parameter, or the retriever does not return the correct number of documents (k of the one set in num_results_arg_name) when it is set.

For example, a retriever like...

MyRetriever().invoke("query", k=3)

...should return 3 documents when invoked with a query.

If this test fails, the retriever's invoke method does not return a list of Document objects. Please confirm that your _get_relevant_documents method returns a list of Document objects.