addressing review comments

Author: divyaruhil

.github/labeler.yml

@@ -169,6 +169,11 @@ integration:unstructured-fileconverter:
       - any-glob-to-any-file: "integrations/unstructured/**/*"
       - any-glob-to-any-file: ".github/workflows/unstructured.yml"
 
+integration:watsonx:
+  - changed-files:
+      - any-glob-to-any-file: "integrations/watsonx/**/*"
+      - any-glob-to-any-file: ".github/workflows/watsonx.yml"      
+
 integration:weaviate:
   - changed-files:
       - any-glob-to-any-file: "integrations/weaviate/**/*"

.github/workflows/watsonx.yml

@@ -30,8 +30,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]  # Start with Linux only, add others later
-        python-version: ["3.9", "3.10", "3.11", "3.12"]  # Watsonx supported versions
+        os: [ubuntu-latest, windows-latest, macos-latest] 
+        python-version: ["3.10", "3.12"]  
 
     steps:
       - uses: actions/checkout@v4
@@ -49,10 +49,10 @@ jobs:
 
       - name: Lint
         if: matrix.python-version == '3.9' && runner.os == 'Linux'
-        run: hatch run lint
+        run: hatch run fmt-check && hatch run test:types
 
       - name: Run tests
-        run: hatch run test
+        run: hatch run test:cov-retry
 
       - name: Run unit tests with lowest direct dependencies
         run: |

integrations/watsonx/examples/chat_generator_example.py

@@ -2,32 +2,33 @@
 import asyncio
 import os
 
