cohere-haystack 10.0.1__tar.gz → 11.0.0__tar.gz

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [integrations/cohere-v10.1.0] - 2026-09-28
+
+### 🚀 Features
+
+- *(cohere)* Add utility for API base URL validation (#4015)
+
+
+## [integrations/cohere-v10.0.1] - 2026-09-10
+
+### 🐛 Bug Fixes
+
+- Batch CohereDocumentEmbedder.run_async like the sync path (#3926)
+
+
 ## [integrations/cohere-v10.0.0] - 2026-09-04
 
 ### 🚜 Refactor

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cohere-haystack
-Version: 10.0.1
+Version: 11.0.0
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/cohere#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/cohere
@@ -10,17 +10,18 @@ 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 :: 3.15
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: cohere>=5.17.0
 Requires-Dist: haystack-ai>=3.0.0
 Requires-Dist: pydantic>=2.12.0
+Requires-Dist: pydantic>=2.14.0; python_version >= '3.15'
 Description-Content-Type: text/markdown
 
 # cohere-haystack

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = "cohere-haystack"
 dynamic = ["version"]
 description = ''
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 license = "Apache-2.0"
 keywords = []
 authors = [{ name = "deepset GmbH", email = "info@deepset.ai" }]
@@ -15,15 +15,21 @@ classifiers = [
   "License :: OSI Approved :: Apache Software License",
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
-  "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 :: 3.15",
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = ["haystack-ai>=3.0.0", "cohere>=5.17.0", "pydantic>=2.12.0"]
+dependencies = [
+  "haystack-ai>=3.0.0",
+  "cohere>=5.17.0",
+  "pydantic>=2.12.0",
+  # pydantic 2.14.0 is the first release whose pydantic-core has Python 3.15 wheels.
+  "pydantic>=2.14.0; python_version >= '3.15'",
+]
 
 [project.urls]
 Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/cohere#readme"
@@ -72,7 +78,8 @@ integration-cov-append-retry = 'pytest --cov=haystack_integrations --cov-append
 
 types = """mypy -p haystack_integrations.components.embedders.cohere \
 -p haystack_integrations.components.generators.cohere \
--p haystack_integrations.components.rankers.cohere {args}"""
+-p haystack_integrations.components.rankers.cohere \
+-p haystack_integrations.utils.cohere {args}"""
 
 [tool.mypy]
 install_types = true

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/src/haystack_integrations/components/embedders/cohere/document_embedder.py

@@ -5,9 +5,10 @@ from dataclasses import replace
 from typing import Any, ClassVar
 
 from haystack import Document, component, default_from_dict, default_to_dict
-from haystack.utils import Secret, deserialize_secrets_inplace
+from haystack.utils import Secret
 
 from cohere import AsyncClientV2, ClientV2
+from haystack_integrations.utils.cohere import validate_api_base_url
 
 from .embedding_types import EmbeddingTypes
 from .utils import get_async_response, get_response
@@ -68,7 +69,7 @@ class CohereDocumentEmbedder:
             Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
         :param input_type: specifies the type of input you're giving to the model. Supported values are
             "search_document", "search_query", "classification" and "clustering".
-        :param api_base_url: the Cohere API Base url.
+        :param api_base_url: the Cohere API Base url. The Cohere client appends the endpoint path to it.
         :param truncate: truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
             Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
             cases, input is discarded until the remaining input is exactly the maximum input token length for the model.
@@ -81,7 +82,10 @@ class CohereDocumentEmbedder:
         :param embedding_separator: separator used to concatenate the meta fields to the Document text.
         :param embedding_type: the type of embeddings to return. Defaults to float embeddings.
             Note that int8, uint8, binary, and ubinary are only valid for v3 models.
+
+        :raises ValueError: If `api_base_url` is a full endpoint URL rather than a base URL.
         """
+        validate_api_base_url(api_base_url)
 
         self.api_key = api_key
         self.model = model
@@ -155,8 +159,6 @@ class CohereDocumentEmbedder:
         # drop legacy use_async_client parameter
         init_params.pop("use_async_client", None)
 
-        deserialize_secrets_inplace(init_params, ["api_key"])
-
         # Convert embedding_type string to EmbeddingTypes enum value
         init_params["embedding_type"] = EmbeddingTypes.from_str(init_params["embedding_type"])
 

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/src/haystack_integrations/components/embedders/cohere/document_image_embedder.py

@@ -13,10 +13,11 @@ from haystack.components.converters.image.image_utils import (
     _PDFPageInfo,
 )
 from haystack.dataclasses import ByteStream
-from haystack.utils.auth import Secret, deserialize_secrets_inplace
+from haystack.utils.auth import Secret
 from tqdm import tqdm
 
 from cohere import AsyncClientV2, ClientV2
+from haystack_integrations.utils.cohere import validate_api_base_url
 
 from .embedding_types import EmbeddingTypes
 
@@ -101,7 +102,7 @@ class CohereDocumentImageEmbedder:
             The Cohere model to use for calculating embeddings.
             Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
         :param api_base_url:
-            The Cohere API base URL.
+            The Cohere API base URL. The Cohere client appends the endpoint path to it.
         :param timeout:
             Request timeout in seconds.
         :param embedding_dimension:
@@ -114,7 +115,10 @@ class CohereDocumentImageEmbedder:
         :param progress_bar:
             Whether to show a progress bar or not. Can be helpful to disable in production deployments
             to keep the logs clean.
+
+        :raises ValueError: If `api_base_url` is a full endpoint URL rather than a base URL.
         """
+        validate_api_base_url(api_base_url)
 
         self.file_path_meta_field = file_path_meta_field
         self.root_path = root_path or ""
@@ -184,7 +188,6 @@ class CohereDocumentImageEmbedder:
             Deserialized component.
         """
         init_params = data["init_parameters"]
-        deserialize_secrets_inplace(init_params, keys=["api_key"])
         init_params["embedding_type"] = EmbeddingTypes.from_str(init_params["embedding_type"])
 
         return default_from_dict(cls, data)

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/src/haystack_integrations/components/embedders/cohere/text_embedder.py

@@ -4,9 +4,10 @@
 from typing import Any, ClassVar
 
 from haystack import component, default_from_dict, default_to_dict
-from haystack.utils import Secret, deserialize_secrets_inplace
+from haystack.utils import Secret
 
 from cohere import AsyncClientV2, ClientV2
+from haystack_integrations.utils.cohere import validate_api_base_url
 
 from .embedding_types import EmbeddingTypes
 from .utils import get_async_response, get_response
@@ -60,7 +61,7 @@ class CohereTextEmbedder:
             Read [Cohere documentation](https://docs.cohere.com/docs/models#embed) for a list of all supported models.
         :param input_type: specifies the type of input you're giving to the model. Supported values are
         "search_document", "search_query", "classification" and "clustering".
-        :param api_base_url: the Cohere API Base url.
+        :param api_base_url: the Cohere API Base url. The Cohere client appends the endpoint path to it.
         :param truncate: truncate embeddings that are too long from start or end, ("NONE"|"START"|"END").
             Passing "START" will discard the start of the input. "END" will discard the end of the input. In both
             cases, input is discarded until the remaining input is exactly the maximum input token length for the model.
@@ -68,7 +69,10 @@ class CohereTextEmbedder:
         :param timeout: request timeout in seconds.
         :param embedding_type: the type of embeddings to return. Defaults to float embeddings.
             Note that int8, uint8, binary, and ubinary are only valid for v3 models.
+
+        :raises ValueError: If `api_base_url` is a full endpoint URL rather than a base URL.
         """
+        validate_api_base_url(api_base_url)
 
         self.api_key = api_key
         self.model = model
@@ -142,8 +146,6 @@ class CohereTextEmbedder:
         # drop legacy use_async_client parameter
         init_params.pop("use_async_client", None)
 
-        deserialize_secrets_inplace(init_params, ["api_key"])
-
         # Convert embedding_type string to EmbeddingTypes enum value
         init_params["embedding_type"] = EmbeddingTypes.from_str(init_params["embedding_type"])
 

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/src/haystack_integrations/components/generators/cohere/chat/chat_generator.py

@@ -29,6 +29,7 @@ from httpx import AsyncHTTPTransport, HTTPTransport
 from httpx import Client as HTTPXClient
 
 from cohere import AsyncClientV2, ChatResponse, ClientV2, StreamedChatResponseV2
+from haystack_integrations.utils.cohere import validate_api_base_url
 
 logger = logging.getLogger(__name__)
 
@@ -459,13 +460,11 @@ class CohereChatGenerator:
 
     ### Advanced example
 
-    CohereChatGenerator can be integrated into pipelines and supports Haystack's tooling
-    architecture, enabling tools to be invoked seamlessly across various generators.
+    CohereChatGenerator supports Haystack's tooling architecture, so it can drive tool calls in an `Agent`.
 
     ```python
-    from haystack import Pipeline
+    from haystack.components.agents import Agent
     from haystack.dataclasses import ChatMessage
-    from haystack.components.tools import ToolInvoker
     from haystack.tools import Tool
     from haystack_integrations.components.generators.cohere import CohereChatGenerator
 
@@ -489,20 +488,12 @@ class CohereChatGenerator:
         function=weather,
     )
 
-    # Create and set up the pipeline
-    pipeline = Pipeline()
-    pipeline.add_component("generator", CohereChatGenerator(tools=[weather_tool]))
-    pipeline.add_component("tool_invoker", ToolInvoker(tools=[weather_tool]))
-    pipeline.connect("generator", "tool_invoker")
+    # The Agent calls the tool and feeds the result back to the model
+    agent = Agent(chat_generator=CohereChatGenerator(), tools=[weather_tool])
+    result = agent.run(messages=[ChatMessage.from_user("What's the weather like in Paris?")])
 
-    # Run the pipeline with a weather query
-    results = pipeline.run(
-        data={"generator": {"messages": [ChatMessage.from_user("What's the weather like in Paris?")]}}
-    )
-
-    # The tool result will be available in the pipeline output
-    print(results["tool_invoker"]["tool_messages"][0].tool_call_result.result)
-    # Output: "The weather in Paris is sunny and 32°C"
+    print(result["last_message"].text)
+    # Output: "The weather in Paris is sunny and 32°C."
     ```
     """
 
@@ -544,7 +535,7 @@ class CohereChatGenerator:
         :param streaming_callback: A callback function that is called when a new token is received from the stream.
             The callback function accepts [StreamingChunk](https://docs.haystack.deepset.ai/docs/data-classes#streamingchunk)
             as an argument.
-        :param api_base_url: The base URL of the Cohere API.
+        :param api_base_url: The base URL of the Cohere API. The Cohere client appends the endpoint path to it.
         :param generation_kwargs: Other parameters to use for the model during generation. For a list of parameters,
             see [Cohere Chat endpoint](https://docs.cohere.com/reference/chat).
             Some of the parameters are:
@@ -564,11 +555,13 @@ class CohereChatGenerator:
             Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
             the Cohere client.
 
+        :raises ValueError: If `api_base_url` is a full endpoint URL rather than a base URL.
         """
         _check_duplicate_tool_names(flatten_tools_or_toolsets(tools))
 
         if not api_base_url:
             api_base_url = "https://api.cohere.com"
+        validate_api_base_url(api_base_url)
 
         self.api_key = api_key
         self.model = model

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/src/haystack_integrations/components/rankers/cohere/ranker.py

@@ -2,9 +2,10 @@ from dataclasses import replace
 from typing import Any
 
 from haystack import Document, component, default_from_dict, default_to_dict, logging
-from haystack.utils import Secret, deserialize_secrets_inplace
+from haystack.utils import Secret
 
 from cohere import AsyncClientV2, ClientV2
+from haystack_integrations.utils.cohere import validate_api_base_url
 
 logger = logging.getLogger(__name__)
 
@@ -48,19 +49,22 @@ class CohereRanker:
         :param model: Cohere model name. Check the list of supported models in the [Cohere documentation](https://docs.cohere.com/docs/models).
         :param top_k: The maximum number of documents to return.
         :param api_key: Cohere API key.
-        :param api_base_url: the base URL of the Cohere API.
+        :param api_base_url: the base URL of the Cohere API. The Cohere client appends the endpoint path to it.
         :param meta_fields_to_embed: List of meta fields that should be concatenated
             with the document content for reranking.
         :param meta_data_separator: Separator used to concatenate the meta fields
             to the Document content.
         :param max_tokens_per_doc: The maximum number of tokens to embed for each document defaults to 4096.
 
-        :raises ValueError: If `top_k` is not > 0.
+        :raises ValueError: If `top_k` is not > 0, or if `api_base_url` is a full endpoint URL rather than a
+            base URL.
         """
         if top_k <= 0:
             msg = f"top_k must be > 0, but got {top_k}"
             raise ValueError(msg)
 
+        validate_api_base_url(api_base_url)
+
         self.model_name = model
         self.api_key = api_key
         self.api_base_url = api_base_url
@@ -119,7 +123,6 @@ class CohereRanker:
         # was serialized with the old version
         data["init_parameters"].pop("max_chunks_per_doc", None)
 
-        deserialize_secrets_inplace(data["init_parameters"], keys=["api_key"])
         return default_from_dict(cls, data)
 
     def _prepare_cohere_input_docs(self, documents: list[Document], top_k: int | None = None) -> tuple[list[str], int]:

cohere_haystack-11.0.0/src/haystack_integrations/utils/cohere/__init__.py

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+from .api_base_url import validate_api_base_url
+
+__all__ = ["validate_api_base_url"]

cohere_haystack-11.0.0/src/haystack_integrations/utils/cohere/api_base_url.py

@@ -0,0 +1,29 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+import re
+
+# Cohere clients build a request URL by appending the endpoint path to the configured base URL, so a base URL that
+# already ends with one of these paths produces a doubled path and a generic API error at request time.
+_COHERE_ENDPOINT_PATH = re.compile(r"/v\d+/(?:rerank|embed|chat)$")
+
+
+def validate_api_base_url(api_base_url: str) -> None:
+    """
+    Check that `api_base_url` is a base URL rather than a full endpoint URL.
+
+    :param api_base_url: The base URL to validate.
+    :raises ValueError: If `api_base_url` ends with a Cohere endpoint path, which the Cohere client appends itself.
+    """
+    trimmed = api_base_url.rstrip("/")
+    match = _COHERE_ENDPOINT_PATH.search(trimmed)
+    if match is None:
+        return
+
+    base = trimmed[: match.start()]
+    hint = f" and pass '{base}' instead" if base else ""
+    msg = (
+        f"'api_base_url' must be a base URL, not a full endpoint URL, but got {api_base_url!r}. "
+        f"The Cohere client appends the endpoint path itself, so remove the trailing '{match.group()}'{hint}."
+    )
+    raise ValueError(msg)

cohere_haystack-11.0.0/tests/test_api_base_url.py

@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+import pytest
+
+from haystack_integrations.components.embedders.cohere import (
+    CohereDocumentEmbedder,
+    CohereDocumentImageEmbedder,
+    CohereTextEmbedder,
+)
+from haystack_integrations.components.generators.cohere import CohereChatGenerator
+from haystack_integrations.components.rankers.cohere import CohereRanker
+from haystack_integrations.utils.cohere import validate_api_base_url
+
+
+class TestValidateApiBaseUrl:
+    @pytest.mark.parametrize(
+        "api_base_url",
+        [
+            "https://api.cohere.com",
+            "https://api.cohere.com/",
+            "https://resource.services.ai.azure.com/models",
+            # only a trailing endpoint path is rejected, not one in the middle of the base path
+            "https://gateway.example.com/v2/rerank/proxy",
+        ],
+    )
+    def test_accepts_base_urls(self, api_base_url):
+        validate_api_base_url(api_base_url)
+
+    @pytest.mark.parametrize(
+        "api_base_url",
+        [
+            "https://api.cohere.com/v1/rerank",
+            "https://api.cohere.com/v2/embed",
+            "https://api.cohere.com/v2/chat",
+            # a future API version is rejected without needing a new entry in the pattern
+            "https://api.cohere.com/v3/rerank",
+        ],
+    )
+    def test_rejects_endpoint_urls(self, api_base_url):
+        with pytest.raises(ValueError, match="must be a base URL"):
+            validate_api_base_url(api_base_url)
+
+    @pytest.mark.parametrize("suffix", ["", "/", "//"])
+    def test_error_names_the_endpoint_path_and_the_corrected_url(self, suffix):
+        url = f"https://resource.services.ai.azure.com/models/v2/rerank{suffix}"
+        with pytest.raises(ValueError) as exc_info:
+            validate_api_base_url(url)
+
+        message = str(exc_info.value)
+        assert "remove the trailing '/v2/rerank'" in message
+        assert "pass 'https://resource.services.ai.azure.com/models' instead" in message
+
+    def test_omits_the_hint_when_nothing_would_remain(self):
+        with pytest.raises(ValueError) as exc_info:
+            validate_api_base_url("/v2/rerank")
+
+        assert "instead" not in str(exc_info.value)
+
+
+@pytest.mark.parametrize(
+    "component_cls",
+    [
+        CohereRanker,
+        CohereTextEmbedder,
+        CohereDocumentEmbedder,
+        CohereDocumentImageEmbedder,
+        CohereChatGenerator,
+    ],
+)
+def test_components_reject_full_endpoint_urls(component_cls, monkeypatch):
+    monkeypatch.setenv("COHERE_API_KEY", "test-api-key")
+
+    with pytest.raises(ValueError, match="must be a base URL"):
+        component_cls(api_base_url="https://resource.services.ai.azure.com/models/v2/rerank")

{cohere_haystack-10.0.1 → cohere_haystack-11.0.0}/tests/test_chat_generator.py

@@ -4,12 +4,8 @@ from unittest.mock import AsyncMock, MagicMock, patch
 import pytest
 from cohere.core import ApiError
 from haystack import Pipeline
+from haystack.components.agents import Agent
 from haystack.components.generators.utils import print_streaming_chunk
-
-try:
-    from haystack.components.tools import ToolInvoker
-except ImportError:  # ToolInvoker was removed in Haystack 3.0
-    ToolInvoker = None
 from haystack.dataclasses import ChatMessage, ChatRole, ImageContent, ToolCall
 from haystack.dataclasses.streaming_chunk import StreamingChunk
 from haystack.tools import Tool, Toolset
@@ -810,10 +806,9 @@ class TestCohereChatGeneratorInference:
         assert len(final_message.text) > 0
         assert "paris" in final_message.text.lower()
 
-    @pytest.mark.skipif(ToolInvoker is None, reason="ToolInvoker is not available in the installed haystack-ai version")
-    def test_pipeline_with_cohere_chat_generator(self):
+    def test_agent_with_cohere_chat_generator(self):
         """
-        Test that the CohereChatGenerator component can be used in a pipeline
+        Test that the CohereChatGenerator component can drive tool calls in an Agent
         """
         weather_tool = Tool(
             name="weather",
@@ -831,20 +826,11 @@ class TestCohereChatGeneratorInference:
             function=weather,
         )
 
-        pipeline = Pipeline()
-        pipeline.add_component("generator", CohereChatGenerator(model="command-r7b-12-2024", tools=[weather_tool]))
-        pipeline.add_component("tool_invoker", ToolInvoker(tools=[weather_tool]))
-
-        pipeline.connect("generator", "tool_invoker")
+        agent = Agent(chat_generator=CohereChatGenerator(model="command-r7b-12-2024"), tools=[weather_tool])
+        result = agent.run(messages=[ChatMessage.from_user("What's the weather like in Paris?")])
 
-        results = pipeline.run(
-            data={"generator": {"messages": [ChatMessage.from_user("What's the weather like in Paris?")]}}
-        )
-
-        assert (
-            "The weather in Paris is sunny and 32°C"
-            == results["tool_invoker"]["tool_messages"][0].tool_call_result.result
-        )
+        tool_results = [msg.tool_call_result.result for msg in result["messages"] if msg.tool_call_result]
+        assert "The weather in Paris is sunny and 32°C" in tool_results
 
     def test_live_run_multimodal(self):
         generator = CohereChatGenerator(