faiss-haystack 1.0.0__tar.gz → 2.1.0__tar.gz

faiss_haystack-2.1.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [integrations/faiss-v2.0.0] - 2026-03-23
+
+### 🧪 Testing
+
+- Test compatible integrations with python 3.14; update pyproject (#3001)
+- `FaissDocumentStore` use Mixin tests (#3024)
+
+### ⚙️ CI
+
+- Adding FAISS github workflow (#2879)
+
+### 🧹 Chores
+
+- FAISS - small changes to improve consistency with the codebase (#2890)
+- Standardize author mentions (#2897)
+- Add ANN type annotations to faiss, fastembed, firecrawl, github, google_ai (#2988)
+- Enforce ruff docstring rules (D102/D103/D205/D209/D213/D417/D419) in integrations 11-20 (#3009)
+
+### 🌀 Miscellaneous
+
+- Add FAISS DocumentStore integration (#2844)
+
+<!-- generated by git-cliff -->

faiss_haystack-2.1.0/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-present deepset GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/PKG-INFO

@@ -1,39 +1,39 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: faiss-haystack
-Version: 1.0.0
+Version: 2.1.0
+Summary: An integration of FAISS (library for efficient similarity search of dense vectors) with Haystack
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/faiss#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/faiss
-Author-email: Deepset <info@deepset.ai>
+Author-email: deepset GmbH <info@deepset.ai>
 License-Expression: Apache-2.0
+License-File: LICENSE.txt
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Requires-Dist: faiss-cpu>=1.8.0
-Requires-Dist: haystack-ai>=2.24.0
+Requires-Dist: haystack-ai>=2.26.1
 Requires-Dist: numpy<2,>=1.22; python_version < '3.13'
 Description-Content-Type: text/markdown
 
 # faiss-haystack
 
-This package provides a [FAISS](https://github.com/facebookresearch/faiss) document store for [Haystack](https://github.com/deepset-ai/haystack).
+[![PyPI - Version](https://img.shields.io/pypi/v/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
 
-## Installation
+- [Integration page](https://haystack.deepset.ai/integrations/faiss)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/faiss/CHANGELOG.md)
 
-```bash
-pip install faiss-haystack
-```
+---
 
-## Usage
+## Contributing
 
-```python
-from haystack_integrations.document_stores.faiss import FAISSDocumentStore
-
-document_store = FAISSDocumentStore(index_path="my_index")
-```
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

faiss_haystack-2.1.0/README.md

@@ -0,0 +1,13 @@
+# faiss-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/faiss-haystack.svg)](https://pypi.org/project/faiss-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/faiss)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/faiss/CHANGELOG.md)
+
+---
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/pyproject.toml

@@ -5,12 +5,12 @@ build-backend = "hatchling.build"
 [project]
 name = "faiss-haystack"
 dynamic = ["version"]
-description = ''
+description = 'An integration of FAISS (library for efficient similarity search of dense vectors) with Haystack'
 readme = "README.md"
 requires-python = ">=3.10"
 license = "Apache-2.0"
 keywords = []
-authors = [{ name = "Deepset", email = "info@deepset.ai" }]
+authors = [{ name = "deepset GmbH", email = "info@deepset.ai" }]
 classifiers = [
   "License :: OSI Approved :: Apache Software License",
   "Development Status :: 4 - Beta",
@@ -18,11 +18,13 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
 dependencies = [
-  "haystack-ai>=2.24.0",
+  "haystack-ai>=2.26.1",
   "faiss-cpu>=1.8.0",
   "numpy>=1.22,<2; python_version < '3.13'",
 ]
@@ -48,7 +50,7 @@ installer = "uv"
 dependencies = ["haystack-pydoc-tools", "ruff"]
 
 [tool.hatch.envs.default.scripts]
-docs = ["pydoc-markdown pydoc/config_docusaurus.yml"]
+docs = ["haystack-pydoc pydoc/config_docusaurus.yml"]
 fmt = "ruff check --fix {args}; ruff format {args}"
 fmt-check = "ruff check {args} && ruff format --check {args}"
 
@@ -59,13 +61,15 @@ dependencies = [
     "pytest-rerunfailures",
     "mypy",
     "pandas",
+    "pip",    # needed for mypy to install type stubs
 ]
 
 [tool.hatch.envs.test.scripts]
 unit = 'pytest -m "not integration" {args:tests}'
 integration = 'pytest -m "integration" {args:tests}'
 all = 'pytest {args:tests}'
-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x {args:tests}'
+unit-cov-retry = 'pytest --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x -m "not integration" {args:tests}'
+integration-cov-append-retry = 'pytest --cov=haystack_integrations --cov-append --reruns 3 --reruns-delay 30 -x -m "integration" {args:tests}'
 
 types = "mypy -p haystack_integrations.document_stores.faiss -p haystack_integrations.components.retrievers.faiss {args}"
 
@@ -75,8 +79,12 @@ non_interactive = true
 check_untyped_defs = true
 disallow_incomplete_defs = true
 
-[tool.hatch.metadata]
-allow-direct-references = true
+[[tool.mypy.overrides]]
+module = [
+  # faiss does not provide types
+  "faiss.*",
+]
+ignore_missing_imports = true
 
 [tool.ruff]
 line-length = 120
@@ -84,9 +92,17 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -124,10 +140,13 @@ ignore = [
   "PLR0912",
   "PLR0913",
   "PLR0915",
+  "PLR0917",
   # Ignore unused params
   "ARG002",
   # Allow assertions
   "S101",
+  # Allow `Any` - used legitimately for dynamic types and SDK boundaries
+  "ANN401",
 ]
 exclude = ["example"]
 
@@ -139,12 +158,13 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"tests/**/*" = ["D", "PLR2004", "S101", "TID252", "ANN"]
 "example/**/*" = ["T201"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
 branch = true
+relative_files = true
 parallel = false
 
 
@@ -156,4 +176,5 @@ exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
 [tool.pytest.ini_options]
 minversion = "6.0"
+addopts = "--strict-markers"
 markers = ["integration: integration tests"]

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/src/haystack_integrations/components/retrievers/faiss/embedding_retriever.py

@@ -20,7 +20,9 @@ class FAISSEmbeddingRetriever:
     Example usage:
     ```python
     from haystack import Document, Pipeline
-    from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
+    # Requires: pip install sentence-transformers-haystack
+    from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
+    from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
     from haystack.document_stores.types import DuplicatePolicy
 
     from haystack_integrations.document_stores.faiss import FAISSDocumentStore
@@ -35,7 +37,6 @@ class FAISSEmbeddingRetriever:
     ]
 
     document_embedder = SentenceTransformersDocumentEmbedder()
-    document_embedder.warm_up()
     documents_with_embeddings = document_embedder.run(documents)["documents"]
 
     document_store.write_documents(documents_with_embeddings, policy=DuplicatePolicy.OVERWRITE)
@@ -59,8 +60,10 @@ class FAISSEmbeddingRetriever:
         filters: dict[str, Any] | None = None,
         top_k: int = 10,
         filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
-    ):
+    ) -> None:
         """
+        Initialize FAISSEmbeddingRetriever.
+
         :param document_store: An instance of `FAISSDocumentStore`.
         :param filters: Filters applied to the retrieved Documents at initialisation time. At runtime, these are merged
             with any runtime filters according to the `filter_policy`.

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/src/haystack_integrations/document_stores/faiss/document_store.py

@@ -9,7 +9,6 @@ from dataclasses import replace
 from pathlib import Path
 from typing import Any
 
-import faiss  # type: ignore[import-untyped]
 import numpy as np
 from haystack import default_from_dict, default_to_dict
 from haystack.dataclasses import Document
@@ -17,6 +16,8 @@ from haystack.document_stores.errors import DocumentStoreError, DuplicateDocumen
 from haystack.document_stores.types import DuplicatePolicy
 from haystack.errors import FilterError
 
+import faiss
+
 logger = logging.getLogger(__name__)
 
 
@@ -33,7 +34,7 @@ class FAISSDocumentStore:
         index_path: str | None = None,
         index_string: str = "Flat",
         embedding_dim: int = 768,
-    ):
+    ) -> None:
         """
         Initializes the FAISSDocumentStore.
 
@@ -60,7 +61,7 @@ class FAISSDocumentStore:
         else:
             self._create_new_index()
 
-    def _create_new_index(self):
+    def _create_new_index(self) -> None:
         """Creates a new FAISS index."""
         try:
             # We use IndexIDMap to support add_with_ids
@@ -457,11 +458,7 @@ class FAISSDocumentStore:
         """
         values = []
         for doc in self.documents.values():
-            val = (
-                FAISSDocumentStore._get_doc_value(doc, field_name)
-                if not field_name.startswith("meta.")
-                else doc.meta.get(field_name[5:])
-            )
+            val = FAISSDocumentStore._get_doc_value(doc, field_name)
             if val is not None:
                 values.append(val)
 
@@ -470,41 +467,71 @@ class FAISSDocumentStore:
 
         return {"min": min(values), "max": max(values)}
 
-    def get_metadata_field_unique_values(self, field_name: str) -> list[Any]:
-        """
-        Returns all unique values for a specific metadata field.
-
-        :param field_name: The name of the metadata field.
-        :returns: A list of unique values for the specified field.
+    def get_metadata_field_unique_values(
+        self,
+        metadata_field: str,
+        search_term: str | None = None,
+        from_: int = 0,
+        size: int = 10,
+        filters: dict[str, Any] | None = None,
+    ) -> tuple[list[Any], int]:
+        """
+        Returns unique values for a metadata field, optionally filtered by a search term, with pagination.
+
+        :param metadata_field: The metadata field to get unique values for. Can include or omit the "meta." prefix.
+        :param search_term: Optional search term to filter values, matched as a case-insensitive substring
+            against the metadata field's value.
+        :param from_: The offset to start returning values from (for pagination).
+        :param size: The maximum number of unique values to return.
+        :param filters: Optional filters to restrict the documents considered.
+        :returns: A tuple containing list of unique values (in their original type) and total count of
+            unique values.
         """
-        values = set()
-        for doc in self.documents.values():
-            val = (
-                FAISSDocumentStore._get_doc_value(doc, field_name)
-                if not field_name.startswith("meta.")
-                else doc.meta.get(field_name[5:])
-            )
+        values = []
+        for doc in self.filter_documents(filters=filters):
+            val = FAISSDocumentStore._get_doc_value(doc, metadata_field)
             if val is not None:
-                values.add(val)
-        return list(values)
+                values.append(val)
+
+        if search_term:
+            search_term_lower = search_term.lower()
+            values = [val for val in values if search_term_lower in str(val).lower()]
+
+        # Values of different types can be equal in Python (`1 == True`, `1 == 1.0`), so a plain set
+        # would silently merge them. Dedupe by (type, value) instead to keep them distinct.
+        seen: set[tuple[type, Any]] = set()
+        unique_values = []
+        for val in values:
+            dedup_key = (type(val), val)
+            if dedup_key not in seen:
+                seen.add(dedup_key)
+                unique_values.append(val)
+        sorted_values = sorted(unique_values, key=str)
+        total_count = len(sorted_values)
+        end = from_ + size
+        paginated_values = sorted_values[from_:end]
+
+        return paginated_values, total_count
 
-    def count_unique_metadata_by_filter(self, filters: dict[str, Any], fields: list[str]) -> dict[str, int]:
+    def count_unique_metadata_by_filter(self, filters: dict[str, Any], metadata_fields: list[str]) -> dict[str, int]:
         """
         Returns a count of unique values for multiple metadata fields, optionally scoped by a filter.
 
         :param filters: A dictionary of filters to apply.
-        :param fields: A list of metadata field names to count unique values for.
+        :param metadata_fields: A list of metadata field names to count unique values for.
         :returns: A dictionary mapping each field name to the count of its unique values.
         """
         filtered_docs = self.filter_documents(filters)
         counts = {}
 
-        for field in fields:
-            unique_vals = set()
+        for field in metadata_fields:
+            # Values of different types can be equal in Python (`1 == True`, `1 == 1.0`), so a plain
+            # set would silently merge them. Dedupe by (type, value) instead to keep them distinct.
+            unique_vals: set[tuple[type, Any]] = set()
             for doc in filtered_docs:
                 val = FAISSDocumentStore._get_doc_value(doc, field)
                 if val is not None:
-                    unique_vals.add(val)
+                    unique_vals.add((type(val), val))
             counts[field] = len(unique_vals)
 
         return dict(counts)

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/tests/test_document_store.py

@@ -4,19 +4,74 @@
 
 import pytest
 from haystack.dataclasses import Document
+from haystack.document_stores.errors import DocumentStoreError, DuplicateDocumentError
+from haystack.document_stores.types import DuplicatePolicy
 from haystack.errors import FilterError
 from haystack.testing.document_store import (
+    CountDocumentsByFilterTest,
     CountDocumentsTest,
+    CountUniqueMetadataByFilterTest,
     DeleteAllTest,
     DeleteByFilterTest,
     DeleteDocumentsTest,
     FilterDocumentsTest,
+    GetMetadataFieldMinMaxTest,
+    GetMetadataFieldsInfoTest,
+    GetMetadataFieldUniqueValuesTest,
     UpdateByFilterTest,
 )
 
 from haystack_integrations.document_stores.faiss import FAISSDocumentStore
 
 
+class TestFAISSDocumentStoreUnit:
+    def test_create_new_index_with_invalid_factory_raises(self):
+        with pytest.raises(DocumentStoreError, match="Could not create FAISS index"):
+            FAISSDocumentStore(index_string="NotARealIndex", embedding_dim=3)
+
+    def test_get_index_or_raise_when_index_is_none(self):
+        ds = FAISSDocumentStore(embedding_dim=3)
+        ds.index = None
+        with pytest.raises(DocumentStoreError, match="FAISS index has not been initialized"):
+            ds._get_index_or_raise()
+
+    @pytest.mark.parametrize(
+        "bad_input",
+        [
+            "a string",
+            b"some bytes",
+            123,
+            [Document(content="ok"), "not a document"],
+        ],
+    )
+    def test_write_documents_rejects_invalid_input(self, bad_input):
+        ds = FAISSDocumentStore(embedding_dim=3)
+        with pytest.raises(ValueError, match="iterable of objects of type Document"):
+            ds.write_documents(bad_input)
+
+    def test_write_documents_fail_policy_raises_on_duplicate(self):
+        ds = FAISSDocumentStore(embedding_dim=3)
+        ds.write_documents([Document(id="dup", content="first")])
+        with pytest.raises(DuplicateDocumentError, match="already exists"):
+            ds.write_documents([Document(id="dup", content="second")], policy=DuplicatePolicy.FAIL)
+
+    @pytest.mark.parametrize(
+        ("filters", "error_match"),
+        [
+            ({"operator": "OR"}, "Missing 'conditions' for OR operator"),
+            ({"operator": "AND"}, "Missing 'conditions' for AND operator"),
+            ({"operator": "NOT"}, "Missing 'conditions' for NOT operator"),
+            ({"operator": "==", "field": 42, "value": "x"}, "'field' in filter condition must be a string"),
+        ],
+    )
+    def test_check_condition_invalid_structure_raises_filter_error(self, filters, error_match):
+        ds = FAISSDocumentStore(embedding_dim=3)
+        ds.write_documents([Document(content="test", meta={"category": "A"})])
+        with pytest.raises(FilterError, match=error_match):
+            ds.filter_documents(filters=filters)
+
+
+@pytest.mark.integration
 class TestFAISSDocumentStore(
     CountDocumentsTest,
     DeleteDocumentsTest,
@@ -24,20 +79,23 @@ class TestFAISSDocumentStore(
     UpdateByFilterTest,
     DeleteAllTest,
     DeleteByFilterTest,
+    CountDocumentsByFilterTest,
+    CountUniqueMetadataByFilterTest,
+    GetMetadataFieldsInfoTest,
+    GetMetadataFieldMinMaxTest,
+    GetMetadataFieldUniqueValuesTest,
 ):
     @pytest.fixture
     def document_store(self, tmp_path):
         return FAISSDocumentStore(index_path=str(tmp_path / "test_index"))
 
     def test_write_documents(self, document_store):
-
         doc = Document(content="test")
         document_store.write_documents([doc])
         assert document_store.count_documents() == 1
         assert document_store.filter_documents()[0].id == doc.id
 
     def test_persistence(self, tmp_path):
-
         path = tmp_path / "persistent_index"
         ds = FAISSDocumentStore(index_path=str(path), embedding_dim=3)
 
@@ -52,7 +110,6 @@ class TestFAISSDocumentStore(
         assert ds_loaded.filter_documents()[0].embedding == [0.1, 0.2, 0.3]
 
     def test_persistence_no_embeddings(self, tmp_path):
-
         path = tmp_path / "persistent_index_no_embed"
         ds = FAISSDocumentStore(index_path=str(path), embedding_dim=3)
 
@@ -73,7 +130,6 @@ class TestFAISSDocumentStore(
             ds.load(path)
 
     def test_search_with_and_without_filters(self, document_store):
-
         # Setup documents with missing/varied embeddings to test edge cases
         doc1 = Document(content="test1", embedding=[0.1, 0.2, 0.3], meta={"category": "A"})
         doc2 = Document(content="test2", embedding=[0.4, 0.5, 0.6], meta={"category": "B"})
@@ -97,7 +153,6 @@ class TestFAISSDocumentStore(
 
     def test_to_dict_from_dict(self):
         ds = FAISSDocumentStore(index_path="test_index", index_string="Flat", embedding_dim=128)
-
         data = ds.to_dict()
         assert data["type"] == "haystack_integrations.document_stores.faiss.document_store.FAISSDocumentStore"
         assert data["init_parameters"]["index_path"] == "test_index"
@@ -109,50 +164,10 @@ class TestFAISSDocumentStore(
         assert ds_loaded.index_string == "Flat"
         assert ds_loaded.embedding_dim == 128
 
-    def test_count_documents_by_filter(self, document_store):
-
-        docs = [
-            Document(content="test1", meta={"category": "A"}),
-            Document(content="test2", meta={"category": "B"}),
-            Document(content="test3", meta={"category": "A"}),
-        ]
-        document_store.write_documents(docs)
-
-        count = document_store.count_documents_by_filter(
-            filters={"field": "meta.category", "operator": "==", "value": "A"}
-        )
-        assert count == 2
-
-    def test_get_metadata_fields_info(self, document_store):
-
-        docs = [Document(content="test1", meta={"category": "A", "count": 1, "is_active": True})]
-        document_store.write_documents(docs)
-
-        info = document_store.get_metadata_fields_info()
-        assert "category" in info
-        assert info["category"]["type"] == "keyword"
-        assert "count" in info
-        assert info["count"]["type"] == "long"
-        assert "is_active" in info
-        assert info["is_active"]["type"] == "boolean"
-
-    def test_count_unique_metadata_by_filter(self, document_store):
-
-        docs = [
-            Document(content="test1", meta={"category": "A", "status": "active"}),
-            Document(content="test2", meta={"category": "B", "status": "inactive"}),
-            Document(content="test3", meta={"category": "A", "status": "active"}),
-        ]
-        document_store.write_documents(docs)
-
-        counts = document_store.count_unique_metadata_by_filter(
-            filters={"field": "meta.category", "operator": "==", "value": "A"}, fields=["meta.status"]
-        )
-        assert "meta.status" in counts
-        assert counts["meta.status"] == 1  # Only "active" status for category A
-
     def test_not_filter_with_empty_conditions_raises_filter_error(self, document_store):
         document_store.write_documents([Document(content="test", meta={"category": "A"})])
-
         with pytest.raises(FilterError, match="NOT operator expects at least one condition"):
             document_store.filter_documents(filters={"operator": "NOT", "conditions": []})
+
+    # get_metadata_field_unique_values behavior (search term, pagination, meta-prefix handling, non-string
+    # type preservation, filter restriction) is covered by the inherited GetMetadataFieldUniqueValuesTest mixin.

{faiss_haystack-1.0.0 → faiss_haystack-2.1.0}/tests/test_embedding_retriever.py

@@ -31,6 +31,12 @@ def populated_store(document_store):
     return document_store
 
 
+def test_invalid_document_store_type():
+    with pytest.raises(ValueError, match="document_store must be an instance of FAISSDocumentStore"):
+        FAISSEmbeddingRetriever(document_store="not_a_store")  # type: ignore[arg-type]
+
+
+@pytest.mark.integration
 class TestFAISSEmbeddingRetriever:
     def test_run_with_query_embedding_only(self, populated_store):
         retriever = FAISSEmbeddingRetriever(document_store=populated_store, top_k=2)
@@ -112,10 +118,6 @@ class TestFAISSEmbeddingRetriever:
         assert len(result["documents"]) >= 1
         assert all(d.meta["category"] == "A" for d in result["documents"])
 
-    def test_invalid_document_store_type(self):
-        with pytest.raises(ValueError, match="document_store must be an instance of FAISSDocumentStore"):
-            FAISSEmbeddingRetriever(document_store="not_a_store")  # type: ignore[arg-type]
-
     def test_run_in_pipeline(self, populated_store):
         """End-to-end: FAISSEmbeddingRetriever wired into a Haystack Pipeline."""
         retriever = FAISSEmbeddingRetriever(document_store=populated_store, top_k=2)

faiss_haystack-1.0.0/README.md

@@ -1,17 +0,0 @@
-# faiss-haystack
-
-This package provides a [FAISS](https://github.com/facebookresearch/faiss) document store for [Haystack](https://github.com/deepset-ai/haystack).
-
-## Installation
-
-```bash
-pip install faiss-haystack
-```
-
-## Usage
-
-```python
-from haystack_integrations.document_stores.faiss import FAISSDocumentStore
-
-document_store = FAISSDocumentStore(index_path="my_index")
-```

faiss_haystack-1.0.0/src/haystack_integrations/components/__init__.py

@@ -1,3 +0,0 @@
-# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
-#
-# SPDX-License-Identifier: Apache-2.0

faiss_haystack-1.0.0/src/haystack_integrations/components/retrievers/__init__.py

@@ -1,3 +0,0 @@
-# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
-#
-# SPDX-License-Identifier: Apache-2.0