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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amazon-bedrock-haystack
-Version: 3.6.1
+Version: 3.7.0
 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
@@ -52,13 +52,18 @@ pip install hatch
 
 With `hatch` installed, to run all the tests:
 ```
-hatch run test
+hatch run test:all
 ```
-> Note: there are no integration tests for this project.
 
-To run the linters `ruff` and `mypy`:
+To format your code and perform linting using Ruff (with automatic fixes), run:
 ```
-hatch run lint:all
+hatch run fmt
+```
+
+To check for static type errors, run:
+
+```console
+$ hatch run test:types
 ```
 
 ## License

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

@@ -1,18 +1,22 @@
+haystack_integrations/common/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 haystack_integrations/common/amazon_bedrock/__init__.py,sha256=6GZ8Y3Lw0rLOsOAqi6Tu5mZC977UzQvgDxKpOWr8IQw,110
 haystack_integrations/common/amazon_bedrock/errors.py,sha256=ReheDbY7L3EJkWcUoih6lWHjbPHg2TlUs9SnXIKK7Gg,744
-haystack_integrations/common/amazon_bedrock/utils.py,sha256=dHUWzHYT0A8_eLDpVkwDhmDpprYbFlWsGg0FOS0uF0I,2720
+haystack_integrations/common/amazon_bedrock/utils.py,sha256=ASAwEhInF9F6rhL4CbXFQUFU1pSdscWvG6jcrXkEUhc,2735
+haystack_integrations/components/embedders/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 haystack_integrations/components/embedders/amazon_bedrock/__init__.py,sha256=CFqYmAVq2aavlMkZHYScKHOTwwETdRzRZITMqGhJ9Kw,298
-haystack_integrations/components/embedders/amazon_bedrock/document_embedder.py,sha256=ZdtM6HpHQwbKfjmfOK6gkIQPPbI0n8_pWRrR6lyXmr8,13321
-haystack_integrations/components/embedders/amazon_bedrock/text_embedder.py,sha256=gpvu6IMoycUXrn4r1OH5yEIheiDxHf2T5fdJJO4DfW0,9202
+haystack_integrations/components/embedders/amazon_bedrock/document_embedder.py,sha256=YBVlFIo9t2qzVkNWaFKc-FNRo7R_pKfHmqNRkoMZ9K0,12952
+haystack_integrations/components/embedders/amazon_bedrock/text_embedder.py,sha256=KNvsUP-YZD17_zVBwMs42v0S2uuTE_ajMaj9bjt1XlE,9036
+haystack_integrations/components/generators/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 haystack_integrations/components/generators/amazon_bedrock/__init__.py,sha256=lv4NouIVm78YavUssWQrHHP_81u-7j21qW8v1kZMJPQ,284
-haystack_integrations/components/generators/amazon_bedrock/adapters.py,sha256=cnlfmie4HfEX4nipSXSDk_3koy7HYZ-ezimGN6BozQ0,19543
-haystack_integrations/components/generators/amazon_bedrock/generator.py,sha256=NgywyiKYazEbsLAcGcOPUT4blWhYYOJ9WjO-HWDvu7I,14576
+haystack_integrations/components/generators/amazon_bedrock/adapters.py,sha256=yBC-3YwV6qAwSXMtdZiLSYh2lUpPQIDy7Efl7w-Cu-k,19640
+haystack_integrations/components/generators/amazon_bedrock/generator.py,sha256=c_saV5zxFYQVJT0Hzo80lKty46itL0Dp31VuDueYa3M,14716
 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/generators/amazon_bedrock/chat/chat_generator.py,sha256=nhen_XcdypQT2K8312gjYdPYrNK_NtBKcR3gPfYzVwU,23461
+haystack_integrations/components/generators/amazon_bedrock/chat/utils.py,sha256=EGDcJZFzXKjIJnD8sw1M9YHIPPm05drw1KbY_Lx1kUI,21170
+haystack_integrations/components/rankers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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/ranker.py,sha256=enAjf2QyDwfpidKkFCdLz954cx-Tjh9emrOS3vINJDg,12344
+amazon_bedrock_haystack-3.7.0.dist-info/METADATA,sha256=2n5u93lnpV3M8NL_7GaR7dHqRnoq8vzV6v73sTjS008,2287
+amazon_bedrock_haystack-3.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amazon_bedrock_haystack-3.7.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+amazon_bedrock_haystack-3.7.0.dist-info/RECORD,,

