dynamodb-haystack 1.0.0__py3-none-any.whl

dynamodb_haystack-1.0.0.dist-info/METADATA

@@ -0,0 +1,71 @@
+Metadata-Version: 2.5
+Name: dynamodb-haystack
+Version: 1.0.0
+Summary: Haystack integration for dynamodb
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/dynamodb#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/dynamodb
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: aws,document-store,dynamodb,haystack,vector-search
+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: aiobotocore<4,>=3.9.1
+Requires-Dist: boto3<2,>=1.43.66
+Requires-Dist: haystack-ai>=3.0.0
+Description-Content-Type: text/markdown
+
+# dynamodb-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/dynamodb-haystack.svg)](https://pypi.org/project/dynamodb-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dynamodb-haystack.svg)](https://pypi.org/project/dynamodb-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/dynamodb)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/dynamodb/CHANGELOG.md)
+
+---
+
+## Requirements
+
+DynamoDB's native vector search (`SearchVectors`, vector indexes) is only available in
+`boto3 >= 1.43.66`, which requires Python 3.10+. Both are enforced by this package's metadata.
+
+## Limitations
+
+- Metadata filters are evaluated client-side: `filter_documents`, `count_documents` and the
+  filter-based bulk operations scan the whole table, and embedding retrieval filters the at most
+  100 nearest candidates that DynamoDB's `SearchVectors` returns (`top_k` cannot exceed 100).
+- Only cosine similarity is supported for now.
+- A DynamoDB item is limited to 400 KB, which bounds a document's content, metadata and embedding.
+
+## Running the integration tests
+
+The integration tests run against **real AWS** — there is no local DynamoDB emulator that
+supports vector indexes. They are skipped unless you opt in:
+
+```bash
+export AWS_DEFAULT_REGION=<your-region>
+export HAYSTACK_DYNAMODB_INTEGRATION_TESTS=1
+hatch run test:integration
+```
+
+You also need credentials (any standard boto3 credential source) with permission to
+`CreateTable`, `DeleteTable`, `DescribeTable`, `ListTables`, the item-level operations, and
+`SearchVectors`. Each test class creates one table named `haystack_test_<run id>_<class>` and
+deletes it afterwards; a session-scoped safety net sweeps any table of the same run whose delete
+was rejected while its index was still settling. Expect the suite to create and destroy real,
+billable tables.
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).

dynamodb_haystack-1.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+haystack_integrations/components/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/retrievers/dynamodb/__init__.py,sha256=zp8PMBqZ7CyjZeWatLwwXlNG4Bw5ehSikr5NwiscTno,213
+haystack_integrations/components/retrievers/dynamodb/embedding_retriever.py,sha256=WBu83jpp-oQW_UcfCl2KY_gy1dxbaWM3aYhlgvB1Kow,6392
+haystack_integrations/document_stores/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/document_stores/dynamodb/__init__.py,sha256=MFeCmFshLJ4u1ljP-B0_Q9CX1acDiv0TOTTQrlJOCoY,198
+haystack_integrations/document_stores/dynamodb/document_store.py,sha256=hpzfAG-p7L51C7nF1HDd9N3wtGuKBZ-YK9HjcuIq4dM,46660
+dynamodb_haystack-1.0.0.dist-info/METADATA,sha256=qvsnZfjerVKRwcAZWiDNmQIzmwi7bgS-jFHkun_NJYA,3353
+dynamodb_haystack-1.0.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+dynamodb_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+dynamodb_haystack-1.0.0.dist-info/RECORD,,

dynamodb_haystack-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

dynamodb_haystack-1.0.0.dist-info/licenses/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.

haystack_integrations/components/retrievers/dynamodb/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from .embedding_retriever import DynamoDBEmbeddingRetriever
+
+__all__ = ["DynamoDBEmbeddingRetriever"]

haystack_integrations/components/retrievers/dynamodb/embedding_retriever.py

