amazon-bedrock-haystack 3.6.0__py3-none-any.whl → 3.6.1__py3-none-any.whl

{amazon_bedrock_haystack-3.6.0.dist-info → amazon_bedrock_haystack-3.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amazon-bedrock-haystack
-Version: 3.6.0
+Version: 3.6.1
 Summary: An integration of Amazon Bedrock as an AmazonBedrockGenerator component.
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/amazon_bedrock#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues

{amazon_bedrock_haystack-3.6.0.dist-info → amazon_bedrock_haystack-3.6.1.dist-info}/RECORD

@@ -10,9 +10,9 @@ haystack_integrations/components/generators/amazon_bedrock/generator.py,sha256=N
 haystack_integrations/components/generators/amazon_bedrock/chat/__init__.py,sha256=6GZ8Y3Lw0rLOsOAqi6Tu5mZC977UzQvgDxKpOWr8IQw,110
 haystack_integrations/components/generators/amazon_bedrock/chat/chat_generator.py,sha256=M9I0sB8LFrXCgoyr5ik2ZPPHyB0b4nJFKX7GARKsk8Y,23384
 haystack_integrations/components/generators/amazon_bedrock/chat/utils.py,sha256=kBSaU_ZqzL-7a7nplezjb4XRBy51pt-4VULoX5lq21A,21148
-haystack_integrations/components/rankers/amazon_bedrock/__init__.py,sha256=DWsCu-dav2wzr13U2H1jlFjdzdjkV0fnJw7DVDRY8RQ,63
-haystack_integrations/components/rankers/amazon_bedrock/ranker.py,sha256=gNULecuc5YiPuF4eadNN1DrUKxCRxwgUUxPKHhFzb9Q,11680
-amazon_bedrock_haystack-3.6.0.dist-info/METADATA,sha256=p6JBOavr8J3oSu1ri1c5tLIdF-U3U2jZmhmOLEQa9zg,2225
-amazon_bedrock_haystack-3.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-amazon_bedrock_haystack-3.6.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
-amazon_bedrock_haystack-3.6.0.dist-info/RECORD,,
+haystack_integrations/components/rankers/amazon_bedrock/__init__.py,sha256=Zrc3BSVkEaXYpliEi6hKG9bqW4J7DNk93p50SuoyT1Q,107
+haystack_integrations/components/rankers/amazon_bedrock/ranker.py,sha256=x4QEVkbFM-jMFHx-xmk571wtrohnPLtkIWMhCyg4_II,12278
+amazon_bedrock_haystack-3.6.1.dist-info/METADATA,sha256=oRIb-2Nv642N0wmapQgykocVVjxzwM7rG1_TNOoF6Vs,2225
+amazon_bedrock_haystack-3.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amazon_bedrock_haystack-3.6.1.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+amazon_bedrock_haystack-3.6.1.dist-info/RECORD,,

haystack_integrations/components/rankers/amazon_bedrock/__init__.py

@@ -1,3 +1,3 @@
-from .ranker import BedrockRanker
+from .ranker import AmazonBedrockRanker, BedrockRanker
 
-__all__ = ["BedrockRanker"]
+__all__ = ["AmazonBedrockRanker", "BedrockRanker"]

haystack_integrations/components/rankers/amazon_bedrock/ranker.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Any, Dict, List, Optional
 
 from botocore.exceptions import ClientError
@@ -16,7 +17,7 @@ MAX_NUM_DOCS_FOR_BEDROCK_RANKER = 1000
 
 
 @component
-class BedrockRanker:
+class AmazonBedrockRanker:
     """
     Ranks Documents based on their similarity to the query using Amazon Bedrock's Cohere Rerank model.
 
@@ -30,9 +31,13 @@ class BedrockRanker:
     ```python
     from haystack import Document
     from haystack.utils import Secret
-    from haystack_integrations.components.rankers.amazon_bedrock import BedrockRanker
+    from haystack_integrations.components.rankers.amazon_bedrock import AmazonBedrockRanker
 
-    ranker = BedrockRanker(model="cohere.rerank-v3-5:0", top_k=2, aws_region_name=Secret.from_token("eu-central-1"))
+    ranker = AmazonBedrockRanker(
+        model="cohere.rerank-v3-5:0",
+        top_k=2,
+        aws_region_name=Secret.from_token("eu-central-1")
+    )
 
     docs = [Document(content="Paris"), Document(content="Berlin")]
     query = "What is the capital of germany?"
@@ -40,7 +45,7 @@ class BedrockRanker:
     docs = output["documents"]
     ```
 
-    BedrockRanker uses AWS for authentication. You can use the AWS CLI to authenticate through your IAM.
+    AmazonBedrockRanker uses AWS for authentication. You can use the AWS CLI to authenticate through your IAM.
     For more information on setting up an IAM identity-based policy, see [Amazon Bedrock documentation]
     (https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html).
 
@@ -71,7 +76,7 @@ class BedrockRanker:
             msg = "'model' cannot be None or empty string"
             raise ValueError(msg)
         """
-        Creates an instance of the 'BedrockRanker'.
+        Creates an instance of the 'AmazonBedrockRanker'.
 
         :param model: Amazon Bedrock model name for Cohere Rerank. Default is "cohere.rerank-v3-5:0".
         :param top_k: The maximum number of documents to return.
@@ -140,7 +145,7 @@ class BedrockRanker:
         )
 
     @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> "BedrockRanker":
+    def from_dict(cls, data: Dict[str, Any]) -> "AmazonBedrockRanker":
         """
         Deserializes the component from a dictionary.
 
@@ -260,3 +265,20 @@ class BedrockRanker:
         except Exception as e:
             msg = f"Error during Amazon Bedrock API call: {e!s}"
             raise AmazonBedrockInferenceError(msg) from e
+
+
+class BedrockRanker(AmazonBedrockRanker):
+    """
+    Deprecated alias for AmazonBedrockRanker.
+    This class will be removed in a future version.
+    Please use AmazonBedrockRanker instead.
+    """
+
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "BedrockRanker is deprecated and will be removed in a future version. "
+            "Please use AmazonBedrockRanker instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)