weaviate-haystack 7.8.0__tar.gz → 7.9.0__tar.gz

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [integrations/weaviate-v7.8.0] - 2026-09-01
+
+### 🐛 Bug Fixes
+
+- `Weaviate` match `search_term` against metadata field value, not content + default size value set to 10 (#3643)
+- Fix new issues raised by ruff 0.16.0 (#3670)
+- `WeaviateDocumentStore` get_metadata_field_unique_values setting list of values to return to `Any` (#3708)
+- Weaviate adding optional parameter `filters` to `get_metadata_field_unique_values()` (#3741)
+- Standardize license files (#3771)
+
+### 🧪 Testing
+
+- `WeaviateDocumentStore` removing duplicated tests already covered by haystack Mixin tests (#3787)
+
+
 ## [integrations/weaviate-v7.7.0] - 2026-07-22
 
 ### 🚜 Refactor
@@ -207,21 +222,20 @@
 
 ### 🧹 Chores
 
-- Weaviate - remove legacy filter support (#1070)
 - Update changelog after removing legacy filters (#1083)
 - Update ruff linting scripts and settings (#1105)
 
+## [integrations/weaviate-v3.0.0] - 2024-09-12
 
-## [integrations/weaviate-v2.2.1] - 2024-09-07
+### 🧹 Chores
 
-### 🚀 Features
+- Weaviate - remove legacy filter support (#1070)
 
-- Add filter_policy to weaviate integration (#824)
+
+## [integrations/weaviate-v2.2.1] - 2024-09-07
 
 ### 🐛 Bug Fixes
 
-- Weaviate filter error (#811)
-- Fix connection to Weaviate Cloud Service (#624)
 - Pin weaviate-client (#1046)
 - Weaviate - fix connection issues with some WCS URLs (#1058)
 
@@ -229,9 +243,27 @@
 
 - Do not retry tests in `hatch run test` command (#954)
 
-### ⚙️ CI
+### 🌀 Miscellaneous
 
-- Retry tests to reduce flakyness (#836)
+- Chore: weaviate - ruff update, don't ruff tests (#986)
+
+## [integrations/weaviate-v2.2.0] - 2024-08-02
+
+### 🌀 Miscellaneous
+
+- Fix: Weaviate: Use collections.list_all instead of collections._get_all (#921)
+
+## [integrations/weaviate-v2.1.3] - 2024-07-17
+
+### 🌀 Miscellaneous
+
+- Fix: `weaviate` - Fallback to default filter policy when deserializing retrievers without the init parameter  (#903)
+
+## [integrations/weaviate-v2.1.2] - 2024-07-15
+
+### 🚀 Features
+
+- Add filter_policy to weaviate integration (#824)
 
 ### 🧹 Chores
 
@@ -239,15 +271,24 @@
 
 ### 🌀 Miscellaneous
 
+- Chore: Minor retriever pydoc fix (#884)
+
+## [integrations/weaviate-v2.1.1] - 2024-06-25
+
+### 🐛 Bug Fixes
+
+- Weaviate filter error (#811)
+- Fix connection to Weaviate Cloud Service (#624)
+
+### ⚙️ CI
+
+- Retry tests to reduce flakyness (#836)
+
+### 🌀 Miscellaneous
+
 - Handle connection to WCS and add tests
 - Revert "Handle connection to WCS and add tests"
-
-This reverts commit f48802b2ce612896fd06a13cf33dffd9f77a8859.
 - Ci: install `pytest-rerunfailures` where needed; add retry config to `test-cov` script (#845)
-- Chore: Minor retriever pydoc fix (#884)
-- Fix: `weaviate` - Fallback to default filter policy when deserializing retrievers without the init parameter  (#903)
-- Fix: Weaviate: Use collections.list_all instead of collections._get_all (#921)
-- Chore: weaviate - ruff update, don't ruff tests (#986)
 
 ## [integrations/weaviate-v2.1.0] - 2024-06-10
 

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: weaviate-haystack
-Version: 7.8.0
+Version: 7.9.0
 Summary: An integration of Weaviate vector database with Haystack
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/weaviate/README.md
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.10
 Requires-Dist: haystack-ai>=2.28.0
 Requires-Dist: python-dateutil>=2.7.0
-Requires-Dist: weaviate-client>=4.20
+Requires-Dist: weaviate-client>=4.23.0
 Description-Content-Type: text/markdown
 
 # weaviate-haystack

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/docker-compose.yml

@@ -7,7 +7,7 @@ services:
     - '8080'
     - --scheme
     - http
-    image: semitechnologies/weaviate:1.36.2
+    image: cr.weaviate.io/semitechnologies/weaviate:1.39.4
     ports:
     - 8080:8080
     - 50051:50051
@@ -18,4 +18,16 @@ services:
       PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
       DEFAULT_VECTORIZER_MODULE: 'none'
       ENABLE_MODULES: ''
-      CLUSTER_HOSTNAME: 'node1'
+      CLUSTER_HOSTNAME: 'node1'
+    healthcheck:
+      test:
+      - CMD
+      - busybox
+      - wget
+      - -q
+      - -O
+      - '-'
+      - http://127.0.0.1:8080/v1/.well-known/ready
+      interval: 5s
+      timeout: 3s
+      retries: 20

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/pyproject.toml

@@ -25,7 +25,7 @@ classifiers = [
 ]
 dependencies = [
   "haystack-ai>=2.28.0",
-  "weaviate-client>=4.20",
+  "weaviate-client>=4.23.0",
   "python-dateutil>=2.7.0",
 ]
 

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/src/haystack_integrations/document_stores/weaviate/document_store.py

@@ -4,6 +4,7 @@
 
 import base64
 import datetime
+import importlib.metadata
 import json
 from contextlib import suppress
 from dataclasses import asdict
@@ -38,6 +39,27 @@ from .auth import AuthCredentials
 
 logger = logging.getLogger(__name__)
 
+# Weaviate tracks which framework integrations talk to it through this header, so that adoption of
+# weaviate-haystack shows up in Weaviate's own telemetry. See https://github.com/weaviate/weaviate/pull/10535.
+_INTEGRATION_HEADER = "X-Weaviate-Client-Integration"
+_INTEGRATION_NAME = "haystack-python"
+_PACKAGE_NAME = "weaviate-haystack"
+
+
+def _integration_header_value() -> str:
+    """
+    Builds the value of the Weaviate client integration header.
+
+    :returns:
+        A `<name>/<version>` string. The version falls back to `unknown` when the package metadata is
+        unavailable, for example when running from a source checkout that was never installed.
+    """
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_NAME}/{version}"
+
 
 # This is the default collection properties for Weaviate.
 # It's a list of properties that will be created on the collection.
@@ -144,6 +166,9 @@ class WeaviateDocumentStore:
             ```
             {"X-OpenAI-Api-Key": "<THE-KEY>"}, {"X-HuggingFace-Api-Key": "<THE-KEY>"}
             ```
+            Every connection also carries `X-Weaviate-Client-Integration: haystack-python/<version>`, which
+            identifies this integration in Weaviate's telemetry. Supplying that header here, in any casing,
+            overrides it.
         :param embedded_options:
             If set, create an embedded Weaviate cluster inside the client. For a full list of options see
             `weaviate.embedded.EmbeddedOptions`.
@@ -183,6 +208,26 @@ class WeaviateDocumentStore:
             "properties", DOCUMENT_COLLECTION_PROPERTIES
         )
 
+    def _connection_headers(self) -> dict[str, Any]:
+        """
+        Builds the headers passed to the Weaviate client.
+
+        Merges the integration identification header into the user supplied `additional_headers`. A user
+        supplied value for the same header wins, so the header can be overridden or suppressed. The merged
+        headers are deliberately not stored on the instance: `to_dict()` must keep serializing only the
+        headers the user actually passed, so that a serialized pipeline does not bake in the version of
+        `weaviate-haystack` that happened to write it.
+
+        :returns:
+            The headers to pass to the Weaviate client.
+        """
+        headers: dict[str, Any] = dict(self._additional_headers) if self._additional_headers else {}
+        # The comparison is case insensitive because gRPC metadata keys are case sensitive: a user supplied
+        # "x-weaviate-client-integration" would otherwise end up alongside our own spelling of the header.
+        if not any(key.lower() == _INTEGRATION_HEADER.lower() for key in headers):
+            headers[_INTEGRATION_HEADER] = _integration_header_value()
+        return headers
+
     @property
     def client(self) -> weaviate.WeaviateClient:
         """Return the synchronous Weaviate client, creating and connecting it if necessary."""
@@ -199,7 +244,7 @@ class WeaviateDocumentStore:
             self._client = weaviate.connect_to_weaviate_cloud(
                 self._url,
                 auth_credentials=self._auth_client_secret.resolve_value(),
-                headers=self._additional_headers,
+                headers=self._connection_headers(),
                 additional_config=self._additional_config,
             )
         else:
@@ -216,7 +261,7 @@ class WeaviateDocumentStore:
                 ),
                 auth_client_secret=self._auth_client_secret.resolve_value() if self._auth_client_secret else None,
                 additional_config=self._additional_config,
-                additional_headers=self._additional_headers,
+                additional_headers=self._connection_headers(),
                 embedded_options=self._embedded_options,
                 skip_init_checks=False,
             )
@@ -244,7 +289,7 @@ class WeaviateDocumentStore:
             self._async_client = weaviate.use_async_with_weaviate_cloud(
                 self._url,
                 auth_credentials=self._auth_client_secret.resolve_value(),
-                headers=self._additional_headers,
+                headers=self._connection_headers(),
                 additional_config=self._additional_config,
             )
         else:
@@ -261,7 +306,7 @@ class WeaviateDocumentStore:
                 ),
                 auth_client_secret=self._auth_client_secret.resolve_value() if self._auth_client_secret else None,
                 additional_config=self._additional_config,
-                additional_headers=self._additional_headers,
+                additional_headers=self._connection_headers(),
                 embedded_options=self._embedded_options,
                 skip_init_checks=False,
             )

{weaviate_haystack-7.8.0 → weaviate_haystack-7.9.0}/tests/test_document_store.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import base64
+import importlib.metadata
 import logging
 import os
 from collections.abc import Generator
@@ -43,6 +44,7 @@ from haystack_integrations.document_stores.weaviate.auth import AuthApiKey
 from haystack_integrations.document_stores.weaviate.document_store import (
     DOCUMENT_COLLECTION_PROPERTIES,
     WeaviateDocumentStore,
+    _integration_header_value,
 )
 
 
@@ -81,7 +83,10 @@ def test_client_connects_to_weaviate_cloud(mock_connect, monkeypatch):
 
     mock_connect.assert_called_once()
     _args, kwargs = mock_connect.call_args
-    assert kwargs["headers"] == {"X-HuggingFace-Api-Key": "k"}
+    assert kwargs["headers"] == {
+        "X-HuggingFace-Api-Key": "k",
+        "X-Weaviate-Client-Integration": _integration_header_value(),
+    }
 
 
 @pytest.mark.asyncio
@@ -100,9 +105,84 @@ async def test_async_client_connects_to_weaviate_cloud(mock_connect, monkeypatch
     mock_client.collections.exists = exists
     mock_connect.return_value = mock_client
 
-    ds = WeaviateDocumentStore(url="rAnD0m.something.weaviate.cloud", auth_client_secret=AuthApiKey())
+    ds = WeaviateDocumentStore(
+        url="rAnD0m.something.weaviate.cloud",
+        auth_client_secret=AuthApiKey(),
+        additional_headers={"X-HuggingFace-Api-Key": "k"},
+    )
     assert await ds.async_client is mock_client
+
     mock_connect.assert_called_once()
+    _args, kwargs = mock_connect.call_args
+    assert kwargs["headers"] == {
+        "X-HuggingFace-Api-Key": "k",
+        "X-Weaviate-Client-Integration": _integration_header_value(),
+    }
+
+
+@patch("haystack_integrations.document_stores.weaviate.document_store.weaviate.WeaviateClient")
+def test_client_sends_integration_header(mock_weaviate_client_class):
+    mock_client = MagicMock()
+    mock_client.collections.exists.return_value = True
+    mock_weaviate_client_class.return_value = mock_client
+
+    ds = WeaviateDocumentStore(url="http://localhost:8080")
+    ds.client  # noqa: B018
+
+    headers = mock_weaviate_client_class.call_args.kwargs["additional_headers"]
+    assert headers["X-Weaviate-Client-Integration"].startswith("haystack-python/")
+
+
+@pytest.mark.asyncio
+@patch("haystack_integrations.document_stores.weaviate.document_store.weaviate.WeaviateAsyncClient")
+async def test_async_client_sends_integration_header(mock_weaviate_async_client_class):
+    mock_client = MagicMock()
+
+    async def connect() -> None:
+        return None
+
+    async def exists(_name: str) -> bool:
+        return True
+
+    mock_client.connect = connect
+    mock_client.collections.exists = exists
+    mock_weaviate_async_client_class.return_value = mock_client
+
+    ds = WeaviateDocumentStore(url="http://localhost:8080")
+    await ds.async_client
+
+    headers = mock_weaviate_async_client_class.call_args.kwargs["additional_headers"]
+    assert headers["X-Weaviate-Client-Integration"].startswith("haystack-python/")
+
+
+@pytest.mark.parametrize("header_name", ["X-Weaviate-Client-Integration", "x-weaviate-client-integration"])
+@patch("haystack_integrations.document_stores.weaviate.document_store.weaviate.WeaviateClient")
+def test_user_supplied_integration_header_wins(mock_weaviate_client_class, header_name):
+    mock_client = MagicMock()
+    mock_client.collections.exists.return_value = True
+    mock_weaviate_client_class.return_value = mock_client
+
+    ds = WeaviateDocumentStore(url="http://localhost:8080", additional_headers={header_name: "custom/1.0"})
+    ds.client  # noqa: B018
+
+    headers = mock_weaviate_client_class.call_args.kwargs["additional_headers"]
+    assert headers == {header_name: "custom/1.0"}
+
+
+def test_integration_header_value_falls_back_to_unknown_version(monkeypatch):
+    def raise_package_not_found(_package_name: str) -> str:
+        raise importlib.metadata.PackageNotFoundError
+
+    monkeypatch.setattr(importlib.metadata, "version", raise_package_not_found)
+
+    assert _integration_header_value() == "haystack-python/unknown"
+
+
+def test_integration_header_is_not_serialized():
+    assert WeaviateDocumentStore().to_dict()["init_parameters"]["additional_headers"] is None
+
+    ds = WeaviateDocumentStore(additional_headers={"X-HuggingFace-Api-Key": "k"})
+    assert ds.to_dict()["init_parameters"]["additional_headers"] == {"X-HuggingFace-Api-Key": "k"}
 
 
 def test_to_data_object_with_sparse_embedding_logs_warning(caplog):
@@ -325,7 +405,10 @@ class TestWeaviateDocumentStore(
         mock_weaviate_client_class.assert_called_once_with(
             auth_client_secret=AuthApiKey().resolve_value(),
             connection_params=None,
-            additional_headers={"X-HuggingFace-Api-Key": "MY_HUGGINGFACE_KEY"},
+            additional_headers={
+                "X-HuggingFace-Api-Key": "MY_HUGGINGFACE_KEY",
+                "X-Weaviate-Client-Integration": _integration_header_value(),
+            },
             embedded_options=EmbeddedOptions(
                 persistence_data_path=DEFAULT_PERSISTENCE_DATA_PATH,
                 binary_path=DEFAULT_BINARY_PATH,