haystack_integrations/common/amazon_bedrock/utils.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import Any, Optional, Union
 
 import aioboto3
 import boto3
@@ -22,7 +22,7 @@ def get_aws_session(
     aws_region_name: Optional[str] = None,
     aws_profile_name: Optional[str] = None,
     async_mode: bool = False,
-    **kwargs,
+    **kwargs: Any,
 ) -> Union[boto3.Session, aioboto3.Session]:
     """
     Creates an AWS Session with the given parameters.
@@ -62,7 +62,7 @@ def get_aws_session(
         raise AWSConfigurationError(msg) from e
 
 
-def aws_configured(**kwargs) -> bool:
+def aws_configured(**kwargs: Any) -> bool:
     """
     Checks whether AWS configuration is provided.
     :param kwargs: The kwargs passed down to the generator.

haystack_integrations/components/embedders/amazon_bedrock/document_embedder.py

@@ -74,7 +74,7 @@ class AmazonBedrockDocumentEmbedder:
         meta_fields_to_embed: Optional[List[str]] = None,
         embedding_separator: str = "\n",
         boto3_config: Optional[Dict[str, Any]] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         """
         Initializes the AmazonBedrockDocumentEmbedder with the provided parameters. The parameters are passed to the
@@ -186,11 +186,7 @@ class AmazonBedrockDocumentEmbedder:
                     body=json.dumps(body), modelId=self.model, accept="*/*", contentType="application/json"
                 )
             except ClientError as exception:
-                msg = (
-                    f"Could not connect to Amazon Bedrock model {self.model}. "
-                    f"Make sure your AWS environment is configured correctly, "
-                    f"the model is available in the configured AWS region, and you have access."
-                )
+                msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
                 raise AmazonBedrockInferenceError(msg) from exception
 
             response_body = json.loads(response.get("body").read())
@@ -217,11 +213,7 @@ class AmazonBedrockDocumentEmbedder:
                     body=json.dumps(body), modelId=self.model, accept="*/*", contentType="application/json"
                 )
             except ClientError as exception:
-                msg = (
-                    f"Could not connect to Amazon Bedrock model {self.model}. "
-                    f"Make sure your AWS environment is configured correctly, "
-                    f"the model is available in the configured AWS region, and you have access."
-                )
+                msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
                 raise AmazonBedrockInferenceError(msg) from exception
 
             response_body = json.loads(response.get("body").read())

haystack_integrations/components/embedders/amazon_bedrock/text_embedder.py

@@ -63,7 +63,7 @@ class AmazonBedrockTextEmbedder:
         aws_region_name: Optional[Secret] = Secret.from_env_var("AWS_DEFAULT_REGION", strict=False),  # noqa: B008
         aws_profile_name: Optional[Secret] = Secret.from_env_var("AWS_PROFILE", strict=False),  # noqa: B008
         boto3_config: Optional[Dict[str, Any]] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         """
         Initializes the AmazonBedrockTextEmbedder with the provided parameters. The parameters are passed to the
@@ -160,11 +160,7 @@ class AmazonBedrockTextEmbedder:
                 body=json.dumps(body), modelId=self.model, accept="*/*", contentType="application/json"
             )
         except ClientError as exception:
-            msg = (
-                f"Could not connect to Amazon Bedrock model {self.model}. "
-                f"Make sure your AWS environment is configured correctly, "
-                f"the model is available in the configured AWS region, and you have access."
-            )
+            msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
             raise AmazonBedrockInferenceError(msg) from exception
 
         response_body = json.loads(response.get("body").read())

haystack_integrations/components/generators/amazon_bedrock/adapters.py

@@ -1,8 +1,9 @@
 import json
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any, Dict, List, Optional
 
-from haystack.dataclasses import StreamingChunk
+from botocore.eventstream import EventStream
+from haystack.dataclasses import StreamingChunk, SyncStreamingCallbackT
 
 
 class BedrockModelAdapter(ABC):
@@ -23,7 +24,7 @@ class BedrockModelAdapter(ABC):
         self.max_length = max_length
 
     @abstractmethod
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Amazon Bedrock request.
         Each subclass should implement this method to prepare the request body for the specific model.
@@ -44,7 +45,7 @@ class BedrockModelAdapter(ABC):
         responses = [completion.lstrip() for completion in completions]
         return responses
 
