rename together_ai to togetherai (#2451)

anakin87 · web-flow · commit 17b642097c9b · 2025-10-23T17:10:39.000+02:00
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -174,10 +174,10 @@ integration:stackit:
       - any-glob-to-any-file: "integrations/stackit/**/*"
       - any-glob-to-any-file: ".github/workflows/stackit.yml"
 
-integration:together-ai:
+integration:togetherai:
   - changed-files:
-      - any-glob-to-any-file: "integrations/together_ai/**/*"
-      - any-glob-to-any-file: ".github/workflows/together_ai.yml"
+      - any-glob-to-any-file: "integrations/togetherai/**/*"
+      - any-glob-to-any-file: ".github/workflows/togetherai.yml"
 
 integration:unstructured-fileconverter:
   - changed-files:
diff --git a/.github/workflows/togetherai.yml b/.github/workflows/togetherai.yml
@@ -1,22 +1,22 @@
 # This workflow comes from https://github.com/ofek/hatch-mypyc
 # https://github.com/ofek/hatch-mypyc/blob/5a198c0ba8660494d02716cfc9d79ce4adfb1442/.github/workflows/test.yml
-name: Test / together_ai
+name: Test / togetherai
 
 on:
   schedule:
     - cron: "0 0 * * *"
   pull_request:
     paths:
-      - "integrations/together_ai/**"
-      - "!integrations/together_ai/*.md"
-      - ".github/workflows/together_ai.yml"
+      - "integrations/togetherai/**"
+      - "!integrations/togetherai/*.md"
+      - ".github/workflows/togetherai.yml"
 
 defaults:
   run:
-    working-directory: integrations/together_ai
+    working-directory: integrations/togetherai
 
 concurrency:
-  group: together_ai-${{ github.head_ref }}
+  group: togetherai-${{ github.head_ref }}
   cancel-in-progress: true
 
 env:
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ Please check out our [Contribution Guidelines](CONTRIBUTING.md) for all the deta
 | [ragas-haystack](integrations/ragas/)                                                                          | Evaluator                   | [![PyPI - Version](https://img.shields.io/pypi/v/ragas-haystack.svg)](https://pypi.org/project/ragas-haystack)                                           | [![Test / ragas](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/ragas.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/ragas.yml)                                              |
 | [snowflake-haystack](integrations/snowflake/)                                                                  | Retriever                   | [![PyPI - Version](https://img.shields.io/pypi/v/snowflake-haystack.svg)](https://pypi.org/project/snowflake-haystack)                                   | [![Test / snowflake](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/snowflake.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/snowflake.yml)                                  |
 | [stackit-haystack](integrations/stackit/)                                                                      | Embedder, Generator         | [![PyPI - Version](https://img.shields.io/pypi/v/stackit-haystack.svg)](https://pypi.org/project/stackit-haystack)                                       | [![Test / stackit](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/stackit.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/stackit.yml)                                        |
-| [togetherai-haystack](integrations/together_ai/)                                                                      | Generator         | [![PyPI - Version](https://img.shields.io/pypi/v/togetherai-haystack.svg)](https://pypi.org/project/togetherai-haystack)                                       | [![Test / together_ai](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/together_ai.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/together_ai.yml)                                        |
+| [togetherai-haystack](integrations/togetherai/)                                                                      | Generator         | [![PyPI - Version](https://img.shields.io/pypi/v/togetherai-haystack.svg)](https://pypi.org/project/togetherai-haystack)                                       | [![Test / togetherai](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/togetherai.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/togetherai.yml)                                        |
 | [unstructured-fileconverter-haystack](integrations/unstructured/)                                              | File converter              | [![PyPI - Version](https://img.shields.io/pypi/v/unstructured-fileconverter-haystack.svg)](https://pypi.org/project/unstructured-fileconverter-haystack) | [![Test / unstructured](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/unstructured.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/unstructured.yml)                         |
 | [watsonx-haystack](integrations/watsonx/)                                                                      | Embedder, Generator         | [![PyPI - Version](https://img.shields.io/pypi/v/watsonx-haystack.svg?color=orange)](https://pypi.org/project/watsonx-haystack)                          | [![Test / watsonx](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/watsonx.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/watsonx.yml) |                                      |
 | [weaviate-haystack](integrations/weaviate/)                                                                    | Document Store              | [![PyPI - Version](https://img.shields.io/pypi/v/weaviate-haystack.svg)](https://pypi.org/project/weaviate-haystack)                                     | [![Test / weaviate](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/weaviate.yml/badge.svg)](https://github.com/deepset-ai/haystack-core-integrations/actions/workflows/weaviate.yml)                                     |
diff --git a/integrations/togetherai/CHANGELOG.md b/integrations/togetherai/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## [integrations/together_ai-v1.0.0] - 2025-10-14
+## [integrations/togetherai-v1.0.0] - 2025-10-14
 
 ### 🚀 Features
 
diff --git a/integrations/togetherai/LICENSE.txt b/integrations/togetherai/LICENSE.txt
diff --git a/integrations/togetherai/README.md b/integrations/togetherai/README.md
@@ -3,8 +3,8 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/togetherai-haystack.svg)](https://pypi.org/project/togetherai-haystack)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/togetherai-haystack.svg)](https://pypi.org/project/togetherai-haystack)
 
-- [Integration page](https://haystack.deepset.ai/integrations/together_ai)
-- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/together_ai/CHANGELOG.md)
+- [Integration page](https://haystack.deepset.ai/integrations/togetherai)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/togetherai/CHANGELOG.md)
 
 ---
 
diff --git a/integrations/togetherai/examples/chat_generator_with_tools.py b/integrations/togetherai/examples/chat_generator_with_tools.py
@@ -11,7 +11,7 @@
 from haystack.dataclasses import ChatMessage
 from haystack.tools import Tool
 
-from haystack_integrations.components.generators.together_ai import TogetherAIChatGenerator
+from haystack_integrations.components.generators.togetherai import TogetherAIChatGenerator
 
 
 # Define a tool that models can call
diff --git a/integrations/togetherai/examples/generator_example.py b/integrations/togetherai/examples/generator_example.py
@@ -9,7 +9,7 @@
 
 from haystack.utils import Secret
 
-from haystack_integrations.components.generators.together_ai.generator import TogetherAIGenerator
+from haystack_integrations.components.generators.togetherai.generator import TogetherAIGenerator
 
 generator = TogetherAIGenerator(
     model="meta-llama/Llama-3.3-70B-Instruct-Turbo",
diff --git a/integrations/togetherai/pydoc/config.yml b/integrations/togetherai/pydoc/config.yml
@@ -2,8 +2,8 @@ loaders:
   - type: haystack_pydoc_tools.loaders.CustomPythonLoader
     search_path: [../src]
     modules: [
-      "haystack_integrations.components.generators.together_ai.generator",
-      "haystack_integrations.components.generators.together_ai.chat.chat_generator",
+      "haystack_integrations.components.generators.togetherai.generator",
+      "haystack_integrations.components.generators.togetherai.chat.chat_generator",
     ]
     ignore_when_discovered: ["__init__"]
 processors:
@@ -27,4 +27,4 @@ renderer:
     descriptive_module_title: true
     add_method_class_prefix: true
     add_member_class_prefix: false
-    filename: _readme_together_ai.md
+    filename: _readme_togetherai.md
diff --git a/integrations/togetherai/pydoc/config_docusaurus.yml b/integrations/togetherai/pydoc/config_docusaurus.yml
@@ -2,8 +2,8 @@ loaders:
 - ignore_when_discovered:
   - __init__
   modules:
-  - haystack_integrations.components.generators.together_ai.generator
-  - haystack_integrations.components.generators.together_ai.chat.chat_generator
+  - haystack_integrations.components.generators.togetherai.generator
+  - haystack_integrations.components.generators.togetherai.chat.chat_generator
   search_path:
   - ../src
   type: haystack_pydoc_tools.loaders.CustomPythonLoader
@@ -17,13 +17,13 @@ processors:
 - type: crossref
 renderer:
   description: Together AI integration for Haystack
-  id: integrations-together-ai
+  id: integrations-togetherai
   markdown:
     add_member_class_prefix: false
     add_method_class_prefix: true
     classdef_code_block: false
     descriptive_class_title: false
     descriptive_module_title: true
-    filename: together_ai.md
+    filename: togetherai.md
   title: Together AI
   type: haystack_pydoc_tools.renderers.DocusaurusRenderer
diff --git a/integrations/togetherai/pyproject.toml b/integrations/togetherai/pyproject.toml
@@ -27,20 +27,20 @@ classifiers = [
 dependencies = ["haystack-ai>=2.19.0"]
 
 [project.urls]
-Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/together_ai#readme"
+Documentation = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/togetherai#readme"
 Issues = "https://github.com/deepset-ai/haystack-core-integrations/issues"
-Source = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/together_ai"
+Source = "https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/togetherai"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/haystack_integrations"]
 
 [tool.hatch.version]
 source = "vcs"
-tag-pattern = 'integrations\/together_ai-v(?P<version>.*)'
+tag-pattern = 'integrations\/togetherai-v(?P<version>.*)'
 
 [tool.hatch.version.raw-options]
 root = "../.."
-git_describe_command = 'git describe --tags --match="integrations/together_ai-v[0-9]*"'
+git_describe_command = 'git describe --tags --match="integrations/togetherai-v[0-9]*"'
 
 [tool.hatch.envs.default]
 installer = "uv"
@@ -68,7 +68,7 @@ integration = 'pytest -m "integration" {args:tests}'
 all = 'pytest {args:tests}'
 cov-retry = 'all --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x'
 
-types = """mypy -p haystack_integrations.components.generators.together_ai {args}"""
+types = """mypy -p haystack_integrations.components.generators.togetherai {args}"""
 
 [tool.mypy]
 install_types = true
diff --git a/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/__init__.py b/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/__init__.py
diff --git a/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/__init__.py b/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/__init__.py
diff --git a/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/chat_generator.py b/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/chat_generator.py
@@ -39,7 +39,7 @@ class TogetherAIChatGenerator(OpenAIChatGenerator):
 
     Usage example:
     ```python
-    from haystack_integrations.components.generators.together_ai import TogetherAIChatGenerator
+    from haystack_integrations.components.generators.togetherai import TogetherAIChatGenerator
     from haystack.dataclasses import ChatMessage
 
     messages = [ChatMessage.from_user("What's Natural Language Processing?")]
diff --git a/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/generator.py b/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/generator.py
@@ -20,7 +20,7 @@ class TogetherAIGenerator(TogetherAIChatGenerator):
 
     Usage example:
     ```python
-    from haystack_integrations.components.generators.together_ai import TogetherAIGenerator
+    from haystack_integrations.components.generators.togetherai import TogetherAIGenerator
 
     generator = TogetherAIGenerator(model="deepseek-ai/DeepSeek-R1",
                                 generation_kwargs={
diff --git a/integrations/togetherai/src/haystack_integrations/components/py.typed b/integrations/togetherai/src/haystack_integrations/components/py.typed
diff --git a/integrations/togetherai/tests/__init__.py b/integrations/togetherai/tests/__init__.py
diff --git a/integrations/togetherai/tests/test_togetherai_chat_generator.py b/integrations/togetherai/tests/test_togetherai_chat_generator.py
@@ -17,7 +17,7 @@
 from openai.types.chat.chat_completion_chunk import ChoiceDelta, ChoiceDeltaToolCall, ChoiceDeltaToolCallFunction
 from openai.types.completion_usage import CompletionTokensDetails, CompletionUsage, PromptTokensDetails
 
-from haystack_integrations.components.generators.together_ai.chat.chat_generator import TogetherAIChatGenerator
+from haystack_integrations.components.generators.togetherai.chat.chat_generator import TogetherAIChatGenerator
 
 
 class CollectorCallback:
@@ -143,7 +143,7 @@ def test_to_dict_default(self, monkeypatch):
 
         assert (
             data["type"]
-            == "haystack_integrations.components.generators.together_ai.chat.chat_generator.TogetherAIChatGenerator"
+            == "haystack_integrations.components.generators.togetherai.chat.chat_generator.TogetherAIChatGenerator"
         )
 
         expected_params = {
@@ -178,7 +178,7 @@ def test_to_dict_with_parameters(self, monkeypatch):
 
         assert (
             data["type"]
-            == "haystack_integrations.components.generators.together_ai.chat.chat_generator.TogetherAIChatGenerator"
+            == "haystack_integrations.components.generators.togetherai.chat.chat_generator.TogetherAIChatGenerator"
         )
 
         expected_params = {
@@ -200,7 +200,7 @@ def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("TOGETHER_API_KEY", "fake-api-key")
         data = {
             "type": (
-                "haystack_integrations.components.generators.together_ai.chat.chat_generator.TogetherAIChatGenerator"
+                "haystack_integrations.components.generators.togetherai.chat.chat_generator.TogetherAIChatGenerator"
             ),
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
@@ -229,7 +229,7 @@ def test_from_dict_fail_wo_env_var(self, monkeypatch):
         monkeypatch.delenv("TOGETHER_API_KEY", raising=False)
         data = {
             "type": (
-                "haystack_integrations.components.generators.together_ai.chat.chat_generator.TogetherAIChatGenerator"
+                "haystack_integrations.components.generators.togetherai.chat.chat_generator.TogetherAIChatGenerator"
             ),
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
@@ -431,7 +431,7 @@ def test_live_run_with_tools_streaming(self, tools):
         reason="Export an env var called TOGETHER_API_KEY containing the Together AI API key to run this test.",
     )
     @pytest.mark.integration
-    def test_pipeline_with_together_ai_chat_generator(self, tools):
+    def test_pipeline_with_togetherai_chat_generator(self, tools):
         """
         Test that the TogetherAIChatGenerator component can be used in a pipeline
         """
@@ -491,7 +491,7 @@ def test_serde_in_pipeline(self, monkeypatch):
             "connection_type_validation": True,
             "components": {
                 "generator": {
-                    "type": "haystack_integrations.components.generators.together_ai.chat.chat_generator.TogetherAIChatGenerator",  # noqa: E501
+                    "type": "haystack_integrations.components.generators.togetherai.chat.chat_generator.TogetherAIChatGenerator",  # noqa: E501
                     "init_parameters": {
                         "api_key": {"type": "env_var", "env_vars": ["ENV_VAR"], "strict": True},
                         "model": "meta-llama/Llama-3.3-70B-Instruct-Turbo",
@@ -505,7 +505,7 @@ def test_serde_in_pipeline(self, monkeypatch):
                                     "name": "weather",
                                     "description": "useful to determine the weather in a given location",
                                     "parameters": {"city": {"type": "string"}},
-                                    "function": "tests.test_together_ai_chat_generator.weather",
+                                    "function": "tests.test_togetherai_chat_generator.weather",
                                 },
                             }
                         ],
@@ -648,7 +648,7 @@ def test_live_run_with_mixed_tools(self, mixed_tools):
 
 class TestChatCompletionChunkConversion:
     def test_handle_stream_response(self):
-        together_ai_chunks = [
+        togetherai_chunks = [
             ChatCompletionChunk(
                 id="gen-1750162525-tc7ParBHvsqd6rYhCDtK",
                 choices=[
@@ -946,7 +946,7 @@ def test_handle_stream_response(self):
 
         collector_callback = CollectorCallback()
         llm = TogetherAIChatGenerator(api_key=Secret.from_token("test-api-key"))
-        result = llm._handle_stream_response(together_ai_chunks, callback=collector_callback)[0]  # type: ignore
+        result = llm._handle_stream_response(togetherai_chunks, callback=collector_callback)[0]  # type: ignore
 
         # Assert text is empty
         assert result.text is None
diff --git a/integrations/togetherai/tests/test_togetherai_chat_generator_async.py b/integrations/togetherai/tests/test_togetherai_chat_generator_async.py
@@ -14,7 +14,7 @@
 from openai.types.chat import ChatCompletion, ChatCompletionMessage
 from openai.types.chat.chat_completion import Choice
 
-from haystack_integrations.components.generators.together_ai.chat.chat_generator import (
+from haystack_integrations.components.generators.togetherai.chat.chat_generator import (
     TogetherAIChatGenerator,
 )
 
diff --git a/integrations/togetherai/tests/test_togetherai_generator.py b/integrations/togetherai/tests/test_togetherai_generator.py
@@ -16,7 +16,7 @@
 from openai.types.chat.chat_completion import Choice
 from openai.types.completion_usage import CompletionUsage
 
-from haystack_integrations.components.generators.together_ai.generator import TogetherAIGenerator
+from haystack_integrations.components.generators.togetherai.generator import TogetherAIGenerator
 
 
 @pytest.fixture
@@ -92,7 +92,7 @@ def test_to_dict_default(self, monkeypatch):
         )
         data = component.to_dict()
         assert data == {
-            "type": "haystack_integrations.components.generators.together_ai.generator.TogetherAIGenerator",
+            "type": "haystack_integrations.components.generators.togetherai.generator.TogetherAIGenerator",
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
                 "model": "meta-llama/Llama-3.3-70B-Instruct-Turbo",
@@ -119,7 +119,7 @@ def test_to_dict_with_parameters(self, monkeypatch):
         )
         data = component.to_dict()
         assert data == {
-            "type": "haystack_integrations.components.generators.together_ai.generator.TogetherAIGenerator",
+            "type": "haystack_integrations.components.generators.togetherai.generator.TogetherAIGenerator",
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
                 "model": "gpt-4o-mini",
@@ -135,7 +135,7 @@ def test_to_dict_with_parameters(self, monkeypatch):
     def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("TOGETHER_API_KEY", "fake-api-key")
         data = {
-            "type": "haystack_integrations.components.generators.together_ai.generator.TogetherAIGenerator",
+            "type": "haystack_integrations.components.generators.togetherai.generator.TogetherAIGenerator",
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
                 "model": "gpt-4o-mini",
@@ -160,7 +160,7 @@ def test_from_dict(self, monkeypatch):
     def test_from_dict_fail_wo_env_var(self, monkeypatch):
         monkeypatch.delenv("TOGETHER_API_KEY", raising=False)
         data = {
-            "type": "haystack_integrations.components.generators.together_ai.generator.TogetherAIGenerator",
+            "type": "haystack_integrations.components.generators.togetherai.generator.TogetherAIGenerator",
             "init_parameters": {
                 "api_key": {"env_vars": ["TOGETHER_API_KEY"], "strict": True, "type": "env_var"},
                 "model": "gpt-4o-mini",
