test_add_documents_documents() — langchain Function Reference

Source Code

libs/standard-tests/langchain_tests/integration_tests/vectorstores.py lines 399–438

    def test_add_documents_documents(self, vectorstore: VectorStore) -> None:
        """Run `add_documents` tests.

        ??? note "Troubleshooting"

            If this test fails, check that `get_by_ids` is implemented and returns
            documents in the same order as the IDs passed in.

            Check also that `add_documents` will correctly generate string IDs if
            none are provided.

            !!! note
                `get_by_ids` was added to the `VectorStore` interface in
                `langchain-core` version 0.2.11. If difficult to implement, this
                test can be skipped by setting the `has_get_by_ids` property to
                `False`.

                ```python
                @property
                def has_get_by_ids(self) -> bool:
                    return False
                ```
        """
        if not self.has_sync:
            pytest.skip("Sync tests not supported.")

        if not self.has_get_by_ids:
            pytest.skip("get_by_ids not implemented.")

        documents = [
            Document(page_content="foo", metadata={"id": 1}),
            Document(page_content="bar", metadata={"id": 2}),
        ]
        ids = vectorstore.add_documents(documents)
        assert _sort_by_id(vectorstore.get_by_ids(ids)) == _sort_by_id(
            [
                Document(page_content="foo", metadata={"id": 1}, id=ids[0]),
                Document(page_content="bar", metadata={"id": 2}, id=ids[1]),
            ]
        )