-    def get_stream_responses(self, stream, streaming_callback: Callable[[StreamingChunk], None]) -> List[str]:
+    def get_stream_responses(self, stream: EventStream, streaming_callback: SyncStreamingCallbackT) -> List[str]:
         """
         Extracts the responses from the Amazon Bedrock streaming response.
 
@@ -122,7 +123,7 @@ class AnthropicClaudeAdapter(BedrockModelAdapter):
         self.thinking_tag_end = f"</{self.thinking_tag}>\n\n" if self.thinking_tag else "\n\n"
         super().__init__(model_kwargs, max_length)
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Claude model
 
@@ -210,7 +211,7 @@ class MistralAdapter(BedrockModelAdapter):
     Adapter for the Mistral models.
     """
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Mistral model
 
@@ -260,7 +261,7 @@ class CohereCommandAdapter(BedrockModelAdapter):
     Adapter for the Cohere Command model.
     """
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Command model
 
@@ -372,7 +373,7 @@ class AI21LabsJurassic2Adapter(BedrockModelAdapter):
     Model adapter for AI21 Labs' Jurassic 2 models.
     """
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """Prepares the body for the Jurassic 2 model.
 
         :param prompt: The prompt to be sent to the model.
@@ -410,7 +411,7 @@ class AmazonTitanAdapter(BedrockModelAdapter):
     Adapter for Amazon's Titan models.
     """
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Titan model
 
@@ -456,7 +457,7 @@ class MetaLlamaAdapter(BedrockModelAdapter):
     Adapter for Meta's Llama2 models.
     """
 
-    def prepare_body(self, prompt: str, **inference_kwargs) -> Dict[str, Any]:
+    def prepare_body(self, prompt: str, **inference_kwargs: Any) -> Dict[str, Any]:
         """
         Prepares the body for the Llama2 model
 

haystack_integrations/components/generators/amazon_bedrock/chat/chat_generator.py

@@ -197,12 +197,6 @@ class AmazonBedrockChatGenerator:
         def resolve_secret(secret: Optional[Secret]) -> Optional[str]:
             return secret.resolve_value() if secret else None
 
-        aws_access_key_id = resolve_secret(aws_access_key_id)
-        aws_secret_access_key = resolve_secret(aws_secret_access_key)
-        aws_session_token = resolve_secret(aws_session_token)
-        aws_region_name = resolve_secret(aws_region_name)
-        aws_profile_name = resolve_secret(aws_profile_name)
-
         config: Optional[Config] = None
         if self.boto3_config:
             config = Config(**self.boto3_config)
@@ -210,11 +204,11 @@ class AmazonBedrockChatGenerator:
         try:
             # sync session
             session = get_aws_session(
-                aws_access_key_id=aws_access_key_id,
-                aws_secret_access_key=aws_secret_access_key,
-                aws_session_token=aws_session_token,
-                aws_region_name=aws_region_name,
-                aws_profile_name=aws_profile_name,
+                aws_access_key_id=resolve_secret(aws_access_key_id),
+                aws_secret_access_key=resolve_secret(aws_secret_access_key),
+                aws_session_token=resolve_secret(aws_session_token),
+                aws_region_name=resolve_secret(aws_region_name),
+                aws_profile_name=resolve_secret(aws_profile_name),
             )
             self.client = session.client("bedrock-runtime", config=config)
 
@@ -227,7 +221,7 @@ class AmazonBedrockChatGenerator:
 
         self.generation_kwargs = generation_kwargs or {}
         self.stop_words = stop_words or []
