paddleocr-haystack 0.1.0__py3-none-any.whl

haystack_integrations/components/converters/paddleocr/__init__.py

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2025-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+from .paddleocr_vl_document_converter import PaddleOCRVLDocumentConverter
+
+__all__ = ["PaddleOCRVLDocumentConverter"]

haystack_integrations/components/converters/paddleocr/paddleocr_vl_document_converter.py

@@ -0,0 +1,494 @@
+# SPDX-FileCopyrightText: 2025-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+import base64
+from pathlib import Path
+from typing import Any, Literal, Optional, Union
+
+import requests
+from haystack import Document, component, default_from_dict, default_to_dict, logging
+from haystack.components.converters.utils import (
+    get_bytestream_from_source,
+    normalize_metadata,
+)
+from haystack.dataclasses import ByteStream
+from haystack.utils import Secret, deserialize_secrets_inplace
+from paddlex.inference.serving.schemas.paddleocr_vl import (  # type: ignore[import-untyped]
+    InferRequest as PaddleOCRVLInferRequest,
+)
+from paddlex.inference.serving.schemas.paddleocr_vl import (  # type: ignore[import-untyped]
+    InferResult as PaddleOCRVLInferResult,
+)
+from paddlex.inference.serving.schemas.shared.ocr import FileType  # type: ignore[import-untyped]
+
+logger = logging.getLogger(__name__)
+
+
+FileTypeInput = Union[Literal["pdf", "image"], None]
+
+# Supported image file extensions
+_IMAGE_EXTENSIONS = {
+    ".jpg",
+    ".jpeg",
+    ".png",
+    ".bmp",
+    ".tiff",
+    ".tif",
+    ".webp",
+}
+# Supported PDF file extensions
+_PDF_EXTENSIONS = {".pdf"}
+
+
+def _infer_file_type_from_source(
+    source: Union[str, Path, ByteStream],
+    mime_type: Optional[str] = None,
+) -> Optional[FileType]:
+    """
+    Infer file type from file extension or MIME type.
+
+    :param source:
+        Original source (file path, Path object, or ByteStream).
+    :param mime_type:
+        MIME type of the source.
+    :returns:
+        Inferred file type: 0 for PDF, 1 for image, or None if cannot be
+        determined.
+    """
+    # Try to get extension from file path
+    file_path: Optional[str] = None
+
+    # Check if source is a file path
+    if isinstance(source, (str, Path)):
+        file_path = str(source)
+    # Check if source is `ByteStream` and has `file_path` in metadata
+    elif isinstance(source, ByteStream) and source.meta:
+        file_path = source.meta.get("file_path")
+
+    # Try to infer from file extension
+    if file_path:
+        path_obj = Path(file_path)
+        extension = path_obj.suffix.lower()
+
+        if extension in _PDF_EXTENSIONS:
+            return 0
+        if extension in _IMAGE_EXTENSIONS:
+            return 1
+
+    # Try to infer from MIME type if available
+    if mime_type:
+        mime_type_lower = mime_type.lower()
+        if mime_type_lower == "application/pdf":
+            return 0
+        if mime_type_lower.startswith("image/"):
+            return 1
+
+    return None
+
+
+def _normalize_file_type(file_type: Optional[FileTypeInput]) -> Optional[FileType]:
+    """
+    Normalize file type input to the numeric format expected by the API.
+
+    :param file_type:
+        File type input. Can be "pdf" for PDF, "image" for image,
+        or `None` for auto-detection.
+    :returns:
+        Normalized file type: 0 for PDF, 1 for image, or `None` for
+        auto-detection.
+    """
+    if file_type is None:
+        return None
+    if isinstance(file_type, str):
+        if file_type.lower() == "pdf":
+            return 0
+        if file_type.lower() == "image":
+            return 1
+        msg = f"Invalid `file_type` string: {file_type}. Must be 'pdf' or 'image'."
+        raise ValueError(msg)
+    msg = f"Invalid `file_type` value: {file_type}. Must be 'pdf', 'image', or `None`."
+    raise ValueError(msg)
+
+
+@component
+class PaddleOCRVLDocumentConverter:
+    """
+    This component extracts text from documents using PaddleOCR's large model
+    document parsing API.
+
+    PaddleOCR-VL is used behind the scenes. For more information, please
+    refer to:
+    https://www.paddleocr.ai/latest/en/version3.x/algorithm/PaddleOCR-VL/PaddleOCR-VL.html
+
+    **Usage Example:**
+
+    ```python
+    from haystack.utils import Secret
+    from haystack_integrations.components.converters.paddleocr import (
+        PaddleOCRVLDocumentConverter,
+    )
+
+    converter = PaddleOCRVLDocumentConverter(
+        api_url="http://xxxxx.aistudio-app.com/layout-parsing",
+        access_token=Secret.from_env_var("AISTUDIO_ACCESS_TOKEN"),
+    )
+
+    result = converter.run(sources=["sample.pdf"])
+
+    documents = result["documents"]
+    raw_responses = result["raw_paddleocr_responses"]
+    ```
+    """
+
+    def __init__(
+        self,
+        *,
+        api_url: str,
+        access_token: Secret = Secret.from_env_var("AISTUDIO_ACCESS_TOKEN"),
+        file_type: Optional[FileTypeInput] = None,
+        use_doc_orientation_classify: Optional[bool] = None,
+        use_doc_unwarping: Optional[bool] = None,
+        use_layout_detection: Optional[bool] = None,
+        use_chart_recognition: Optional[bool] = None,
+        layout_threshold: Optional[Union[float, dict]] = None,
+        layout_nms: Optional[bool] = None,
+        layout_unclip_ratio: Optional[Union[float, tuple[float, float], dict]] = None,
+        layout_merge_bboxes_mode: Optional[Union[str, dict]] = None,
+        prompt_label: Optional[str] = None,
+        format_block_content: Optional[bool] = None,
+        repetition_penalty: Optional[float] = None,
+        temperature: Optional[float] = None,
+        top_p: Optional[float] = None,
+        min_pixels: Optional[int] = None,
+        max_pixels: Optional[int] = None,
+        prettify_markdown: Optional[bool] = None,
+        show_formula_number: Optional[bool] = None,
+        visualize: Optional[bool] = None,
+        additional_params: Optional[dict[str, Any]] = None,
+    ):
+        """
+        Create a `PaddleOCRVLDocumentConverter` component.
+
+        :param api_url:
+            API URL. To obtain the API URL, visit the [PaddleOCR official
+            website](https://aistudio.baidu.com/paddleocr/task), click the
+            **API** button in the upper-left corner, choose the example code
+            for **Large Model document parsing(PaddleOCR-VL)**, and copy the
+            `API_URL`.
+        :param access_token:
+            AI Studio access token. You can obtain it from [this
+            page](https://aistudio.baidu.com/account/accessToken).
+        :param file_type:
+            File type. Can be "pdf" for PDF files, "image" for
+            image files, or `None` for auto-detection. If not specified, the
+            file type will be inferred from the file extension.
+        :param use_doc_orientation_classify:
+            Whether to enable the document orientation classification
+            function. Enabling this feature allows the input image to be
+            automatically rotated to the correct orientation.
+        :param use_doc_unwarping:
+            Whether to enable the text image unwarping function. Enabling
+            this feature allows automatic correction of distorted text images.
+        :param use_layout_detection:
+            Whether to enable the layout detection function.
+        :param use_chart_recognition:
+            Whether to enable the chart recognition function.
+        :param layout_threshold:
+            Layout detection threshold. Can be a float or a dict with
+            page-specific thresholds.
+        :param layout_nms:
+            Whether to perform NMS (Non-Maximum Suppression) on layout
+            detection results.
+        :param layout_unclip_ratio:
+            Layout unclip ratio. Can be a float, a tuple of (min, max), or a
+            dict with page-specific values.
+        :param layout_merge_bboxes_mode:
+            Layout merge bounding boxes mode. Can be a string or a dict.
+        :param prompt_label:
+            Prompt type for the VLM. Possible values are "ocr", "formula",
+            "table", and "chart".
+        :param format_block_content:
+            Whether to format block content.
+        :param repetition_penalty:
+            Repetition penalty parameter used in VLM sampling.
+        :param temperature:
+            Temperature parameter used in VLM sampling.
+        :param top_p:
+            Top-p parameter used in VLM sampling.
+        :param min_pixels:
+            Minimum number of pixels allowed during VLM preprocessing.
+        :param max_pixels:
+            Maximum number of pixels allowed during VLM preprocessing.
+        :param prettify_markdown:
+            Whether to prettify the output Markdown text.
+        :param show_formula_number:
+            Whether to include formula numbers in the output markdown text.
+        :param visualize:
+            Whether to return visualization results.
+        :param additional_params:
+            Additional parameters for calling the PaddleOCR API.
+        """
+        self.api_url = api_url
+        self.access_token = access_token
+        self.file_type = _normalize_file_type(file_type)
+        self.use_doc_orientation_classify = use_doc_orientation_classify
+        self.use_doc_unwarping = use_doc_unwarping
+        self.use_layout_detection = use_layout_detection
+        self.use_chart_recognition = use_chart_recognition
+        self.layout_threshold = layout_threshold
+        self.layout_nms = layout_nms
+        self.layout_unclip_ratio = layout_unclip_ratio
+        self.layout_merge_bboxes_mode = layout_merge_bboxes_mode
+        self.prompt_label = prompt_label
+        self.format_block_content = format_block_content
+        self.repetition_penalty = repetition_penalty
+        self.temperature = temperature
+        self.top_p = top_p
+        self.min_pixels = min_pixels
+        self.max_pixels = max_pixels
+        self.prettify_markdown = prettify_markdown
+        self.show_formula_number = show_formula_number
+        self.visualize = visualize
+        self.additional_params = additional_params
+
+    def to_dict(self) -> dict[str, Any]:
+        """
+        Serialize the component to a dictionary.
+
+        :returns:
+            Dictionary with serialized data.
+        """
+        return default_to_dict(
+            self,
+            api_url=self.api_url,
+            access_token=self.access_token.to_dict(),
+            file_type=self.file_type,
+            use_doc_orientation_classify=self.use_doc_orientation_classify,
+            use_doc_unwarping=self.use_doc_unwarping,
+            use_layout_detection=self.use_layout_detection,
+            use_chart_recognition=self.use_chart_recognition,
+            layout_threshold=self.layout_threshold,
+            layout_nms=self.layout_nms,
+            layout_unclip_ratio=self.layout_unclip_ratio,
+            layout_merge_bboxes_mode=self.layout_merge_bboxes_mode,
+            prompt_label=self.prompt_label,
+            format_block_content=self.format_block_content,
+            repetition_penalty=self.repetition_penalty,
+            temperature=self.temperature,
+            top_p=self.top_p,
+            min_pixels=self.min_pixels,
+            max_pixels=self.max_pixels,
+            prettify_markdown=self.prettify_markdown,
+            show_formula_number=self.show_formula_number,
+            visualize=self.visualize,
+            additional_params=self.additional_params,
+        )
+
+    @classmethod
+    def from_dict(cls, data: dict[str, Any]) -> "PaddleOCRVLDocumentConverter":
+        """
+        Deserialize the component from a dictionary.
+
+        :param data:
+            Dictionary to deserialize from.
+        :returns:
+            Deserialized component.
+        """
+        deserialize_secrets_inplace(data["init_parameters"], keys=["access_token"])
+        return default_from_dict(cls, data)
+
+    def _parse(self, data: bytes, file_type: FileType) -> tuple[str, dict[str, Any]]:
+        """
+        Parse document using PaddleOCR API.
+
+        :param data:
+            Raw file data as bytes.
+        :param file_type:
+            File type (0 for PDF, 1 for image).
+        :returns:
+            A tuple containing the extracted text (separated by form feed
+            characters for multiple pages) and the raw response dictionary.
+        :raises requests.RequestException:
+            If the API request fails.
+        :raises ValueError:
+            If the API response is invalid or missing required fields.
+        """
+        # Encode file data to base64
+        encoded_data = base64.b64encode(data).decode("ascii")
+
+        # Build request payload
+        request_data = {
+            "file": encoded_data,
+            "fileType": file_type,
+        }
+
+        # Add optional parameters if they are set
+        if self.use_doc_orientation_classify is not None:
+            request_data["useDocOrientationClassify"] = self.use_doc_orientation_classify
+        if self.use_doc_unwarping is not None:
+            request_data["useDocUnwarping"] = self.use_doc_unwarping
+        if self.use_layout_detection is not None:
+            request_data["useLayoutDetection"] = self.use_layout_detection
+        if self.use_chart_recognition is not None:
+            request_data["useChartRecognition"] = self.use_chart_recognition
+        if self.layout_threshold is not None:
+            request_data["layoutThreshold"] = self.layout_threshold
+        if self.layout_nms is not None:
+            request_data["layoutNms"] = self.layout_nms
+        if self.layout_unclip_ratio is not None:
+            request_data["layoutUnclipRatio"] = self.layout_unclip_ratio
+        if self.layout_merge_bboxes_mode is not None:
+            request_data["layoutMergeBboxesMode"] = self.layout_merge_bboxes_mode
+        if self.prompt_label is not None:
+            request_data["promptLabel"] = self.prompt_label
+        if self.format_block_content is not None:
+            request_data["formatBlockContent"] = self.format_block_content
+        if self.repetition_penalty is not None:
+            request_data["repetitionPenalty"] = self.repetition_penalty
+        if self.temperature is not None:
+            request_data["temperature"] = self.temperature
+        if self.top_p is not None:
+            request_data["topP"] = self.top_p
+        if self.min_pixels is not None:
+            request_data["minPixels"] = self.min_pixels
+        if self.max_pixels is not None:
+            request_data["maxPixels"] = self.max_pixels
+        if self.prettify_markdown is not None:
+            request_data["prettifyMarkdown"] = self.prettify_markdown
+        if self.show_formula_number is not None:
+            request_data["showFormulaNumber"] = self.show_formula_number
+        if self.visualize is not None:
+            request_data["visualize"] = self.visualize
+        if self.additional_params is not None:
+            request_data.update(self.additional_params)
+
+        # Validate input parameters
+        try:
+            request = PaddleOCRVLInferRequest(**request_data)
+            request_dict = request.model_dump(exclude_none=True)
+        except Exception as e:
+            msg = f"Invalid request parameters: {e}"
+            raise ValueError(msg) from e
+
+        # Prepare headers with authentication
+        access_token_value = self.access_token.resolve_value() if self.access_token else None
+        headers = {"Content-Type": "application/json"}
+        if access_token_value:
+            headers["Authorization"] = f"token {access_token_value}"
+
+        # Make API request
+        try:
+            response = requests.post(
+                self.api_url,
+                json=request_dict,
+                headers=headers,
+                timeout=300,
+            )
+            response.raise_for_status()
+        except requests.RequestException as e:
+            logger.error(f"Failed to call PaddleOCR API: {e}")
+            raise
+
+        # Parse and validate response
+        try:
+            response_data = response.json()
+        except ValueError as e:
+            msg = f"Invalid JSON response from API: {e}"
+            raise ValueError(msg) from e
+
+        if "result" not in response_data:
+            msg = "Response missing 'result' field"
+            raise ValueError(msg)
+
+        try:
+            result = PaddleOCRVLInferResult(**response_data["result"])
+        except Exception as e:
+            msg = f"Invalid response format: {e}"
+            raise ValueError(msg) from e
+
+        # Extract text from markdown in layout parsing results
+        # Pages are separated by form feed character (\f) for compatibility
+        # with Haystack's `DocumentSplitter`
+        text_parts = []
+        for layout_result in result.layoutParsingResults:
+            if layout_result.markdown and layout_result.markdown.text:
+                text_parts.append(layout_result.markdown.text)
+
+        text = "\f".join(text_parts) if text_parts else ""
+
+        return text, response_data
+
+    @component.output_types(documents=list[Document], raw_paddleocr_responses=list[dict[str, Any]])
+    def run(
+        self,
+        sources: list[Union[str, Path, ByteStream]],
+        meta: Optional[Union[dict[str, Any], list[dict[str, Any]]]] = None,
+    ) -> dict[str, Any]:
+        """
+        Convert image or PDF files to Documents.
+
+        :param sources:
+            List of image or PDF file paths or ByteStream objects.
+        :param meta:
+            Optional metadata to attach to the Documents.
+            This value can be either a list of dictionaries or a single
+            dictionary. If it's a single dictionary, its content is added to
+            the metadata of all produced Documents. If it's a list, the length
+            of the list must match the number of sources, because the two
+            lists will be zipped. If `sources` contains ByteStream objects,
+            their `meta` will be added to the output Documents.
+
+        :returns:
+            A dictionary with the following keys:
+            - `documents`: A list of created Documents.
+            - `raw_paddleocr_responses`: A list of raw PaddleOCR API responses.
+        """
+        documents = []
+        raw_responses = []
+
+        meta_list = normalize_metadata(meta, sources_count=len(sources))
+
+        for source, metadata in zip(sources, meta_list):
+            try:
+                bytestream = get_bytestream_from_source(source)
+            except Exception as e:
+                logger.warning(
+                    f"Could not read {source}. Skipping it. Error: {e}",
+                )
+                continue
+
+            # Determine file type (either from config or inferred from extension)
+            if self.file_type is not None:
+                file_type = self.file_type
+            else:
+                mime_type = bytestream.mime_type if hasattr(bytestream, "mime_type") and bytestream.mime_type else None
+                file_type = _infer_file_type_from_source(source, mime_type)
+            if file_type is None:
+                logger.warning(
+                    f"Could not determine file type for {source}. Skipping it.",
+                )
+                continue
+
+            try:
+                text, raw_resp = self._parse(bytestream.data, file_type)
+            except Exception as e:
+                logger.warning(
+                    f"Could not read {source} and convert it to Document, skipping. Error: {e}",
+                )
+                continue
+
+            if not text:
+                msg = (
+                    f"{self.__class__.__name__} could not extract text"
+                    " from the file {source}. Returning an empty document."
+                )
+                logger.warning(msg)
+
+            merged_metadata = {**bytestream.meta, **metadata}
+
+            document = Document(content=text, meta=merged_metadata)
+            documents.append(document)
+
+            raw_responses.append(raw_resp)
+
+        return {"documents": documents, "raw_paddleocr_responses": raw_responses}

