parallel-haystack 1.0.0__py3-none-any.whl

haystack_integrations/components/generators/parallel/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.generators.parallel.chat.chat_generator import (
+    ParallelChatGenerator,
+)
+
+__all__ = ["ParallelChatGenerator"]

haystack_integrations/components/generators/parallel/chat/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.generators.parallel.chat.chat_generator import (
+    ParallelChatGenerator,
+)
+
+__all__ = ["ParallelChatGenerator"]

haystack_integrations/components/generators/parallel/chat/chat_generator.py

@@ -0,0 +1,195 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any, ClassVar
+
+from haystack import component, logging
+from haystack.components.generators.chat import OpenAIResponsesChatGenerator
+from haystack.core.serialization import generate_qualified_class_name
+from haystack.dataclasses import StreamingCallbackT
+from haystack.utils.auth import Secret
+
+logger = logging.getLogger(__name__)
+
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "parallel-haystack"
+
+_INIT_PARAMETERS: tuple[str, ...] = (
+    "api_key",
+    "model",
+    "api_base_url",
+    "streaming_callback",
+    "generation_kwargs",
+    "timeout",
+    "extra_headers",
+    "max_retries",
+    "http_client_kwargs",
+)
+
+# Accepted by the API for SDK compatibility but silently ignored, so a request that sets them
+# succeeds while behaving as if they were never passed.
+# See https://docs.parallel.ai/responses-api/openai-compatibility
+_IGNORED_GENERATION_KWARGS: tuple[str, ...] = (
+    "include",
+    "max_output_tokens",
+    "parallel_tool_calls",
+    "store",
+    "temperature",
+    "tool_choice",
+    "tools",
+    "top_p",
+    "truncation",
+    "user",
+)
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+def _http_client_kwargs_with_headers(
+    http_client_kwargs: dict[str, Any] | None,
+    extra_headers: dict[str, Any] | None,
+) -> dict[str, Any]:
+    kwargs = dict(http_client_kwargs or {})
+    headers = {**kwargs.get("headers", {}), **(extra_headers or {})}
+    headers["x-parallel-integration"] = _attribution_header()
+    kwargs["headers"] = headers
+    return kwargs
+
+
+@component
+class ParallelChatGenerator(OpenAIResponsesChatGenerator):
+    """
+    Completes chats using Parallel's web-research model.
+
+    Powered by the Parallel Responses API (`POST /v1/responses`, OpenAI Responses-compatible).
+    Every answer is grounded in live web research with citations; the `reasoning.effort`
+    parameter selects the research tier: `low` (~5-10s), `medium` (~15-20s, default), or
+    `high` (~30-60s).
+    See the [Parallel Responses API quickstart](https://docs.parallel.ai/responses-api/responses-quickstart)
+    for details.
+
+    It uses the [ChatMessage](https://docs.haystack.deepset.ai/docs/chatmessage) format in input and output.
+    Web grounding is built in, so tool calling and sampling parameters (`tools`, `temperature`,
+    `top_p`, ...) are accepted for SDK compatibility but silently ignored by the API; this component
+    warns when it sees them.
+
+    Because a single call runs live research, `timeout` defaults to 120 seconds rather than the
+    30 seconds inherited from the OpenAI client, so that the `high` tier fits comfortably.
+
+    ### Usage example
+    ```python
+    from haystack.dataclasses import ChatMessage
+    from haystack_integrations.components.generators.parallel import ParallelChatGenerator
+
+    messages = [ChatMessage.from_user("What did Parallel Web Systems announce this year?")]
+
+    client = ParallelChatGenerator(generation_kwargs={"reasoning": {"effort": "low"}})
+    response = client.run(messages)
+    print(response)
+    ```
+    """
+
+    SUPPORTED_MODELS: ClassVar[list[str]] = ["parallel"]
+    """The Parallel Responses API models supported by this component.
+    See https://docs.parallel.ai/responses-api/responses-quickstart for details."""
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PARALLEL_API_KEY"),
+        model: str = "parallel",
+        api_base_url: str | None = "https://api.parallel.ai/v1",
+        streaming_callback: StreamingCallbackT | None = None,
+        generation_kwargs: dict[str, Any] | None = None,
+        timeout: float | None = 120.0,
+        extra_headers: dict[str, Any] | None = None,
+        max_retries: int | None = 3,
+        http_client_kwargs: dict[str, Any] | None = None,
+    ) -> None:
+        """
+        Initialize the ParallelChatGenerator component.
+
+        :param api_key:
+            The Parallel API key.
+        :param model:
+            The Parallel Responses API model to use.
+        :param api_base_url:
+            The Parallel API base URL.
+        :param streaming_callback:
+            A callback function called when a new token is received from the stream.
+        :param generation_kwargs:
+            Additional parameters sent directly to the Parallel Responses API, such as
+            `reasoning` (e.g. `{"effort": "low"}`) to select the research tier or
+            `text` for structured output.
+        :param timeout:
+            Timeout in seconds for Parallel API calls. Defaults to 120 seconds, which leaves room for
+            the `high` research tier (~30-60s). Pass `None` to fall back to the OpenAI client default
+            (the `OPENAI_TIMEOUT` environment variable, or 30 seconds), which is too short for most
+            research calls.
+        :param extra_headers:
+            Additional HTTP headers to include in requests to the Parallel API.
+        :param max_retries:
+            Maximum number of retries to contact Parallel after an internal error. Kept low because
+            every retry runs a full research call. Pass `None` to fall back to the OpenAI client
+            default (the `OPENAI_MAX_RETRIES` environment variable, or 5).
+        :param http_client_kwargs:
+            A dictionary of keyword arguments to configure a custom `httpx.Client` or `httpx.AsyncClient`.
+        """
+        if model not in self.SUPPORTED_MODELS:
+            logger.warning(
+                "Model {model} is not supported by the Parallel Responses API, which only serves "
+                "{supported_models}. The request is sent anyway and the API is expected to reject it.",
+                model=model,
+                supported_models=", ".join(self.SUPPORTED_MODELS),
+            )
+
+        ignored = sorted(set(generation_kwargs or {}) & set(_IGNORED_GENERATION_KWARGS))
+        if ignored:
+            logger.warning(
+                "The generation_kwargs {ignored} are accepted by the Parallel Responses API for SDK "
+                "compatibility but have no effect on the response. Use `reasoning` to select the research "
+                "tier and `text` for structured output instead.",
+                ignored=", ".join(ignored),
+            )
+
+        self.extra_headers = extra_headers
+        super(ParallelChatGenerator, self).__init__(  # noqa: UP008
+            api_key=api_key,
+            model=model,
+            streaming_callback=streaming_callback,
+            api_base_url=api_base_url,
+            generation_kwargs=generation_kwargs,
+            timeout=timeout,
+            max_retries=max_retries,
+            http_client_kwargs=_http_client_kwargs_with_headers(http_client_kwargs, extra_headers),
+        )
+        # self.http_client_kwargs carries the attribution (and extra) headers so that the parent bakes them into
+        # the httpx client whether it is built eagerly (haystack-ai 2.x) or at warm-up (haystack-ai >= 3.0);
+        # the user-provided value is preserved for serialization
+        self._http_client_kwargs = http_client_kwargs
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+
+        :returns:
+            The serialized component as a dictionary.
+        """
+        data = super(ParallelChatGenerator, self).to_dict()  # noqa: UP008
+        data["type"] = generate_qualified_class_name(type(self))
+        data["init_parameters"]["extra_headers"] = self.extra_headers
+        # serialize the user-provided value, not the internal one enriched with attribution headers
+        data["init_parameters"]["http_client_kwargs"] = self._http_client_kwargs
+        # the parent serializes params this component does not expose (organization, tools, ...)
+        data["init_parameters"] = {
+            key: value for key, value in data["init_parameters"].items() if key in _INIT_PARAMETERS
+        }
+        return data

haystack_integrations/components/websearch/parallel/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from haystack_integrations.components.websearch.parallel.parallel_websearch import (
+    ParallelWebSearch,
+)
+
+__all__ = ["ParallelWebSearch"]

haystack_integrations/components/websearch/parallel/parallel_websearch.py

@@ -0,0 +1,250 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib.metadata
+from typing import Any
+
+import httpx
+from haystack import Document, component, logging
+from haystack.utils import Secret
+
+logger = logging.getLogger(__name__)
+
+PARALLEL_SEARCH_URL = "https://api.parallel.ai/v1/search"
+_INTEGRATION_SLUG = "haystack"
+_PACKAGE_NAME = "parallel-haystack"
+
+
+def _attribution_header() -> str:
+    try:
+        version = importlib.metadata.version(_PACKAGE_NAME)
+    except importlib.metadata.PackageNotFoundError:
+        version = "unknown"
+    return f"{_INTEGRATION_SLUG}/{version}"
+
+
+@component
+class ParallelWebSearch:
+    """
+    A component that uses Parallel to search the web and return results as Haystack Documents.
+
+    This component wraps the Parallel Search API, enabling web search queries that return
+    LLM-optimized excerpts as structured documents with content and links, plus the
+    session identifier that ties related searches together.
+
+    You need a Parallel API key from [parallel.ai](https://parallel.ai).
+
+    ### Usage example
+
+    ```python
+    from haystack_integrations.components.websearch.parallel import ParallelWebSearch
+    from haystack.utils import Secret
+
+    websearch = ParallelWebSearch(
+        api_key=Secret.from_env_var("PARALLEL_API_KEY"),
+        top_k=5,
+    )
+    result = websearch.run(query="What is Haystack by deepset?")
+    documents = result["documents"]
+    links = result["links"]
+
+    # Pass the session back on follow-up searches that are part of the same task
+    # to get better contextual results.
+    follow_up = websearch.run(
+        query="Who maintains Haystack?",
+        search_params={"session_id": result["session_id"]},
+    )
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        api_key: Secret = Secret.from_env_var("PARALLEL_API_KEY"),
+        top_k: int | None = 10,
+        search_params: dict[str, Any] | None = None,
+        timeout: float = 30.0,
+    ) -> None:
+        """
+        Initialize the ParallelWebSearch component.
+
+        :param api_key:
+            API key for Parallel. Defaults to the `PARALLEL_API_KEY` environment variable.
+        :param top_k:
+            Maximum number of results to return. Maps to the `advanced_settings.max_results` API parameter.
+        :param search_params:
+            Additional parameters passed to the Parallel Search API.
+            See the [Parallel Search API reference](https://docs.parallel.ai/api-reference/search/search)
+            for available options. Supported keys include: `objective` (natural-language search goal,
+            defaults to the query), `mode` (`turbo`, `fast`, `basic`, or `advanced`, in increasing
+            order of latency and quality; the API defaults to `advanced`), `max_chars_total`,
+            `session_id`, `client_model`, and `advanced_settings` (nested `source_policy` domain and
+            date filters, `fetch_policy`, `excerpt_settings`, `location`, `max_results`).
+            Pass `session_id` to link several searches into one task; the identifier the API used
+            is always returned in the `session_id` output, whether it was sent or server-generated.
+        :param timeout:
+            Request timeout in seconds.
+        """
+        self.api_key = api_key
+        self.top_k = top_k
+        self.search_params = search_params
+        self.timeout = timeout
+        self._client: httpx.Client | None = None
+        self._async_client: httpx.AsyncClient | None = None
+
+    def _build_headers(self) -> dict[str, str]:
+        return {
+            "x-api-key": self.api_key.resolve_value() or "",
+            "Content-Type": "application/json",
+            "x-parallel-integration": _attribution_header(),
+        }
+
+    def _build_body(self, query: str, search_params: dict[str, Any] | None) -> dict[str, Any]:
+        params = (search_params if search_params is not None else self.search_params or {}).copy()
+        advanced_settings = dict(params.pop("advanced_settings", None) or {})
+        if "max_results" not in advanced_settings and self.top_k is not None:
+            advanced_settings["max_results"] = self.top_k
+        body: dict[str, Any] = {"search_queries": [query], "objective": query}
+        body.update({k: v for k, v in params.items() if v is not None})
+        if advanced_settings:
+            body["advanced_settings"] = advanced_settings
+        return body
+
+    def warm_up(self) -> None:
+        """
+        Initialize the sync HTTP client.
+
+        Called automatically on first use. Can be called explicitly to avoid cold-start latency.
+        """
+        if self._client is None:
+            self._client = httpx.Client(timeout=self.timeout)
+
+    async def warm_up_async(self) -> None:
+        """
+        Initialize the async HTTP client on the serving event loop.
+
+        Called automatically on first use. Can be called explicitly to avoid cold-start latency.
+        """
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(timeout=self.timeout)
+
+    def close(self) -> None:
+        """
+        Release the sync HTTP client.
+        """
+        if self._client is not None:
+            self._client.close()
+            self._client = None
+
+    async def close_async(self) -> None:
+        """
+        Release the async HTTP client.
+        """
+        if self._async_client is not None:
+            await self._async_client.aclose()
+            self._async_client = None
+
+    @component.output_types(documents=list[Document], links=list[str], session_id=str)
+    def run(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Search the web using Parallel and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result excerpts.
+            - `links`: List of URLs from the search results.
+            - `session_id`: Session identifier for this search, echoed back from
+              `search_params["session_id"]` if it was provided and generated by the API otherwise.
+              Pass it to subsequent searches that belong to the same task.
+        """
+        if self._client is None:
+            self.warm_up()
+
+        response = self._client.post(  # type: ignore[union-attr]
+            PARALLEL_SEARCH_URL,
+            headers=self._build_headers(),
+            json=self._build_body(query, search_params),
+        )
+        response.raise_for_status()
+        parsed = self._parse_response(response.json())
+
+        logger.debug(
+            "Parallel returned {number_documents} documents for the query '{query}'",
+            number_documents=len(parsed["documents"]),
+            query=query,
+        )
+        return parsed
+
+    @component.output_types(documents=list[Document], links=list[str], session_id=str)
+    async def run_async(
+        self,
+        query: str,
+        search_params: dict[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        """
+        Asynchronously search the web using Parallel and return results as Documents.
+
+        :param query: Search query string.
+        :param search_params:
+            Optional per-run override of search parameters.
+            If provided, fully replaces the init-time `search_params`.
+        :returns: A dictionary with:
+            - `documents`: List of Documents containing search result excerpts.
+            - `links`: List of URLs from the search results.
+            - `session_id`: Session identifier for this search, echoed back from
+              `search_params["session_id"]` if it was provided and generated by the API otherwise.
+              Pass it to subsequent searches that belong to the same task.
+        """
+        if self._async_client is None:
+            await self.warm_up_async()
+
+        response = await self._async_client.post(  # type: ignore[union-attr]
+            PARALLEL_SEARCH_URL,
+            headers=self._build_headers(),
+            json=self._build_body(query, search_params),
+        )
+        response.raise_for_status()
+        parsed = self._parse_response(response.json())
+
+        logger.debug(
+            "Parallel returned {number_documents} documents for the query '{query}'",
+            number_documents=len(parsed["documents"]),
+            query=query,
+        )
+        return parsed
+
+    @staticmethod
+    def _parse_response(response: dict[str, Any]) -> dict[str, Any]:
+        """
+        Convert a Parallel search response to Haystack Documents, links and session identifier.
+
+        :param response: Parallel search response dictionary.
+        :returns: Dictionary with `documents`, `links` and `session_id` keys.
+        """
+        documents: list[Document] = []
+        links: list[str] = []
+
+        for result in response.get("results", []):
+            url = result.get("url", "")
+            title = result.get("title") or ""
+            excerpts = result.get("excerpts") or []
+            content = " ... ".join(excerpts)
+            meta: dict[str, Any] = {"title": title, "url": url}
+            if excerpts:
+                meta["excerpts"] = excerpts
+            publish_date = result.get("publish_date")
+            if publish_date is not None:
+                meta["publish_date"] = publish_date
+            documents.append(Document(content=content, meta=meta))
+            if url:
+                links.append(url)
+
+        return {"documents": documents, "links": links, "session_id": response.get("session_id") or ""}

parallel_haystack-1.0.0.dist-info/METADATA

@@ -0,0 +1,41 @@
+Metadata-Version: 2.5
+Name: parallel-haystack
+Version: 1.0.0
+Summary: Haystack integration for Parallel web search and web-research models
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/parallel#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/parallel
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: AI Search,Deep Research,Haystack,Parallel,Web Search
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: haystack-ai>=2.24.1
+Requires-Dist: httpx>=0.27.0
+Description-Content-Type: text/markdown
+
+# parallel-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/parallel-haystack.svg)](https://pypi.org/project/parallel-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/parallel-haystack.svg)](https://pypi.org/project/parallel-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/parallel)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/parallel/CHANGELOG.md)
+
+---
+
+## Contributing
+
+Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+To run integration tests locally, you need to export the `PARALLEL_API_KEY` environment variable.

parallel_haystack-1.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+haystack_integrations/components/generators/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/generators/parallel/__init__.py,sha256=S8T7k5M7WjZ619ypEeb26PQ9wD65X6BIEMd8Es8Ebio,264
+haystack_integrations/components/generators/parallel/chat/__init__.py,sha256=S8T7k5M7WjZ619ypEeb26PQ9wD65X6BIEMd8Es8Ebio,264
+haystack_integrations/components/generators/parallel/chat/chat_generator.py,sha256=3xm0xtfmoGhE91hCbz3IKqE-k7YRukqBKTUU-O3drQY,8156
+haystack_integrations/components/websearch/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/websearch/parallel/__init__.py,sha256=aBrTiVYMeW-WsJSWBcroRWwakJbNiE3HRztHraagSr0,254
+haystack_integrations/components/websearch/parallel/parallel_websearch.py,sha256=QUTeV8y_3qC3j7V6s27VTNptFjn9LKo5hwD1iOFvW2Y,9790
+parallel_haystack-1.0.0.dist-info/METADATA,sha256=9TasYtLokWLG6u3DoCILna0cnkJ317E9X4BeHPS0__U,2012
+parallel_haystack-1.0.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+parallel_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+parallel_haystack-1.0.0.dist-info/RECORD,,

parallel_haystack-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

parallel_haystack-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023-present deepset GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.