-        self.async_session = None
+        self.async_session: Optional[aioboto3.Session] = None
 
     def _get_async_session(self) -> aioboto3.Session:
         """
@@ -427,12 +421,13 @@ class AmazonBedrockChatGenerator:
                 if not response_stream:
                     msg = "No stream found in the response."
                     raise AmazonBedrockInferenceError(msg)
-                replies = _parse_streaming_response(response_stream, callback, self.model)
+                # the type of streaming callback is checked in _prepare_request_params, but mypy doesn't know
+                replies = _parse_streaming_response(response_stream, callback, self.model)  # type: ignore[arg-type]
             else:
                 response = self.client.converse(**params)
                 replies = _parse_completion_response(response, self.model)
         except ClientError as exception:
-            msg = f"Could not generate inference for Amazon Bedrock model {self.model} due: {exception}"
+            msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
             raise AmazonBedrockInferenceError(msg) from exception
 
         return {"replies": replies}
@@ -483,13 +478,14 @@ class AmazonBedrockChatGenerator:
                     if not response_stream:
                         msg = "No stream found in the response."
                         raise AmazonBedrockInferenceError(msg)
-                    replies = await _parse_streaming_response_async(response_stream, callback, self.model)
+                    # the type of streaming callback is checked in _prepare_request_params, but mypy doesn't know
+                    replies = await _parse_streaming_response_async(response_stream, callback, self.model)  # type: ignore[arg-type]
                 else:
                     response = await async_client.converse(**params)
                     replies = _parse_completion_response(response, self.model)
 
         except ClientError as exception:
-            msg = f"Could not generate inference for Amazon Bedrock model {self.model} due: {exception}"
+            msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
             raise AmazonBedrockInferenceError(msg) from exception
 
         return {"replies": replies}

haystack_integrations/components/generators/amazon_bedrock/chat/utils.py

@@ -46,7 +46,7 @@ def _format_tool_call_message(tool_call_message: ChatMessage) -> Dict[str, Any]:
     :returns:
         Dictionary representing the tool call message in Bedrock's expected format
     """
-    content = []
+    content: List[Dict[str, Any]] = []
     # Tool call message can contain text
     if tool_call_message.text:
         content.append({"text": tool_call_message.text})

haystack_integrations/components/generators/amazon_bedrock/generator.py

@@ -107,7 +107,7 @@ class AmazonBedrockGenerator:
         streaming_callback: Optional[Callable[[StreamingChunk], None]] = None,
         boto3_config: Optional[Dict[str, Any]] = None,
         model_family: Optional[MODEL_FAMILIES] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         """
         Create a new `AmazonBedrockGenerator` instance.
@@ -234,11 +234,7 @@ class AmazonBedrockGenerator:
             metadata = response.get("ResponseMetadata", {})
 
         except ClientError as exception:
-            msg = (
-                f"Could not connect to Amazon Bedrock model {self.model}. "
-                f"Make sure your AWS environment is configured correctly, "
-                f"the model is available in the configured AWS region, and you have access."
-            )
+            msg = f"Could not perform inference for Amazon Bedrock model {self.model} due to:\n{exception}"
             raise AmazonBedrockInferenceError(msg) from exception
 
         return {"replies": replies, "meta": metadata}
@@ -269,7 +265,11 @@ class AmazonBedrockGenerator:
 
         msg = (
             f"Could not auto-detect model family of {model}. "
-            f"`model_family` parameter must be one of {get_args(cls.MODEL_FAMILIES)}."
+            f"`model_family` parameter must be one of {get_args(cls.MODEL_FAMILIES)}. "
+            f"We highly recommend using the `AmazonBedrockChatGenerator` instead. "
+            f"It has additional support for Amazon's Nova Canvas, Nova Lite, "
+            f"Nova Pro, DeepSeek's DeepSeek-R1, and more models. "
+            f"See https://haystack.deepset.ai/integrations/amazon-bedrock"
         )
         raise AmazonBedrockConfigurationError(msg)
 

haystack_integrations/components/rankers/amazon_bedrock/ranker.py

@@ -256,15 +256,15 @@ class AmazonBedrockRanker:
                 sorted_docs.append(doc)
 
             return {"documents": sorted_docs}
-        except ClientError as exception:
-            msg = f"Could not inference Amazon Bedrock model {self.model_name} due to: {exception}"
+        except ClientError as client_error:
+            msg = f"Could not perform inference for Amazon Bedrock model {self.model_name} due to:\n{client_error}"
+            raise AmazonBedrockInferenceError(msg) from client_error
+        except KeyError as key_error:
+            msg = f"Unexpected response format from Amazon Bedrock: {key_error}"
+            raise AmazonBedrockInferenceError(msg) from key_error
+        except Exception as exception:
+            msg = f"Error during Amazon Bedrock API call: {exception}"
             raise AmazonBedrockInferenceError(msg) from exception
-        except KeyError as e:
-            msg = f"Unexpected response format from Amazon Bedrock: {e!s}"
-            raise AmazonBedrockInferenceError(msg) from e
-        except Exception as e:
-            msg = f"Error during Amazon Bedrock API call: {e!s}"
-            raise AmazonBedrockInferenceError(msg) from e
 
 
 class BedrockRanker(AmazonBedrockRanker):