microsoft-sharepoint-haystack 1.0.0__py3-none-any.whl

haystack_integrations/components/retrievers/microsoft_sharepoint/__init__.py

@@ -0,0 +1,12 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+from .errors import SharePointConfigError, SharePointError, SharePointRequestError
+from .retriever import MSSharePointRetriever
+
+__all__ = [
+    "MSSharePointRetriever",
+    "SharePointConfigError",
+    "SharePointError",
+    "SharePointRequestError",
+]

haystack_integrations/components/retrievers/microsoft_sharepoint/errors.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+
+class SharePointError(Exception):
+    """Base class for errors raised by the Microsoft SharePoint integration."""
+
+
+class SharePointConfigError(SharePointError):
+    """Raised when the SharePoint retriever is misconfigured."""
+
+
+class SharePointRequestError(SharePointError):
+    """Raised when a Microsoft Graph search request fails."""
+
+    def __init__(self, message: str, status_code: int | None = None) -> None:
+        super().__init__(message)
+        self.status_code = status_code

haystack_integrations/components/retrievers/microsoft_sharepoint/retriever.py

@@ -0,0 +1,405 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import html
+import os
+import re
+from typing import Any
+
+import httpx
+from haystack import Document, component, default_from_dict, default_to_dict, logging
+from haystack.utils import Secret
+from tenacity import AsyncRetrying, RetryCallState, Retrying, retry_if_result, stop_after_attempt, wait_exponential
+
+from .errors import SharePointConfigError, SharePointRequestError
+
+logger = logging.getLogger(__name__)
+
+_DEFAULT_GRAPH_URL = "https://graph.microsoft.com/v1.0"
+_DEFAULT_ENTITY_TYPES = ("driveItem", "listItem")
+# Microsoft Graph caps a single search page at 500 results; larger `top_k` values are paginated.
+_MAX_PAGE_SIZE = 500
+_RETRYABLE_STATUS = frozenset({429, 500, 502, 503, 504})
+# Fallback backoff when a throttled response carries no `Retry-After` header: 1s, 2s, 4s, ...
+_EXPONENTIAL_BACKOFF = wait_exponential()
+
+# Search summaries come back as snippets with hit-highlight markup, e.g.
+# "<c0>Contoso</c0> Detailed Design <ddd/>". These patterns turn that into plain text.
+_HIGHLIGHT_PATTERN = re.compile(r"</?c\d+>")
+_ELLIPSIS_PATTERN = re.compile(r"<ddd\s*/>")
+
+
+def _retry_response(retry_state: RetryCallState) -> httpx.Response | None:
+    """Return the `httpx.Response` recorded for a retry attempt, or `None` if the attempt raised."""
+    outcome = retry_state.outcome
+    if outcome is None or outcome.failed:
+        return None
+    return outcome.result()
+
+
+def _is_retryable_response(response: httpx.Response) -> bool:
+    """Return whether a Microsoft Graph response should trigger a retry."""
+    return response.status_code in _RETRYABLE_STATUS
+
+
+def _wait_with_retry_after(retry_state: RetryCallState) -> float:
+    """Wait strategy honoring a numeric `Retry-After` header, falling back to exponential backoff."""
+    response = _retry_response(retry_state)
+    if response is not None:
+        retry_after = response.headers.get("Retry-After")
+        if retry_after:
+            try:
+                return float(retry_after)
+            except ValueError:
+                pass
+
+    return _EXPONENTIAL_BACKOFF(retry_state)
+
+
+def _last_response(retry_state: RetryCallState) -> httpx.Response:
+    """Return the final response once retries are exhausted, so the caller can raise a typed error."""
+    response = _retry_response(retry_state)
+    if response is None:
+        msg = "Microsoft Graph retries were exhausted without a recorded response."
+        raise SharePointRequestError(msg)
+    return response
+
+
+def _log_retry(retry_state: RetryCallState) -> None:
+    """Log a warning before sleeping between Microsoft Graph retries."""
+    response = _retry_response(retry_state)
+    next_action = retry_state.next_action
+    if response is None or next_action is None:
+        return
+    logger.warning(
+        "Microsoft Graph returned status {status}; retrying in {delay}s (attempt {attempt}).",
+        status=response.status_code,
+        delay=next_action.sleep,
+        attempt=retry_state.attempt_number,
+    )
+
+
+@component
+class MSSharePointRetriever:
+    """
+    Retrieves content from Microsoft SharePoint and OneDrive via the Microsoft Search (Graph) API.
+
+    Given a query, the retriever calls `POST /search/query` and maps each hit to a Haystack `Document`
+    whose `content` is the search snippet and whose `meta` carries the resource metadata (`file_name`,
+    `web_url`, `entity_type`, `created_date_time`, `last_modified_date_time`, `created_by`, `last_modified_by`,
+    `mime_type`, and `file_extension`). It does not download or convert the underlying files. Compose a
+    downstream fetcher/converter on the returned `web_url` when full file content is needed.
+
+    The retriever takes a per-user `access_token` as a run input, typically wired
+    from an upstream `OAuthResolver`. The token must carry delegated Microsoft Graph permissions
+    (for example `Files.Read.All` and, for site/list scoping, `Sites.Read.All`). The Search API supports
+    delegated permissions only.
+
+    ### Usage example
+    ```python
+    from haystack_integrations.components.retrievers.microsoft_sharepoint import (
+        MSSharePointRetriever,
+    )
+
+    retriever = MSSharePointRetriever(top_k=5)
+
+    # `access_token` is a per-user delegated Microsoft Graph bearer token.
+    result = retriever.run(
+        query="quarterly roadmap", access_token="my-delegated-graph-token"
+    )
+    documents = result["documents"]
+    ```
+
+    In a pipeline, connect an upstream component that emits a per-user `access_token` to the retriever's
+    `access_token` input. See the integration documentation for a full example that obtains the token from
+    an OAuth provider.
+    """
+
+    def __init__(
+        self,
+        *,
+        entity_types: list[str] | None = None,
+        top_k: int = 10,
+        fields: list[str] | None = None,
+        query_template: str | None = None,
+        graph_url: str = _DEFAULT_GRAPH_URL,
+        timeout: float = 30.0,
+        max_retries: int = 3,
+    ) -> None:
+        """
+        Initialize the retriever.
+
+        :param entity_types: The Microsoft Search entity types to query. Defaults to `["driveItem", "listItem"]`,
+            which covers files, folders, SharePoint pages and news, and list items. Other valid values are
+            `"list"` and `"site"`. See the supported values and combinations in the
+            [Microsoft docs](https://learn.microsoft.com/en-us/graph/api/resources/searchrequest).
+        :param top_k: The maximum number of documents to return. Maps to the Search API `size` and is paginated
+            when it exceeds a single page.
+        :param fields: Optional list of resource properties to request via the Search API `fields` selection
+            (only honored for `listItem` and `driveItem` entity types). See
+            [Get selected properties](https://learn.microsoft.com/en-us/graph/api/resources/search-api-overview#get-selected-properties).
+        :param query_template: Optional query template used to scope the search, for example
+            `'{searchTerms} path:"https://contoso.sharepoint.com/sites/Team"'`. The literal `{searchTerms}`
+            placeholder is replaced by the run-time query. The template uses
+            [Keyword Query Language (KQL)](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+        :param graph_url: The Microsoft Graph base URL. Defaults to `https://graph.microsoft.com/v1.0`.
+            Override for sovereign clouds.
+        :param timeout: The HTTP timeout in seconds for each request to Microsoft Graph.
+        :param max_retries: The maximum number of retries for throttled (HTTP 429) or transient server errors.
+        :raises SharePointConfigError: If `entity_types` is empty, `top_k` is not positive, or `max_retries` is
+            negative.
+        """
+        if entity_types is None:
+            entity_types = list(_DEFAULT_ENTITY_TYPES)
+        else:
+            entity_types = list(entity_types)
+            if not entity_types:
+                msg = "entity_types must contain at least one Microsoft Search entity type."
+                raise SharePointConfigError(msg)
+        if top_k <= 0:
+            msg = "top_k must be a positive integer."
+            raise SharePointConfigError(msg)
+        if max_retries < 0:
+            msg = "max_retries must be zero or a positive integer."
+            raise SharePointConfigError(msg)
+
+        self.entity_types = entity_types
+        self.top_k = top_k
+        self.fields = fields
+        self.query_template = query_template
+        self.graph_url = graph_url.rstrip("/")
+        self.timeout = timeout
+        self.max_retries = max_retries
+
+    @component.output_types(documents=list[Document])
+    def run(self, query: str, access_token: str | Secret, top_k: int | None = None) -> dict[str, list[Document]]:
+        """
+        Search SharePoint and OneDrive and return the matching documents.
+
+        :param query: The search query string. Filter results by embedding Keyword Query Language (KQL)
+            operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
+            `path:"https://contoso.sharepoint.com/sites/Team"`. See the
+            [KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+        :param access_token: A delegated Microsoft Graph bearer token for the user whose content is searched,
+            typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
+            accepted and resolved internally.
+        :param top_k: Overrides the `top_k` configured at initialization for this run.
+        :returns: A dictionary with a `documents` key holding the list of retrieved `Document` objects.
+        :raises SharePointConfigError: If `access_token` is a `Secret` that does not resolve to a string.
+        :raises SharePointRequestError: If Microsoft Graph returns an error response.
+        """
+        token = self._resolve_access_token(access_token)
+        limit = top_k or self.top_k
+        documents: list[Document] = []
+        offset = 0
+        with httpx.Client(timeout=self.timeout) as client:
+            while len(documents) < limit:
+                size = min(_MAX_PAGE_SIZE, limit - len(documents))
+                request_body = self._build_request_body(query, offset, size)
+                payload = self._post(client, token, request_body)
+                container = self._first_container(payload)
+                hits = container.get("hits") or []
+                documents.extend(self._hit_to_document(hit) for hit in hits)
+                if not hits or not container.get("moreResultsAvailable"):
+                    break
+                offset += len(hits)
+
+        return {"documents": documents[:limit]}
+
+    @component.output_types(documents=list[Document])
+    async def run_async(
+        self, query: str, access_token: str | Secret, top_k: int | None = None
+    ) -> dict[str, list[Document]]:
+        """
+        Asynchronously search SharePoint and OneDrive and return the matching documents.
+
+        :param query: The search query string. Filter results by embedding Keyword Query Language (KQL)
+            operators directly in the query, for example `filetype:docx`, `author:"Jane Doe"`, or
+            `path:"https://contoso.sharepoint.com/sites/Team"`. See the
+            [KQL syntax reference](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/keyword-query-language-kql-syntax-reference).
+        :param access_token: A delegated Microsoft Graph bearer token for the user whose content is searched,
+            typically wired from an upstream `OAuthResolver` (which emits a plain `str`). A `Secret` is also
+            accepted and resolved internally.
+        :param top_k: Overrides the `top_k` configured at initialization for this run.
+        :returns: A dictionary with a `documents` key holding the list of retrieved `Document` objects.
+        :raises SharePointConfigError: If `access_token` is a `Secret` that does not resolve to a string.
+        :raises SharePointRequestError: If Microsoft Graph returns an error response.
+        """
+        token = self._resolve_access_token(access_token)
+        limit = top_k or self.top_k
+        documents: list[Document] = []
+        offset = 0
+        async with httpx.AsyncClient(timeout=self.timeout) as client:
+            while len(documents) < limit:
+                size = min(_MAX_PAGE_SIZE, limit - len(documents))
+                request_body = self._build_request_body(query, offset, size)
+                payload = await self._post_async(client, token, request_body)
+                container = self._first_container(payload)
+                hits = container.get("hits") or []
+                documents.extend(self._hit_to_document(hit) for hit in hits)
+                if not hits or not container.get("moreResultsAvailable"):
+                    break
+                offset += len(hits)
+
+        return {"documents": documents[:limit]}
+
+    @staticmethod
+    def _resolve_access_token(access_token: str | Secret) -> str:
+        """Return the bearer token string, resolving it if a `Secret` was passed."""
+        if not isinstance(access_token, Secret):
+            return access_token
+        resolved = access_token.resolve_value()
+        if not isinstance(resolved, str):
+            msg = "The access_token Secret did not resolve to a string value."
+            raise SharePointConfigError(msg)
+        return resolved
+
+    def _build_request_body(self, query: str, offset: int, size: int) -> dict[str, Any]:
+        """
+        Build the Microsoft Search `POST /search/query` request body for one page.
+
+        See the searchRequest resource for the full set of supported properties:
+        https://learn.microsoft.com/en-us/graph/api/resources/searchrequest
+        """
+        query_obj: dict[str, Any] = {"queryString": query}
+        if self.query_template:
+            query_obj["queryTemplate"] = self.query_template
+        request: dict[str, Any] = {
+            "entityTypes": self.entity_types,
+            "query": query_obj,
+            "from": offset,
+            "size": size,
+        }
+        if self.fields:
+            request["fields"] = self.fields
+
+        return {"requests": [request]}
+
+    @staticmethod
+    def _first_container(payload: dict[str, Any]) -> dict[str, Any]:
+        """Return the first hitsContainer from a Microsoft Search response, or an empty dict."""
+        value = payload.get("value") or []
+        if not value:
+            return {}
+        containers = value[0].get("hitsContainers") or []
+
+        return containers[0] if containers else {}
+
+    def _post(self, client: httpx.Client, access_token: str, body: dict[str, Any]) -> dict[str, Any]:
+        """Send a search request, retrying on throttling/transient errors, and return the parsed JSON."""
+        url = f"{self.graph_url}/search/query"
+        headers = {"Authorization": f"Bearer {access_token}", "Content-Type": "application/json"}
+        retrying = Retrying(
+            stop=stop_after_attempt(self.max_retries + 1),
+            wait=_wait_with_retry_after,
+            retry=retry_if_result(_is_retryable_response),
+            before_sleep=_log_retry,
+            retry_error_callback=_last_response,
+        )
+        response: httpx.Response = retrying(client.post, url, headers=headers, json=body)
+
+        return self._parse_response(response)
+
+    async def _post_async(self, client: httpx.AsyncClient, access_token: str, body: dict[str, Any]) -> dict[str, Any]:
+        """Async variant of `_post`."""
+        url = f"{self.graph_url}/search/query"
+        headers = {"Authorization": f"Bearer {access_token}", "Content-Type": "application/json"}
+        retrying = AsyncRetrying(
+            stop=stop_after_attempt(self.max_retries + 1),
+            wait=_wait_with_retry_after,
+            retry=retry_if_result(_is_retryable_response),
+            before_sleep=_log_retry,
+            retry_error_callback=_last_response,
+        )
+        response: httpx.Response = await retrying(client.post, url, headers=headers, json=body)
+
+        return self._parse_response(response)
+
+    @staticmethod
+    def _parse_response(response: httpx.Response) -> dict[str, Any]:
+        """Return the parsed JSON for a successful response, or raise a descriptive error."""
+        if not response.is_error:
+            return response.json()
+
+        status = response.status_code
+        if status == httpx.codes.UNAUTHORIZED:
+            msg = (
+                "Microsoft Graph rejected the access token (401 Unauthorized). The token may be expired, invalid, "
+                "or missing the required delegated scopes (for example Files.Read.All / Sites.Read.All)."
+            )
+        elif status == httpx.codes.FORBIDDEN:
+            msg = f"Microsoft Graph denied the search request (403 Forbidden): {response.text}"
+        else:
+            msg = f"Microsoft Graph search request failed with status {status}: {response.text}"
+
+        raise SharePointRequestError(msg, status_code=status)
+
+    @staticmethod
+    def _clean_summary(summary: str) -> str:
+        """Strip Microsoft Search hit-highlight markup from a result summary and unescape entities."""
+        if not summary:
+            return ""
+        text = _ELLIPSIS_PATTERN.sub("…", summary)
+        text = _HIGHLIGHT_PATTERN.sub("", text)
+        return html.unescape(text).strip()
+
+    @staticmethod
+    def _display_name(identity: dict[str, Any] | None) -> str | None:
+        """Extract the user display name from a Microsoft Graph identitySet, if present."""
+        if not identity:
+            return None
+        user = identity.get("user") or {}
+        return user.get("displayName")
+
+    @staticmethod
+    def _hit_to_document(hit: dict[str, Any]) -> Document:
+        """Map a single Microsoft Search hit to a Haystack Document (snippet content + resource metadata)."""
+        resource = hit.get("resource") or {}
+
+        name = resource.get("name") or resource.get("displayName")
+        content = MSSharePointRetriever._clean_summary(hit.get("summary", "")) or name or ""
+
+        file_facet = resource.get("file") or {}
+        # Microsoft Graph has no dedicated file-extension field, so derive it from the name.
+        extension = os.path.splitext(name or "")[1].lstrip(".").lower()
+
+        meta = {
+            "file_name": name,
+            "web_url": resource.get("webUrl"),
+            "entity_type": resource.get("@odata.type"),
+            "created_date_time": resource.get("createdDateTime"),
+            "last_modified_date_time": resource.get("lastModifiedDateTime"),
+            "created_by": MSSharePointRetriever._display_name(resource.get("createdBy")),
+            "last_modified_by": MSSharePointRetriever._display_name(resource.get("lastModifiedBy")),
+            "mime_type": file_facet.get("mimeType"),
+            "file_extension": extension or None,
+        }
+        return Document(content=content, meta={key: value for key, value in meta.items() if value is not None})
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize this component to a dictionary.
+
+        :returns: The serialized component as a dictionary.
+        """
+        return default_to_dict(
+            self,
+            entity_types=self.entity_types,
+            top_k=self.top_k,
+            fields=self.fields,
+            query_template=self.query_template,
+            graph_url=self.graph_url,
+            timeout=self.timeout,
+            max_retries=self.max_retries,
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "MSSharePointRetriever":
+        """
+        Deserialize this component from a dictionary.
+
+        :param data: The dictionary representation of this component.
+        :returns: The deserialized component instance.
+        """
+        return default_from_dict(cls, data)

microsoft_sharepoint_haystack-1.0.0.dist-info/METADATA

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: microsoft-sharepoint-haystack
+Version: 1.0.0
+Summary: Haystack integration for microsoft_sharepoint
+Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/microsoft_sharepoint#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/microsoft_sharepoint
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Keywords: haystack,microsoft,retriever,sharepoint
+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
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: tenacity>=8.2.3
+Description-Content-Type: text/markdown
+
+# microsoft-sharepoint-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/microsoft-sharepoint-haystack.svg)](https://pypi.org/project/microsoft-sharepoint-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/microsoft-sharepoint-haystack.svg)](https://pypi.org/project/microsoft-sharepoint-haystack)
+
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/microsoft_sharepoint/CHANGELOG.md)

microsoft_sharepoint_haystack-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+haystack_integrations/components/retrievers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/retrievers/microsoft_sharepoint/__init__.py,sha256=QinvTCH4Z6ehajQTzxfX-DQUfjPAR-9dEXe7F9teNvA,364
+haystack_integrations/components/retrievers/microsoft_sharepoint/errors.py,sha256=9dyJqHug8DhtwCPqTc2ICyq0Xt3rx0et1h8MtAAy3vk,602
+haystack_integrations/components/retrievers/microsoft_sharepoint/retriever.py,sha256=f4PfWkcM2NkL7CWd7uchvDgzP0fe6Ps7KpwCyamzvcw,19078
+microsoft_sharepoint_haystack-1.0.0.dist-info/METADATA,sha256=jLDyrBG6a1y-GQ4dv2Bb-wCKHNPAu6bOXbP_TaNMyzE,1781
+microsoft_sharepoint_haystack-1.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+microsoft_sharepoint_haystack-1.0.0.dist-info/licenses/LICENSE.txt,sha256=OrAtTu4aPmrTjKDSTzkSPgo_ji6NOMWO2N9JOTFyAzM,11350
+microsoft_sharepoint_haystack-1.0.0.dist-info/RECORD,,

microsoft_sharepoint_haystack-1.0.0.dist-info/WHEEL

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

microsoft_sharepoint_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.