paddleocr_haystack-0.1.0.dist-info/METADATA

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: paddleocr-haystack
+Version: 0.1.0
+Summary: An integration of PaddleOCR with Haystack
+Project-URL: Documentation, https://github.com/haystack-core-integrations/tree/main/integrations/paddleocr#readme
+Project-URL: Issues, https://github.com/haystack-core-integrations/issues
+Project-URL: Source, https://github.com/haystack-core-integrations/tree/main/integrations/paddleocr
+Author-email: deepset GmbH <info@deepset.ai>
+License-Expression: Apache-2.0
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: haystack-ai>=2.19.0
+Requires-Dist: paddleocr>=3.3.2
+Requires-Dist: paddlex[serving]>=3.3.10
+Requires-Dist: requests>=2.25.0
+Description-Content-Type: text/markdown
+
+# paddleocr-haystack
+
+[![PyPI - Version](https://img.shields.io/pypi/v/paddleocr-haystack.svg)](https://pypi.org/project/paddleocr-haystack)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/paddleocr-haystack.svg)](https://pypi.org/project/paddleocr-haystack)
+
+- [Integration page](https://haystack.deepset.ai/integrations/paddleocr)
+- [Changelog](https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/paddleocr/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 `PADDLEOCR_VL_API_URL` and `AISTUDIO_ACCESS_TOKEN` environment variables.

paddleocr_haystack-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+haystack_integrations/components/converters/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+haystack_integrations/components/converters/paddleocr/__init__.py,sha256=EyXp3NMyaLxz5YJtY-ikuW_WvJshGMUAh3rsFhj3_zg,228
+haystack_integrations/components/converters/paddleocr/paddleocr_vl_document_converter.py,sha256=IodwgCzCzqYj2_gIcaZP3ApIc4jSTLUJlqbHWUZ3LqY,19493
+paddleocr_haystack-0.1.0.dist-info/METADATA,sha256=6DfHATvknBcDiL9yVvvosHyZdop0L_MJKy758p-8IHo,1891
+paddleocr_haystack-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+paddleocr_haystack-0.1.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
+paddleocr_haystack-0.1.0.dist-info/RECORD,,

paddleocr_haystack-0.1.0.dist-info/WHEEL

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

paddleocr_haystack-0.1.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,73 @@
+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 [yyyy] [name of copyright owner]
+
+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.