+import nest_asyncio
 from haystack.dataclasses import ChatMessage
 from haystack.utils.auth import Secret
 
 from haystack_integrations.components.generators.watsonx.chat.chat_generator import WatsonxChatGenerator
 
 # Initialize the generator
 generator = WatsonxChatGenerator(
-    api_key=Secret.from_env_var('WATSONX_API_KEY'),  # Or use from_token("<apikey>")
-    model='meta-llama/llama-3-2-1b-instruct',
-    project_id=os.getenv('WATSONX_PROJECT_ID'),
+    api_key=Secret.from_env_var("WATSONX_API_KEY"),  # Or use from_token("<apikey>")
+    model="meta-llama/llama-3-2-1b-instruct",
+    project_id=os.getenv("WATSONX_PROJECT_ID"),
     generation_kwargs={
-        'max_tokens': 500,
-        'temperature': 0.7,
-        'top_p': 0.9,
+        "max_tokens": 500,
+        "temperature": 0.7,
+        "top_p": 0.9,
     },
     tools=[
         {
-            'name': 'get_weather',
-            'description': 'Get the current weather in a given location',
-            'parameters': {
-                'type': 'object',
-                'properties': {
-                    'location': {'type': 'string', 'description': 'The city and state, e.g. San Francisco, CA'},
-                    'unit': {'type': 'string', 'enum': ['celsius', 'fahrenheit'], 'default': 'celsius'},
+            "name": "get_weather",
+            "description": "Get the current weather in a given location",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {"type": "string", "description": "The city and state, e.g. San Francisco, CA"},
+                    "unit": {"type": "string", "enum": ["celsius", "fahrenheit"], "default": "celsius"},
                 },
-                'required': ['location'],
+                "required": ["location"],
             },
         }
     ],
@@ -39,8 +40,8 @@
 # Example 1: Basic synchronous chat
 def basic_chat():
     messages = [
-        ChatMessage.from_system('You are a helpful assistant.'),
-        ChatMessage.from_user('Explain quantum computing in simple terms'),
+        ChatMessage.from_system("You are a helpful assistant."),
+        ChatMessage.from_user("Explain quantum computing in simple terms"),
     ]
     generator.run(messages)
 
@@ -49,7 +50,7 @@ def basic_chat():
 def tool_calling_chat():
     messages = [ChatMessage.from_user("What's the weather in Berlin today?")]
     response = generator.run(messages)
-    reply = response['replies'][0]
+    reply = response["replies"][0]
     if reply.tool_calls:
         for _tool_call in reply.tool_calls:
             pass
@@ -59,14 +60,14 @@ def tool_calling_chat():
 
 # Example 3: Streaming chat (sync)
 def streaming_chat():
-    messages = [ChatMessage.from_user('Write a short poem about artificial intelligence')]
+    messages = [ChatMessage.from_user("Write a short poem about artificial intelligence")]
     generator.run(messages, stream=True)
 
 
 # Example 4: Asynchronous chat
 def run_async_chat():
     async def _async_chat():
-        messages = [ChatMessage.from_user('Tell me about the history of the internet')]
+        messages = [ChatMessage.from_user("Tell me about the history of the internet")]
         await generator.run_async(messages)
 
     _run_async(_async_chat)
@@ -75,7 +76,7 @@ async def _async_chat():
 # Example 5: Asynchronous streaming chat
 def run_async_streaming_chat():
     async def _async_streaming_chat():
-        messages = [ChatMessage.from_user('Explain blockchain technology')]
+        messages = [ChatMessage.from_user("Explain blockchain technology")]
         await generator.run_async(messages, stream=True)
 
     _run_async(_async_streaming_chat)
@@ -90,16 +91,14 @@ def _run_async(coro_func):
         else:
             return loop.run_until_complete(coro_func())
     except RuntimeError:
-        import nest_asyncio
-
         nest_asyncio.apply()
         loop = asyncio.new_event_loop()
         asyncio.set_event_loop(loop)
         return loop.run_until_complete(coro_func())
 
 
 # Main
-if __name__ == '__main__':
+if __name__ == "__main__":
     basic_chat()
     tool_calling_chat()
     streaming_chat()

integrations/watsonx/examples/embedders_example.py

@@ -8,47 +8,47 @@
 from haystack_integrations.components.embedders.watsonx.text_embedder import WatsonXTextEmbedder
 
 # Step 1: Set your credentials
-api_key = '<api-key>'
-project_id = '<project-id>'
+api_key = "<api-key>"
+project_id = "<project-id>"
 
 # Step 2: Create document store
-document_store = InMemoryDocumentStore(embedding_similarity_function='cosine')
+document_store = InMemoryDocumentStore(embedding_similarity_function="cosine")
 
 # Step 3: Prepare documents
 documents = [
-    Document(content='I saw a black horse running'),
-    Document(content='Germany has many big cities'),
-    Document(content='My name is Wolfgang and I live in Berlin'),
+    Document(content="I saw a black horse running"),
+    Document(content="Germany has many big cities"),
+    Document(content="My name is Wolfgang and I live in Berlin"),
 ]
 
 # Step 4: Embed documents
 document_embedder = WatsonXDocumentEmbedder(
-    model='ibm/slate-125m-english-rtrvr',
+    model="ibm/slate-125m-english-rtrvr",
     api_key=Secret.from_token(api_key),
     project_id=project_id,
-    url='https://us-south.ml.cloud.ibm.com',
+    url="https://us-south.ml.cloud.ibm.com",
 )
-documents_with_embeddings = document_embedder.run(documents)['documents']
+documents_with_embeddings = document_embedder.run(documents)["documents"]
 
 document_store.write_documents(documents_with_embeddings)
 
 # Step 5: Build pipeline
 query_pipeline = Pipeline()
 query_pipeline.add_component(
-    'text_embedder',
+    "text_embedder",
     WatsonXTextEmbedder(
-        model='ibm/slate-125m-english-rtrvr',
+        model="ibm/slate-125m-english-rtrvr",
         api_key=Secret.from_token(api_key),
         project_id=project_id,
-        url='https://us-south.ml.cloud.ibm.com',
+        url="https://us-south.ml.cloud.ibm.com",
     ),
 )
-query_pipeline.add_component('retriever', InMemoryEmbeddingRetriever(document_store=document_store))
-query_pipeline.connect('text_embedder.embedding', 'retriever.query_embedding')
+query_pipeline.add_component("retriever", InMemoryEmbeddingRetriever(document_store=document_store))
+query_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")
 
 # Step 6: Run query
-query = 'Who lives in Berlin?'
-result = query_pipeline.run({'text_embedder': {'text': query}})
+query = "Who lives in Berlin?"
+result = query_pipeline.run({"text_embedder": {"text": query}})
 
 # Step 7: Print result
 

integrations/watsonx/examples/generator_example.py

@@ -8,18 +8,18 @@
 
 # Basic Usage of WatsonxGenerator
 generator = WatsonxGenerator(
-    model='ibm/granite-13b-instruct-v2',
-    api_key=Secret.from_env_var('WATSONX_API_KEY'),
-    project_id=os.getenv('WATSONX_PROJECT_ID'),
+    model="ibm/granite-13b-instruct-v2",
+    api_key=Secret.from_env_var("WATSONX_API_KEY"),
+    project_id=os.getenv("WATSONX_PROJECT_ID"),
     generation_kwargs={
-        'max_new_tokens': 100,
-        'temperature': 0.7,
-        'top_p': 0.9,
-        'decoding_method': 'sample',
-        'concurrency_limit': 5,
+        "max_new_tokens": 100,
+        "temperature": 0.7,
+        "top_p": 0.9,
+        "decoding_method": "sample",
+        "concurrency_limit": 5,
     },
 )
-prompts = ['Who is the president of the USA?', 'What is the tallest mountain?']
+prompts = ["Who is the president of the USA?", "What is the tallest mountain?"]
 
 for prompt in prompts:
     result = generator.run(prompt)
@@ -32,19 +32,19 @@
 
 # Initialize with streaming enabled
 streaming_generator = WatsonxGenerator(
-    api_key=Secret.from_token(os.environ['WATSONX_API_KEY']),
-    model='ibm/granite-13b-instruct-v2',
-    project_id=os.environ['WATSONX_PROJECT_ID'],
-    generation_kwargs={'max_new_tokens': 450, 'temperature': 0.9, 'top_p': 0.9, 'repetition_penalty': 1.2},
+    api_key=Secret.from_token(os.environ["WATSONX_API_KEY"]),
+    model="ibm/granite-13b-instruct-v2",
+    project_id=os.environ["WATSONX_PROJECT_ID"],
+    generation_kwargs={"max_new_tokens": 450, "temperature": 0.9, "top_p": 0.9, "repetition_penalty": 1.2},
 )
 
 # Create pipeline
 streaming_pipeline = Pipeline()
-streaming_pipeline.add_component('generator', streaming_generator)
+streaming_pipeline.add_component("generator", streaming_generator)
 
 # Run with streaming
-prompt = 'Write a short story about an AI assistant.'
-result = streaming_pipeline.run({'generator': {'prompt': prompt, 'stream': True}})
+prompt = "Write a short story about an AI assistant."
+result = streaming_pipeline.run({"generator": {"prompt": prompt, "stream": True}})
 
 # Process streaming results
 

integrations/watsonx/pyproject.toml

@@ -7,14 +7,16 @@ name = "watsonx-haystack"
 version = "0.1.0" 
 description = "Watsonx integration for Haystack"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 license = "Apache-2.0"
-authors = [{ name = "Divya", email = "[email protected]" }]
+authors = [
+    { name = "Divya", email = "[email protected]" },
+    { name = "deepset GmbH", email = "[email protected]" },
+]
 classifiers = [
     "License :: OSI Approved :: Apache Software License",
     "Development Status :: 4 - Beta",
     "Programming Language :: Python",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -47,7 +49,6 @@ dependencies = [
 docs = ["pydoc-markdown pydoc/config.yml"]
 fmt = "ruff check --fix {args:.} && ruff format {args:.}"
 fmt-check = "ruff check {args:.} && ruff format --check {args:.}"
-test = "pytest"
 
 [tool.hatch.envs.test]
 dependencies = [
@@ -69,6 +70,12 @@ all = 'pytest {args:tests}'
 cov-retry = 'all --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x'
 types = "mypy -p haystack_integrations.components.generators.watsonx {args}"
 
+[tool.mypy]
+install_types = true
+non_interactive = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+
 [tool.hatch.envs.docs]
 dependencies = ["haystack-pydoc-tools"]
 
@@ -88,6 +95,7 @@ markers = [
     "integration: mark tests as integration tests"
 ]
 asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "class"
 addopts = "--tb=short -v"
 
 [tool.black]
@@ -138,13 +146,8 @@ ignore = [
 known-first-party = ["haystack_integrations"]
 
 [tool.ruff.lint.per-file-ignores]
-"examples/**" = ["T201", "RET505", "INP001"]
-"watsonx/tests/**" = ["ALL"]
-"tests/**" = ["ALL"]
-"**/test_*.py" = ["ALL"]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]
 
 [tool.ruff.lint.flake8-tidy-imports]
-ban-relative-imports = "parents"
-
-[tool.ruff.format]
-quote-style = "single"
+ban-relative-imports = "parents"

integrations/watsonx/src/haystack_integrations/components/embedders/watsonx/__init__.py

@@ -1,4 +1,7 @@
+# SPDX-FileCopyrightText: 2025-present deepset GmbH <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
 from haystack_integrations.components.embedders.watsonx.document_embedder import WatsonXDocumentEmbedder
 from haystack_integrations.components.embedders.watsonx.text_embedder import WatsonXTextEmbedder
 
-__all__ = ['WatsonXDocumentEmbedder', 'WatsonXTextEmbedder']
+__all__ = ["WatsonXDocumentEmbedder", "WatsonXTextEmbedder"]