cohere-haystack 2.0.0__tar.gz → 2.0.2__tar.gz

cohere_haystack-2.0.2/CHANGELOG.md

@@ -0,0 +1,187 @@
+# Changelog
+
+## [integrations/cohere-v2.0.1] - 2024-12-09
+
+### ⚙️ CI
+
+- Adopt uv as installer (#1142)
+
+### 🧹 Chores
+
+- Update ruff linting scripts and settings (#1105)
+- Fix linting/isort (#1215)
+
+### 🌀 Miscellaneous
+
+- Chore: use class methods to create `ChatMessage` (#1222)
+- Chore: use `text` instead of `content` for `ChatMessage` in Cohere and Anthropic (#1237)
+
+## [integrations/cohere-v2.0.0] - 2024-09-16
+
+### 🚀 Features
+
+- Update Anthropic/Cohere for tools use (#790)
+- Update Cohere default LLMs, add examples and update unit tests (#838)
+- Cohere LLM - adjust token counting meta to match OpenAI format (#1086)
+
+### 🐛 Bug Fixes
+
+- Lints in `cohere-haystack` (#995)
+
+### 🧪 Testing
+
+- Do not retry tests in `hatch run test` command (#954)
+
+### ⚙️ CI
+
+- Retry tests to reduce flakyness (#836)
+
+### 🧹 Chores
+
+- Update ruff invocation to include check parameter (#853)
+
+### 🌀 Miscellaneous
+
+- Ci: install `pytest-rerunfailures` where needed; add retry config to `test-cov` script (#845)
+- Update CohereChatGenerator docstrings (#958)
+- Update CohereGenerator docstrings (#960)
+
+## [integrations/cohere-v1.1.1] - 2024-06-12
+
+### 🌀 Miscellaneous
+
+- Chore: `CohereGenerator` - remove warning about `generate` API (#805)
+
+## [integrations/cohere-v1.1.0] - 2024-05-24
+
+### 🐛 Bug Fixes
+
+- Remove support for generate API (#755)
+
+### 🌀 Miscellaneous
+
+- Chore: change the pydoc renderer class (#718)
+
+## [integrations/cohere-v1.0.0] - 2024-05-03
+
+### 🌀 Miscellaneous
+
+- Follow up: update Cohere integration to use Cohere SDK v5 (#711)
+
+## [integrations/cohere-v0.7.0] - 2024-05-02
+
+### 🌀 Miscellaneous
+
+- Chore: add license classifiers (#680)
+- Update Cohere integration to use Cohere SDK v5 (#702)
+
+## [integrations/cohere-v0.6.0] - 2024-04-08
+
+### 🚀 Features
+
+- Add Cohere ranker (#643)
+
+## [integrations/cohere-v0.5.0] - 2024-03-29
+
+### 🌀 Miscellaneous
+
+- Add the Cohere client name to cohere requests  (#362)
+
+## [integrations/cohere-v0.4.1] - 2024-03-21
+
+### 🐛 Bug Fixes
+
+- Fix order of API docs (#447)
+- Fix tests (#561)
+
+### 📚 Documentation
+
+- Update category slug (#442)
+- Review cohere integration (#500)
+- Small consistency improvements (#536)
+- Disable-class-def (#556)
+
+### 🧹 Chores
+
+- Update Cohere integration to use new generic callable (de)serializers for their callback handlers (#453)
+- Use `serialize_callable` instead of `serialize_callback_handler` in Cohere  (#460)
+
+### 🌀 Miscellaneous
+
+- Choere - remove matching error message from tests (#419)
+- Fix linting (#509)
+- Make tests show coverage (#566)
+- Refactor tests (#574)
+- Test: relax test constraints (#591)
+- Remove references to Python 3.7 (#601)
+- Fix: Pin cohere version (#609)
+
+## [integrations/cohere-v0.4.0] - 2024-02-12
+
+### 🐛 Bug Fixes
+
+- Fix Cohere tests (#337)
+- Cohere inconsistent embeddings and documents lengths (#284)
+
+### 🚜 Refactor
+
+- [**breaking**] Use `Secret` for API keys in Cohere components (#386)
+
+### 🧪 Testing
+
+- Fix failing `TestCohereChatGenerator.test_from_dict_fail_wo_env_var` test (#393)
+
+### 🌀 Miscellaneous
+
+- Cohere: generate api docs (#321)
+- Fix: update to latest haystack-ai version (#348)
+
+## [integrations/cohere-v0.3.0] - 2024-01-25
+
+### 🐛 Bug Fixes
+
+- Fix project URLs (#96)
+- Cohere namespace reorg (#271)
+
+### 🚜 Refactor
+
+- Use `hatch_vcs` to manage integrations versioning (#103)
+
+### 🧹 Chores
+
+- [**breaking**] Rename `model_name` to `model` in the Cohere integration (#222)
+- Cohere namespace change (#247)
+
+### 🌀 Miscellaneous
+
+- Cohere: remove unused constant (#91)
+- Change default 'input_type' for CohereTextEmbedder (#99)
+- Change metadata to meta (#152)
+- Add cohere chat generator (#88)
+- Optimize API key reading (#162)
+- Cohere - change metadata to meta (#178)
+
+## [integrations/cohere-v0.2.0] - 2023-12-11
+
+### 🚀 Features
+
+- Add support for V3 Embed models to CohereEmbedders (#89)
+
+### 🌀 Miscellaneous
+
+- Cohere: increase version to prepare release (#92)
+
+## [integrations/cohere-v0.1.1] - 2023-12-07
+
+### 🌀 Miscellaneous
+
+- [cohere] Add text and document embedders (#80)
+- [cohere] fix cohere pypi version badge and add Embedder note (#86)
+
+## [integrations/cohere-v0.0.1] - 2023-12-04
+
+### 🌀 Miscellaneous
+
+- Add `cohere_haystack` integration package (#75)
+
+<!-- generated by git-cliff -->

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: cohere-haystack
-Version: 2.0.0
+Version: 2.0.2
 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

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/pyproject.toml

@@ -41,6 +41,7 @@ root = "../.."
 git_describe_command = 'git describe --tags --match="integrations/cohere-v[0-9]*"'
 
 [tool.hatch.envs.default]
+installer = "uv"
 dependencies = [
   "coverage[toml]>=6.5",
   "pytest",
@@ -60,15 +61,16 @@ docs = ["pydoc-markdown pydoc/config.yml"]
 python = ["3.8", "3.9", "3.10", "3.11"]
 
 [tool.hatch.envs.lint]
+installer = "uv"
 detached = true
-dependencies = ["black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243"]
+dependencies = ["pip", "black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243"]
 [tool.hatch.envs.lint.scripts]
 typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
 style = [
-  "ruff check {args:. --exclude tests/}",
+  "ruff check {args:.}",
   "black --check --diff {args:.}",
 ]
-fmt = ["black {args:.}", "ruff --fix {args:. --exclude tests/}", "style"]
+fmt = ["black {args:.}", "ruff check --fix {args:}", "style"]
 all = ["style", "typing"]
 
 [tool.black]
@@ -79,6 +81,8 @@ skip-string-normalization = true
 [tool.ruff]
 target-version = "py38"
 line-length = 120
+
+[tool.ruff.lint]
 select = [
   "A",
   "ARG",
@@ -127,13 +131,13 @@ unfixable = [
   "F401",
 ]
 
-[tool.ruff.isort]
-known-first-party = ["src"]
+[tool.ruff.lint.isort]
+known-first-party = ["haystack_integrations"]
 
-[tool.ruff.flake8-tidy-imports]
+[tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "parents"
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
 "tests/**/*" = ["PLR2004", "S101", "TID252"]
 

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/src/haystack_integrations/components/embedders/cohere/document_embedder.py

@@ -146,7 +146,7 @@ class CohereDocumentEmbedder:
             - `meta`: metadata about the embedding process.
         :raises TypeError: if the input is not a list of `Documents`.
         """
-        if not isinstance(documents, list) or documents and not isinstance(documents[0], Document):
+        if not isinstance(documents, list) or (documents and not isinstance(documents[0], Document)):
             msg = (
                 "CohereDocumentEmbedder expects a list of Documents as input."
                 "In case you want to embed a string, please use the CohereTextEmbedder."

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/src/haystack_integrations/components/generators/cohere/__init__.py

@@ -4,4 +4,4 @@
 from .chat.chat_generator import CohereChatGenerator
 from .generator import CohereGenerator
 
-__all__ = ["CohereGenerator", "CohereChatGenerator"]
+__all__ = ["CohereChatGenerator", "CohereGenerator"]

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/src/haystack_integrations/components/generators/cohere/chat/chat_generator.py

@@ -136,7 +136,7 @@ class CohereChatGenerator:
 
     def _message_to_dict(self, message: ChatMessage) -> Dict[str, str]:
         role = "User" if message.role == ChatRole.USER else "Chatbot"
-        chat_message = {"user_name": role, "text": message.content}
+        chat_message = {"user_name": role, "text": message.text}
         return chat_message
 
     @component.output_types(replies=List[ChatMessage])
@@ -157,7 +157,7 @@ class CohereChatGenerator:
         chat_history = [self._message_to_dict(m) for m in messages[:-1]]
         if self.streaming_callback:
             response = self.client.chat_stream(
-                message=messages[-1].content,
+                message=messages[-1].text,
                 model=self.model,
                 chat_history=chat_history,
                 **generation_kwargs,
@@ -172,7 +172,7 @@ class CohereChatGenerator:
                     response_text += event.text
                 elif event.event_type == "stream-end":
                     finish_response = event.response
-            chat_message = ChatMessage.from_assistant(content=response_text)
+            chat_message = ChatMessage.from_assistant(response_text)
 
             if finish_response and finish_response.meta:
                 if finish_response.meta.billed_units:
@@ -190,7 +190,7 @@ class CohereChatGenerator:
                 )
         else:
             response = self.client.chat(
-                message=messages[-1].content,
+                message=messages[-1].text,
                 model=self.model,
                 chat_history=chat_history,
                 **generation_kwargs,
@@ -219,7 +219,7 @@ class CohereChatGenerator:
             # TODO revisit to see if we need to handle multiple tool calls
             message = ChatMessage.from_assistant(cohere_response.tool_calls[0].json())
         elif cohere_response.text:
-            message = ChatMessage.from_assistant(content=cohere_response.text)
+            message = ChatMessage.from_assistant(cohere_response.text)
         message.meta.update(
             {
                 "model": self.model,

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/src/haystack_integrations/components/generators/cohere/generator.py

@@ -5,7 +5,7 @@ import logging
 from typing import Any, Callable, Dict, List, Optional
 
 from haystack import component
-from haystack.dataclasses import ChatMessage, ChatRole
+from haystack.dataclasses import ChatMessage
 from haystack.utils import Secret
 
 from .chat.chat_generator import CohereChatGenerator
@@ -64,7 +64,7 @@ class CohereGenerator(CohereChatGenerator):
             - `replies`: A list of replies generated by the model.
             - `meta`: Information about the request.
         """
-        chat_message = ChatMessage(content=prompt, role=ChatRole.USER, name="", meta={})
+        chat_message = ChatMessage.from_user(prompt)
         # Note we have to call super() like this because of the way components are dynamically built with the decorator
         results = super(CohereGenerator, self).run([chat_message])  # noqa
-        return {"replies": [results["replies"][0].content], "meta": [results["replies"][0].meta]}
+        return {"replies": [results["replies"][0].text], "meta": [results["replies"][0].meta]}

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/tests/test_cohere_chat_generator.py

@@ -7,6 +7,7 @@ from cohere.core import ApiError
 from haystack.components.generators.utils import print_streaming_chunk
 from haystack.dataclasses import ChatMessage, ChatRole, StreamingChunk
 from haystack.utils import Secret
+
 from haystack_integrations.components.generators.cohere import CohereChatGenerator
 
 pytestmark = pytest.mark.chat_generators
@@ -26,7 +27,7 @@ def streaming_chunk(text: str):
 
 @pytest.fixture
 def chat_messages():
-    return [ChatMessage(content="What's the capital of France", role=ChatRole.ASSISTANT, name=None)]
+    return [ChatMessage.from_assistant("What's the capital of France")]
 
 
 class TestCohereChatGenerator:
@@ -97,26 +98,6 @@ class TestCohereChatGenerator:
             },
         }
 
-    def test_to_dict_with_lambda_streaming_callback(self, monkeypatch):
-        monkeypatch.setenv("COHERE_API_KEY", "test-api-key")
-        component = CohereChatGenerator(
-            model="command-r",
-            streaming_callback=lambda x: x,
-            api_base_url="test-base-url",
-            generation_kwargs={"max_tokens": 10, "some_test_param": "test-params"},
-        )
-        data = component.to_dict()
-        assert data == {
-            "type": "haystack_integrations.components.generators.cohere.chat.chat_generator.CohereChatGenerator",
-            "init_parameters": {
-                "model": "command-r",
-                "api_base_url": "test-base-url",
-                "api_key": {"env_vars": ["COHERE_API_KEY", "CO_API_KEY"], "strict": True, "type": "env_var"},
-                "streaming_callback": "tests.test_cohere_chat_generator.<lambda>",
-                "generation_kwargs": {"max_tokens": 10, "some_test_param": "test-params"},
-            },
-        }
-
     def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("COHERE_API_KEY", "fake-api-key")
         monkeypatch.setenv("CO_API_KEY", "fake-api-key")
@@ -163,12 +144,12 @@ class TestCohereChatGenerator:
     )
     @pytest.mark.integration
     def test_live_run(self):
-        chat_messages = [ChatMessage(content="What's the capital of France", role=ChatRole.USER, name="", meta={})]
+        chat_messages = [ChatMessage.from_user("What's the capital of France")]
         component = CohereChatGenerator(generation_kwargs={"temperature": 0.8})
         results = component.run(chat_messages)
         assert len(results["replies"]) == 1
         message: ChatMessage = results["replies"][0]
-        assert "Paris" in message.content
+        assert "Paris" in message.text
         assert "usage" in message.meta
         assert "prompt_tokens" in message.meta["usage"]
         assert "completion_tokens" in message.meta["usage"]
@@ -200,13 +181,11 @@ class TestCohereChatGenerator:
 
         callback = Callback()
         component = CohereChatGenerator(streaming_callback=callback)
-        results = component.run(
-            [ChatMessage(content="What's the capital of France? answer in a word", role=ChatRole.USER, name=None)]
-        )
+        results = component.run([ChatMessage.from_user("What's the capital of France? answer in a word")])
 
         assert len(results["replies"]) == 1
         message: ChatMessage = results["replies"][0]
-        assert "Paris" in message.content
+        assert "Paris" in message.text
 
         assert message.meta["finish_reason"] == "COMPLETE"
 
@@ -223,12 +202,12 @@ class TestCohereChatGenerator:
     )
     @pytest.mark.integration
     def test_live_run_with_connector(self):
-        chat_messages = [ChatMessage(content="What's the capital of France", role=ChatRole.USER, name="", meta={})]
+        chat_messages = [ChatMessage.from_user("What's the capital of France")]
         component = CohereChatGenerator(generation_kwargs={"temperature": 0.8})
         results = component.run(chat_messages, generation_kwargs={"connectors": [{"id": "web-search"}]})
         assert len(results["replies"]) == 1
         message: ChatMessage = results["replies"][0]
-        assert "Paris" in message.content
+        assert "Paris" in message.text
         assert message.meta["documents"] is not None
         assert "citations" in message.meta  # Citations might be None
 
@@ -248,13 +227,13 @@ class TestCohereChatGenerator:
                 self.responses += chunk.content if chunk.content else ""
 
         callback = Callback()
-        chat_messages = [ChatMessage(content="What's the capital of France? answer in a word", role=None, name=None)]
+        chat_messages = [ChatMessage.from_user("What's the capital of France? answer in a word")]
         component = CohereChatGenerator(streaming_callback=callback)
         results = component.run(chat_messages, generation_kwargs={"connectors": [{"id": "web-search"}]})
 
         assert len(results["replies"]) == 1
         message: ChatMessage = results["replies"][0]
-        assert "Paris" in message.content
+        assert "Paris" in message.text
 
         assert message.meta["finish_reason"] == "COMPLETE"
 
@@ -292,10 +271,10 @@ class TestCohereChatGenerator:
 
         first_reply = replies[0]
         assert isinstance(first_reply, ChatMessage), "First reply is not a ChatMessage instance"
-        assert first_reply.content, "First reply has no content"
+        assert first_reply.text, "First reply has no text"
         assert ChatMessage.is_from(first_reply, ChatRole.ASSISTANT), "First reply is not from the assistant"
-        assert "get_stock_price" in first_reply.content.lower(), "First reply does not contain get_stock_price"
+        assert "get_stock_price" in first_reply.text.lower(), "First reply does not contain get_stock_price"
         assert first_reply.meta, "First reply has no metadata"
-        fc_response = json.loads(first_reply.content)
+        fc_response = json.loads(first_reply.text)
         assert "name" in fc_response, "First reply does not contain name of the tool"
         assert "parameters" in fc_response, "First reply does not contain parameters of the tool"

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/tests/test_cohere_generator.py

@@ -7,6 +7,7 @@ import pytest
 from cohere.core import ApiError
 from haystack.components.generators.utils import print_streaming_chunk
 from haystack.utils import Secret
+
 from haystack_integrations.components.generators.cohere import CohereGenerator
 
 pytestmark = pytest.mark.generators
@@ -77,27 +78,6 @@ class TestCohereGenerator:
             },
         }
 
-    def test_to_dict_with_lambda_streaming_callback(self, monkeypatch):
-        monkeypatch.setenv("COHERE_API_KEY", "test-api-key")
-        component = CohereGenerator(
-            model="command-r",
-            max_tokens=10,
-            some_test_param="test-params",
-            streaming_callback=lambda x: x,
-            api_base_url="test-base-url",
-        )
-        data = component.to_dict()
-        assert data == {
-            "type": "haystack_integrations.components.generators.cohere.generator.CohereGenerator",
-            "init_parameters": {
-                "model": "command-r",
-                "streaming_callback": "tests.test_cohere_generator.<lambda>",
-                "api_base_url": "test-base-url",
-                "api_key": {"type": "env_var", "env_vars": ["COHERE_API_KEY", "CO_API_KEY"], "strict": True},
-                "generation_kwargs": {},
-            },
-        }
-
     def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("COHERE_API_KEY", "fake-api-key")
         monkeypatch.setenv("CO_API_KEY", "fake-api-key")

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/tests/test_cohere_ranker.py

@@ -4,6 +4,7 @@ from unittest.mock import Mock, patch
 import pytest
 from haystack import Document
 from haystack.utils.auth import Secret
+
 from haystack_integrations.components.rankers.cohere import CohereRanker
 
 pytestmark = pytest.mark.ranker

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/tests/test_document_embedder.py

@@ -6,6 +6,7 @@ import os
 import pytest
 from haystack import Document
 from haystack.utils import Secret
+
 from haystack_integrations.components.embedders.cohere import CohereDocumentEmbedder
 
 pytestmark = pytest.mark.embedders

{cohere_haystack-2.0.0 → cohere_haystack-2.0.2}/tests/test_text_embedder.py

@@ -5,6 +5,7 @@ import os
 
 import pytest
 from haystack.utils import Secret
+
 from haystack_integrations.components.embedders.cohere import CohereTextEmbedder
 
 pytestmark = pytest.mark.embedders

cohere_haystack-2.0.0/CHANGELOG.md

@@ -1,108 +0,0 @@
-# Changelog
-
-## [unreleased]
-
-### 🚀 Features
-
-- Update Anthropic/Cohere for tools use (#790)
-- Update Cohere default LLMs, add examples and update unit tests (#838)
-
-### ⚙️ Miscellaneous Tasks
-
-- Retry tests to reduce flakyness (#836)
-
-## [integrations/cohere-v1.1.1] - 2024-06-12
-
-## [integrations/cohere-v1.1.0] - 2024-05-24
-
-### 🐛 Bug Fixes
-
-- Remove support for generate API (#755)
-
-## [integrations/cohere-v1.0.0] - 2024-05-03
-
-## [integrations/cohere-v0.7.0] - 2024-05-02
-
-## [integrations/cohere-v0.6.0] - 2024-04-08
-
-### 🚀 Features
-
-- Add Cohere ranker (#643)
-
-## [integrations/cohere-v0.5.0] - 2024-03-29
-
-## [integrations/cohere-v0.4.1] - 2024-03-21
-
-### 🐛 Bug Fixes
-
-- Fix order of API docs (#447)
-
-This PR will also push the docs to Readme
-- Fix tests (#561)
-
-* fix unit tests
-
-* try
-
-* remove flaky check
-
-### 📚 Documentation
-
-- Update category slug (#442)
-- Review cohere integration (#500)
-- Small consistency improvements (#536)
-- Disable-class-def (#556)
-
-### ⚙️ Miscellaneous Tasks
-
-- Update Cohere integration to use new generic callable (de)serializers for their callback handlers (#453)
-- Use `serialize_callable` instead of `serialize_callback_handler` in Cohere  (#460)
-
-### Cohere
-
-- Fix linting (#509)
-
-## [integrations/cohere-v0.4.0] - 2024-02-12
-
-### 🐛 Bug Fixes
-
-- Fix Cohere tests (#337)
-- Cohere inconsistent embeddings and documents lengths (#284)
-
-### 🚜 Refactor
-
-- [**breaking**] Use `Secret` for API keys in Cohere components (#386)
-
-### 🧪 Testing
-
-- Fix failing `TestCohereChatGenerator.test_from_dict_fail_wo_env_var` test (#393)
-
-## [integrations/cohere-v0.3.0] - 2024-01-25
-
-### 🐛 Bug Fixes
-
-- Fix project urls (#96)
-
-
-- Cohere namespace reorg (#271)
-
-### 🚜 Refactor
-
-- Use `hatch_vcs` to manage integrations versioning (#103)
-
-### ⚙️ Miscellaneous Tasks
-
-- [**breaking**] Rename `model_name` to `model` in the Cohere integration (#222)
-- Cohere namespace change (#247)
-
-## [integrations/cohere-v0.2.0] - 2023-12-11
-
-### 🚀 Features
-
-- Add support for V3 Embed models to CohereEmbedders (#89)
-
-## [integrations/cohere-v0.1.1] - 2023-12-07
-
-## [integrations/cohere-v0.0.1] - 2023-12-04
-
-<!-- generated by git-cliff -->