@@ -0,0 +1,144 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from haystack import component, default_from_dict, default_to_dict
+from haystack.dataclasses import Document
+from haystack.document_stores.types import FilterPolicy
+from haystack.document_stores.types.filter_policy import apply_filter_policy
+
+from haystack_integrations.document_stores.dynamodb import DynamoDBDocumentStore
+from haystack_integrations.document_stores.dynamodb.document_store import SEARCH_VECTORS_MAX_TOP_K
+
+
+@component
+class DynamoDBEmbeddingRetriever:
+    """
+    Retrieves documents from a `DynamoDBDocumentStore` using vector similarity on embeddings.
+
+    Uses DynamoDB's native `SearchVectors` API (cosine similarity). DynamoDB returns at most 100
+    candidates per search, so `top_k` cannot exceed 100. Metadata filters are applied client-side
+    to those candidates, so a selective filter can return fewer than `top_k` documents even when
+    more matching documents exist.
+
+    Example usage:
+
+    ```python
+    from haystack_integrations.document_stores.dynamodb import DynamoDBDocumentStore
+    from haystack_integrations.components.retrievers.dynamodb import DynamoDBEmbeddingRetriever
+
+    store = DynamoDBDocumentStore(table_name="docs", index_name="doc-index", embedding_dimension=768)
+    retriever = DynamoDBEmbeddingRetriever(document_store=store, top_k=5)
+    result = retriever.run(query_embedding=[0.1, 0.2, ...])
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        document_store: DynamoDBDocumentStore,
+        top_k: int = 10,
+        filters: dict[str, Any] | None = None,
+        filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
+    ) -> None:
+        """
+        Creates a new DynamoDBEmbeddingRetriever.
+
+        :param document_store: The `DynamoDBDocumentStore` to retrieve documents from.
+        :param top_k: Maximum number of documents to return, between 1 and 100 (the DynamoDB
+            `SearchVectors` limit).
+        :param filters: Optional Haystack metadata filters applied at retrieval time. Applied
+            client-side after the native vector search, since DynamoDB's `SearchVectors`
+            filter expressions can only reference attributes declared in the index's
+            `SearchSchema` at index-creation time.
+        :param filter_policy: How run-time filters combine with `filters`: `REPLACE` (default)
+            uses the run-time filters alone when they are given, `MERGE` combines both.
+        :raises ValueError: If `document_store` is not a `DynamoDBDocumentStore` or `top_k` is
+            outside the allowed range.
+        """
+        if not isinstance(document_store, DynamoDBDocumentStore):
+            msg = f"document_store must be a DynamoDBDocumentStore, got {type(document_store)}"
+            raise ValueError(msg)
+        if not 1 <= top_k <= SEARCH_VECTORS_MAX_TOP_K:
+            msg = f"top_k must be between 1 and {SEARCH_VECTORS_MAX_TOP_K} (DynamoDB SearchVectors limit), got {top_k}."
+            raise ValueError(msg)
+        self.document_store = document_store
+        self.top_k = top_k
+        self.filters = filters
+        self.filter_policy = (
+            filter_policy if isinstance(filter_policy, FilterPolicy) else FilterPolicy.from_str(filter_policy)
+        )
+
+    @component.output_types(documents=list[Document])
+    def run(
+        self,
+        query_embedding: list[float],
+        top_k: int | None = None,
+        filters: dict[str, Any] | None = None,
+    ) -> dict[str, list[Document]]:
+        """
+        Retrieves documents most similar to `query_embedding`.
+
+        :param query_embedding: The query vector.
+        :param top_k: Overrides the instance-level `top_k` for this call; must stay between 1 and 100.
+        :param filters: Run-time filters, combined with the instance-level `filters` according to
+            `filter_policy`.
+        :returns: A dictionary with `documents`, a list of `Document` objects sorted by score.
+        """
+        top_k = top_k if top_k is not None else self.top_k
+        filters = apply_filter_policy(self.filter_policy, self.filters, filters)
+        docs = self.document_store._embedding_retrieval(query_embedding=query_embedding, top_k=top_k, filters=filters)
+        return {"documents": docs}
+
+    @component.output_types(documents=list[Document])
+    async def run_async(
+        self,
+        query_embedding: list[float],
+        top_k: int | None = None,
+        filters: dict[str, Any] | None = None,
+    ) -> dict[str, list[Document]]:
+        """
+        Asynchronously retrieves documents most similar to `query_embedding`.
+
+        :param query_embedding: The query vector.
+        :param top_k: Overrides the instance-level `top_k` for this call; must stay between 1 and 100.
+        :param filters: Run-time filters, combined with the instance-level `filters` according to
+            `filter_policy`.
+        :returns: A dictionary with `documents`, a list of `Document` objects sorted by score.
+        """
+        top_k = top_k if top_k is not None else self.top_k
+        filters = apply_filter_policy(self.filter_policy, self.filters, filters)
+        docs = await self.document_store._embedding_retrieval_async(
+            query_embedding=query_embedding, top_k=top_k, filters=filters
+        )
+        return {"documents": docs}
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serializes the component to a dictionary.
+
+        :returns: Dictionary with serialized data.
+        """
+        return default_to_dict(
+            self,
+            document_store=self.document_store.to_dict(),
+            top_k=self.top_k,
+            filters=self.filters,
+            filter_policy=self.filter_policy.value,
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "DynamoDBEmbeddingRetriever":
+        """
+        Deserializes the component from a dictionary.
+
+        :param data: Dictionary to deserialize from.
+        :returns: Deserialized component.
+        """
+        init_params = data["init_parameters"]
+        init_params["document_store"] = DynamoDBDocumentStore.from_dict(init_params["document_store"])
+        if filter_policy := init_params.get("filter_policy"):
+            init_params["filter_policy"] = FilterPolicy.from_str(filter_policy)
+        return default_from_dict(cls, data)

haystack_integrations/document_stores/dynamodb/__init__.py

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from .document_store import DynamoDBDocumentStore
+
+__all__ = ["DynamoDBDocumentStore"]