github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-08-12 06:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

standard-tests: sync/async vectorstore tests conditional (#28636)

Browse Source 
Co-authored-by: Chester Curme <chester.curme@gmail.com>
This commit is contained in:
Erick Friis 2024-12-09 10:02:55 -08:00 committed by GitHub
parent ffb5c1905a
commit 4c70ffff01
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 101 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
libs/standard-tests/langchain_tests/integration_tests/vectorstores.py
View File

@ -76,6 +76,21 @@ class VectorStoreIntegrationTests(BaseStandardTests):
store.delete_collection() store.delete_collection()
pass pass
Note that by default we enable both sync and async tests. To disable either,
override the ``has_sync`` or ``has_async`` properties to ``False`` in the
subclass. For example:
.. code-block:: python
class TestParrotVectorStore(VectorStoreIntegrationTests):
@pytest.fixture()
def vectorstore(self) -> Generator[VectorStore, None, None]: # type: ignore
...
@property
def has_async(self) -> bool:
return False
.. note:: .. note::
API references for individual test methods include troubleshooting tips. API references for individual test methods include troubleshooting tips.
""" # noqa: E501 """ # noqa: E501
@ -88,6 +103,20 @@ class VectorStoreIntegrationTests(BaseStandardTests):
The returned vectorstore should be EMPTY. The returned vectorstore should be EMPTY.
""" """
@property
def has_sync(self) -> bool:
"""
Configurable property to enable or disable sync tests.
"""
return True
@property
def has_async(self) -> bool:
"""
Configurable property to enable or disable async tests.
"""
return True
@staticmethod @staticmethod
def get_embeddings() -> Embeddings: def get_embeddings() -> Embeddings:
"""A pre-defined embeddings model that should be used for this test. """A pre-defined embeddings model that should be used for this test.
@ -110,6 +139,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
``VectorStoreIntegrationTests``) initializes an empty vector store in the ``VectorStoreIntegrationTests``) initializes an empty vector store in the
``vectorestore`` fixture. ``vectorestore`` fixture.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
assert vectorstore.similarity_search("foo", k=1) == [] assert vectorstore.similarity_search("foo", k=1) == []
def test_add_documents(self, vectorstore: VectorStore) -> None: def test_add_documents(self, vectorstore: VectorStore) -> None:
@ -123,6 +155,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
2. Calling ``.similarity_search`` for the top ``k`` similar documents does not threshold by score. 2. Calling ``.similarity_search`` for the top ``k`` similar documents does not threshold by score.
3. We do not mutate the original document object when adding it to the vector store (e.g., by adding an ID). 3. We do not mutate the original document object when adding it to the vector store (e.g., by adding an ID).
""" # noqa: E501 """ # noqa: E501
if not self.has_sync:
pytest.skip("Sync tests not supported.")
original_documents = [ original_documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -152,6 +187,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
``VectorStoreIntegrationTests``) correctly clears the vector store in the ``VectorStoreIntegrationTests``) correctly clears the vector store in the
``finally`` block. ``finally`` block.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
assert vectorstore.similarity_search("foo", k=1) == [] assert vectorstore.similarity_search("foo", k=1) == []
def test_deleting_documents(self, vectorstore: VectorStore) -> None: def test_deleting_documents(self, vectorstore: VectorStore) -> None:
@ -163,6 +201,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
passed in through ``ids``, and that ``delete`` correctly removes passed in through ``ids``, and that ``delete`` correctly removes
documents. documents.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -181,6 +222,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
If this test fails, check that ``delete`` correctly removes multiple If this test fails, check that ``delete`` correctly removes multiple
documents when given a list of IDs. documents when given a list of IDs.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -200,6 +244,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
If this test fails, check that ``delete`` does not raise an exception If this test fails, check that ``delete`` does not raise an exception
when deleting IDs that do not exist. when deleting IDs that do not exist.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
vectorstore.delete(["1"]) vectorstore.delete(["1"])
vectorstore.delete(["1", "2", "3"]) vectorstore.delete(["1", "2", "3"])
@ -214,6 +261,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
same IDs has the same effect as adding it once (i.e., it does not same IDs has the same effect as adding it once (i.e., it does not
duplicate the documents). duplicate the documents).
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -235,6 +285,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
ID that already exists in the vector store, the content is updated ID that already exists in the vector store, the content is updated
rather than duplicated. rather than duplicated.
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -283,6 +336,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
def test_get_by_ids(self, vectorstore: VectorStore) -> None: def test_get_by_ids(self, vectorstore: VectorStore) -> None:
super().test_get_by_ids(vectorstore) super().test_get_by_ids(vectorstore)
""" """
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -313,6 +369,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
def test_get_by_ids_missing(self, vectorstore: VectorStore) -> None: def test_get_by_ids_missing(self, vectorstore: VectorStore) -> None:
super().test_get_by_ids_missing(vectorstore) super().test_get_by_ids_missing(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_sync:
pytest.skip("Sync tests not supported.")
# This should not raise an exception # This should not raise an exception
documents = vectorstore.get_by_ids(["1", "2", "3"]) documents = vectorstore.get_by_ids(["1", "2", "3"])
assert documents == [] assert documents == []
@ -339,6 +398,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
def test_add_documents_documents(self, vectorstore: VectorStore) -> None: def test_add_documents_documents(self, vectorstore: VectorStore) -> None:
super().test_add_documents_documents(vectorstore) super().test_add_documents_documents(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -373,6 +435,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
def test_add_documents_with_existing_ids(self, vectorstore: VectorStore) -> None: def test_add_documents_with_existing_ids(self, vectorstore: VectorStore) -> None:
super().test_add_documents_with_existing_ids(vectorstore) super().test_add_documents_with_existing_ids(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_sync:
pytest.skip("Sync tests not supported.")
documents = [ documents = [
Document(id="foo", page_content="foo", metadata={"id": 1}), Document(id="foo", page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -393,6 +458,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
``VectorStoreIntegrationTests``) initializes an empty vector store in the ``VectorStoreIntegrationTests``) initializes an empty vector store in the
``vectorestore`` fixture. ``vectorestore`` fixture.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
assert await vectorstore.asimilarity_search("foo", k=1) == [] assert await vectorstore.asimilarity_search("foo", k=1) == []
async def test_add_documents_async(self, vectorstore: VectorStore) -> None: async def test_add_documents_async(self, vectorstore: VectorStore) -> None:
@ -406,6 +474,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
2. Calling ``.asimilarity_search`` for the top ``k`` similar documents does not threshold by score. 2. Calling ``.asimilarity_search`` for the top ``k`` similar documents does not threshold by score.
3. We do not mutate the original document object when adding it to the vector store (e.g., by adding an ID). 3. We do not mutate the original document object when adding it to the vector store (e.g., by adding an ID).
""" # noqa: E501 """ # noqa: E501
if not self.has_async:
pytest.skip("Async tests not supported.")
original_documents = [ original_documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -438,6 +509,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
``VectorStoreIntegrationTests``) correctly clears the vector store in the ``VectorStoreIntegrationTests``) correctly clears the vector store in the
``finally`` block. ``finally`` block.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
assert await vectorstore.asimilarity_search("foo", k=1) == [] assert await vectorstore.asimilarity_search("foo", k=1) == []
async def test_deleting_documents_async(self, vectorstore: VectorStore) -> None: async def test_deleting_documents_async(self, vectorstore: VectorStore) -> None:
@ -449,6 +523,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
passed in through ``ids``, and that ``delete`` correctly removes passed in through ``ids``, and that ``delete`` correctly removes
documents. documents.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -469,6 +546,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
If this test fails, check that ``adelete`` correctly removes multiple If this test fails, check that ``adelete`` correctly removes multiple
documents when given a list of IDs. documents when given a list of IDs.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -488,6 +568,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
If this test fails, check that ``adelete`` does not raise an exception If this test fails, check that ``adelete`` does not raise an exception
when deleting IDs that do not exist. when deleting IDs that do not exist.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
await vectorstore.adelete(["1"]) await vectorstore.adelete(["1"])
await vectorstore.adelete(["1", "2", "3"]) await vectorstore.adelete(["1", "2", "3"])
@ -502,6 +585,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
same IDs has the same effect as adding it once (i.e., it does not same IDs has the same effect as adding it once (i.e., it does not
duplicate the documents). duplicate the documents).
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -525,6 +611,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
ID that already exists in the vector store, the content is updated ID that already exists in the vector store, the content is updated
rather than duplicated. rather than duplicated.
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -573,6 +662,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
async def test_get_by_ids(self, vectorstore: VectorStore) -> None: async def test_get_by_ids(self, vectorstore: VectorStore) -> None:
await super().test_get_by_ids(vectorstore) await super().test_get_by_ids(vectorstore)
""" """
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -603,6 +695,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
async def test_get_by_ids_missing(self, vectorstore: VectorStore) -> None: async def test_get_by_ids_missing(self, vectorstore: VectorStore) -> None:
await super().test_get_by_ids_missing(vectorstore) await super().test_get_by_ids_missing(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_async:
pytest.skip("Async tests not supported.")
# This should not raise an exception # This should not raise an exception
assert await vectorstore.aget_by_ids(["1", "2", "3"]) == [] assert await vectorstore.aget_by_ids(["1", "2", "3"]) == []
@ -630,6 +725,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
async def test_add_documents_documents(self, vectorstore: VectorStore) -> None: async def test_add_documents_documents(self, vectorstore: VectorStore) -> None:
await super().test_add_documents_documents(vectorstore) await super().test_add_documents_documents(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(page_content="foo", metadata={"id": 1}), Document(page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),
@ -666,6 +764,9 @@ class VectorStoreIntegrationTests(BaseStandardTests):
async def test_add_documents_with_existing_ids(self, vectorstore: VectorStore) -> None: async def test_add_documents_with_existing_ids(self, vectorstore: VectorStore) -> None:
await super().test_add_documents_with_existing_ids(vectorstore) await super().test_add_documents_with_existing_ids(vectorstore)
""" # noqa: E501 """ # noqa: E501
if not self.has_async:
pytest.skip("Async tests not supported.")
documents = [ documents = [
Document(id="foo", page_content="foo", metadata={"id": 1}), Document(id="foo", page_content="foo", metadata={"id": 1}),
Document(page_content="bar", metadata={"id": 2}), Document(page_content="bar", metadata={"id": 2}),