spark-nlp 6.1.4__py2.py3-none-any.whl → 6.1.5__py2.py3-none-any.whl

{spark_nlp-6.1.4.dist-info → spark_nlp-6.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spark-nlp
-Version: 6.1.4
+Version: 6.1.5
 Summary: John Snow Labs Spark NLP is a natural language processing library built on top of Apache Spark ML. It provides simple, performant & accurate NLP annotations for machine learning pipelines, that scale easily in a distributed environment.
 Home-page: https://github.com/JohnSnowLabs/spark-nlp
 Author: John Snow Labs
@@ -102,7 +102,7 @@ $ java -version
 $ conda create -n sparknlp python=3.7 -y
 $ conda activate sparknlp
 # spark-nlp by default is based on pyspark 3.x
-$ pip install spark-nlp==6.1.4 pyspark==3.3.1
+$ pip install spark-nlp==6.1.5 pyspark==3.3.1
 ```
 
 In Python console or Jupyter `Python3` kernel:
@@ -168,7 +168,7 @@ For a quick example of using pipelines and models take a look at our official [d
 
 ### Apache Spark Support
 
-Spark NLP *6.1.4* has been built on top of Apache Spark 3.4 while fully supports Apache Spark 3.0.x, 3.1.x, 3.2.x, 3.3.x, 3.4.x, and 3.5.x
+Spark NLP *6.1.5* has been built on top of Apache Spark 3.4 while fully supports Apache Spark 3.0.x, 3.1.x, 3.2.x, 3.3.x, 3.4.x, and 3.5.x
 
 | Spark NLP | Apache Spark 3.5.x | Apache Spark 3.4.x | Apache Spark 3.3.x | Apache Spark 3.2.x | Apache Spark 3.1.x | Apache Spark 3.0.x | Apache Spark 2.4.x | Apache Spark 2.3.x |
 |-----------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|--------------------|
@@ -198,7 +198,7 @@ Find out more about 4.x `SparkNLP` versions in our official [documentation](http
 
 ### Databricks Support
 
-Spark NLP 6.1.4 has been tested and is compatible with the following runtimes:
+Spark NLP 6.1.5 has been tested and is compatible with the following runtimes:
 
 | **CPU**            | **GPU**            |
 |--------------------|--------------------|
@@ -216,7 +216,7 @@ We are compatible with older runtimes. For a full list check databricks support
 
 ### EMR Support
 
-Spark NLP 6.1.4 has been tested and is compatible with the following EMR releases:
+Spark NLP 6.1.5 has been tested and is compatible with the following EMR releases:
 
 | **EMR Release**    |
 |--------------------|

{spark_nlp-6.1.4.dist-info → spark_nlp-6.1.5.dist-info}/RECORD

@@ -3,7 +3,7 @@ com/johnsnowlabs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 com/johnsnowlabs/ml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 com/johnsnowlabs/ml/ai/__init__.py,sha256=YQiK2M7U4d8y5irPy_HB8ae0mSpqS9583MH44pnKJXc,295
 com/johnsnowlabs/nlp/__init__.py,sha256=DPIVXtONO5xXyOk-HB0-sNiHAcco17NN13zPS_6Uw8c,294
-sparknlp/__init__.py,sha256=LcfC7bWeae5XgjWbNbWH94LlJkBon5dA8fYnb_2NyGc,13814
+sparknlp/__init__.py,sha256=DDZfgU_lB6Bzk_7AAy81w1hkRwYlrOerC4dP-hQFpm8,13814
 sparknlp/annotation.py,sha256=I5zOxG5vV2RfPZfqN9enT1i4mo6oBcn3Lrzs37QiOiA,5635
 sparknlp/annotation_audio.py,sha256=iRV_InSVhgvAwSRe9NTbUH9v6OGvTM-FPCpSAKVu0mE,1917
 sparknlp/annotation_image.py,sha256=xhCe8Ko-77XqWVuuYHFrjKqF6zPd8Z-RY_rmZXNwCXU,2547
@@ -241,7 +241,7 @@ sparknlp/logging/__init__.py,sha256=DoROFF5KLZe4t4Q-OHxqk1nhqbw9NQ-wb64y8icNwgw,
 sparknlp/logging/comet.py,sha256=_ZBi9-hlilCAnd4lvdYMWiq4Vqsppv8kow3k0cf-NG4,15958
 sparknlp/partition/__init__.py,sha256=L0w-yv_HnnvoKlSX5MzI2GKHW3RLLfGyq8bgWYVeKjU,749
 sparknlp/partition/partition.py,sha256=GXEAUvOea04Vc_JK0z112cAKFrJ4AEpjLJ8xlzZt6Kw,8551
-sparknlp/partition/partition_properties.py,sha256=2tGdIv1NaJNaux_TTskKQHnARAwBkFctaqCcNw21Wr8,19920
+sparknlp/partition/partition_properties.py,sha256=QPqh5p3gvBSofZpPbyd18Zchvls0QP3S9Rsiy9Vko34,21862
 sparknlp/partition/partition_transformer.py,sha256=lRR1h-IMlHR8M0VeB50SbU39GHHF5PgMaJ42qOriS6A,6855
 sparknlp/pretrained/__init__.py,sha256=GV-x9UBK8F2_IR6zYatrzFcVJtkSUIMbxqWsxRUePmQ,793
 sparknlp/pretrained/pretrained_pipeline.py,sha256=lquxiaABuA68Rmu7csamJPqBoRJqMUO0oNHsmEZDAIs,5740
@@ -250,9 +250,10 @@ sparknlp/pretrained/utils.py,sha256=T1MrvW_DaWk_jcOjVLOea0NMFE9w8fe0ZT_5urZ_nEY,
 sparknlp/reader/__init__.py,sha256=-Toj3AIBki-zXPpV8ezFTI2LX1yP_rK2bhpoa8nBkTw,685
 sparknlp/reader/enums.py,sha256=MNGug9oJ1BBLM1Pbske13kAabalDzHa2kucF5xzFpHs,770
 sparknlp/reader/pdf_to_text.py,sha256=eWw-cwjosmcSZ9eHso0F5QQoeGBBnwsOhzhCXXvMjZA,7169
-sparknlp/reader/reader2doc.py,sha256=87aMk8-_1NHd3bB1rxw56BQMJc6mGgtnYGXwKw2uCmU,5916
+sparknlp/reader/reader2doc.py,sha256=lQHwxUwrBOScDryNpQJAdyXIqCDIHEt4-kDf-17ZZds,4287
 sparknlp/reader/reader2image.py,sha256=k3gb4LEiqDV-pnD-HEaA1KHoAxXmoYys2Y817i1yvP0,4557
-sparknlp/reader/reader2table.py,sha256=pIR9r6NapUV4xdsFecadWlKTSJmRMAm36eqM9aXf13k,2416
+sparknlp/reader/reader2table.py,sha256=VINfUzi_tdZN3tCjLmhF9CQjHKUhVYTzBBSRSnTXlr8,1370
+sparknlp/reader/reader_assembler.py,sha256=AgkA3BaZ_00Eor4D84lZLxx04n2pDE_uatO535RAs9M,5655
 sparknlp/reader/sparknlp_reader.py,sha256=MJs8v_ECYaV1SOabI1L_2MkVYEDVImtwgbYypO7DJSY,20623
 sparknlp/training/__init__.py,sha256=qREi9u-5Vc2VjpL6-XZsyvu5jSEIdIhowW7_kKaqMqo,852
 sparknlp/training/conll.py,sha256=wKBiSTrjc6mjsl7Nyt6B8f4yXsDJkZb-sn8iOjix9cE,6961
@@ -284,7 +285,7 @@ sparknlp/training/_tf_graph_builders_1x/ner_dl/dataset_encoder.py,sha256=R4yHFN3
 sparknlp/training/_tf_graph_builders_1x/ner_dl/ner_model.py,sha256=EoCSdcIjqQ3wv13MAuuWrKV8wyVBP0SbOEW41omHlR0,23189
 sparknlp/training/_tf_graph_builders_1x/ner_dl/ner_model_saver.py,sha256=k5CQ7gKV6HZbZMB8cKLUJuZxoZWlP_DFWdZ--aIDwsc,2356
 sparknlp/training/_tf_graph_builders_1x/ner_dl/sentence_grouper.py,sha256=pAxjWhjazSX8Vg0MFqJiuRVw1IbnQNSs-8Xp26L4nko,870
-spark_nlp-6.1.4.dist-info/METADATA,sha256=CqRyNEZCA_8F_J5vHG4GUZXRiavXyfb3tPMTStidr4c,19774
-spark_nlp-6.1.4.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
-spark_nlp-6.1.4.dist-info/top_level.txt,sha256=uuytur4pyMRw2H_txNY2ZkaucZHUs22QF8-R03ch_-E,13
-spark_nlp-6.1.4.dist-info/RECORD,,
+spark_nlp-6.1.5.dist-info/METADATA,sha256=0eZlMGP1ltriZNLI0gw5Amp2ByB_TJyLqTZza9E2pxY,19774
+spark_nlp-6.1.5.dist-info/WHEEL,sha256=JNWh1Fm1UdwIQV075glCn4MVuCRs0sotJIq-J6rbxCU,109
+spark_nlp-6.1.5.dist-info/top_level.txt,sha256=uuytur4pyMRw2H_txNY2ZkaucZHUs22QF8-R03ch_-E,13
+spark_nlp-6.1.5.dist-info/RECORD,,

sparknlp/__init__.py

@@ -66,7 +66,7 @@ sys.modules['com.johnsnowlabs.ml.ai'] = annotator
 annotators = annotator
 embeddings = annotator
 
-__version__ = "6.1.4"
+__version__ = "6.1.5"
 
 
 def start(gpu=False,

sparknlp/partition/partition_properties.py

@@ -18,6 +18,23 @@ from pyspark.ml.param import Param, Params, TypeConverters
 
 class HasReaderProperties(Params):
 
+    inputCol = Param(
+        Params._dummy(),
+        "inputCol",
+        "input column name",
+        typeConverter=TypeConverters.toString
+    )
+
+    def setInputCol(self, value):
+        """Sets input column name.
+
+        Parameters
+        ----------
+        value : str
+            Name of the Input Column
+        """
+        return self._set(inputCol=value)
+
     outputCol = Param(
         Params._dummy(),
         "outputCol",
@@ -25,6 +42,16 @@ class HasReaderProperties(Params):
         typeConverter=TypeConverters.toString
     )
 
+    def setOutputCol(self, value):
+        """Sets output column name.
+
+        Parameters
+        ----------
+        value : str
+            Name of the Output Column
+        """
+        return self._set(outputCol=value)
+
     contentPath = Param(
         Params._dummy(),
         "contentPath",
@@ -167,6 +194,56 @@ class HasReaderProperties(Params):
         """
         return self._set(explodeDocs=value)
 
+    flattenOutput = Param(
+        Params._dummy(),
+        "flattenOutput",
+        "If true, output is flattened to plain text with minimal metadata",
+        typeConverter=TypeConverters.toBoolean
+    )
+
+    def setFlattenOutput(self, value):
+        """Sets whether to flatten the output to plain text with minimal metadata.
+
+        ParametersF
+        ----------
+        value : bool
+            If true, output is flattened to plain text with minimal metadata
+        """
+        return self._set(flattenOutput=value)
+
+    titleThreshold = Param(
+        Params._dummy(),
+        "titleThreshold",
+        "Minimum font size threshold for title detection in PDF docs",
+        typeConverter=TypeConverters.toFloat
+    )
+
+    def setTitleThreshold(self, value):
+        """Sets the minimum font size threshold for title detection in PDF documents.
+
+        Parameters
+        ----------
+        value : float
+            Minimum font size threshold for title detection in PDF docs
+        """
+        return self._set(titleThreshold=value)
+
+    outputAsDocument = Param(
+        Params._dummy(),
+        "outputAsDocument",
+        "Whether to return all sentences joined into a single document",
+        typeConverter=TypeConverters.toBoolean
+    )
+
+    def setOutputAsDocument(self, value):
+        """Sets whether to return all sentences joined into a single document.
+
+        Parameters
+        ----------
+        value : bool
+            Whether to return all sentences joined into a single document
+        """
+        return self._set(outputAsDocument=value)
 
 class HasEmailReaderProperties(Params):
 
@@ -683,13 +760,3 @@ class HasPdfProperties(Params):
             True to read as images, False otherwise.
         """
         return self._set(readAsImage=value)
-
-    def setOutputCol(self, value):
-        """Sets output column name.
-
-        Parameters
-        ----------
-        value : str
-            Name of the Output Column
-        """
-        return self._set(outputCol=value)

sparknlp/reader/reader2doc.py

@@ -12,7 +12,6 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 from pyspark import keyword_only
-from pyspark.ml.param import TypeConverters, Params, Param
 
 from sparknlp.common import AnnotatorType
 from sparknlp.internal import AnnotatorTransformer
@@ -69,32 +68,11 @@ class Reader2Doc(
     |[{'document', 15, 38, 'This is a narrative text', {'pageNumber': 1, 'elementType': 'NarrativeText', 'fileName': 'pdf-title.pdf'}, []}]|
     |[{'document', 39, 68, 'This is another narrative text', {'pageNumber': 1, 'elementType': 'NarrativeText', 'fileName': 'pdf-title.pdf'}, []}]|
     +------------------------------------------------------------------------------------------------------------------------------------+
-"""
+    """
 
     name = "Reader2Doc"
-    outputAnnotatorType = AnnotatorType.DOCUMENT
-
-
-    flattenOutput = Param(
-        Params._dummy(),
-        "flattenOutput",
-        "If true, output is flattened to plain text with minimal metadata",
-        typeConverter=TypeConverters.toBoolean
-    )
 
-    titleThreshold = Param(
-        Params._dummy(),
-        "titleThreshold",
-        "Minimum font size threshold for title detection in PDF docs",
-        typeConverter=TypeConverters.toFloat
-    )
-
-    outputAsDocument = Param(
-        Params._dummy(),
-        "outputAsDocument",
-        "Whether to return all sentences joined into a single document",
-        typeConverter=TypeConverters.toBoolean
-    )
+    outputAnnotatorType = AnnotatorType.DOCUMENT
 
     excludeNonText = Param(
         Params._dummy(),
@@ -103,6 +81,16 @@ class Reader2Doc(
         typeConverter=TypeConverters.toBoolean
     )
 
+    def setExcludeNonText(self, value):
+        """Sets whether to exclude non-text content from the output.
+
+        Parameters
+        ----------
+        value : bool
+            Whether to exclude non-text content from the output. Default is False.
+        """
+        return self._set(excludeNonText=value)
+
     @keyword_only
     def __init__(self):
         super(Reader2Doc, self).__init__(classname="com.johnsnowlabs.reader.Reader2Doc")
@@ -117,44 +105,3 @@ class Reader2Doc(
     def setParams(self):
         kwargs = self._input_kwargs
         return self._set(**kwargs)
-
-
-    def setFlattenOutput(self, value):
-        """Sets whether to flatten the output to plain text with minimal metadata.
-
-        ParametersF
-        ----------
-        value : bool
-            If true, output is flattened to plain text with minimal metadata
-        """
-        return self._set(flattenOutput=value)
-
-    def setTitleThreshold(self, value):
-        """Sets the minimum font size threshold for title detection in PDF documents.
-
-        Parameters
-        ----------
-        value : float
-            Minimum font size threshold for title detection in PDF docs
-        """
-        return self._set(titleThreshold=value)
-
-    def setOutputAsDocument(self, value):
-        """Sets whether to return all sentences joined into a single document.
-
-        Parameters
-        ----------
-        value : bool
-            Whether to return all sentences joined into a single document
-        """
-        return self._set(outputAsDocument=value)
-
-    def setExcludeNonText(self, value):
-        """Sets whether to exclude non-text content from the output.
-
-        Parameters
-        ----------
-        value : bool
-            Whether to exclude non-text content from the output. Default is False.
-        """
-        return self._set(excludeNonText=value)

sparknlp/reader/reader2table.py

@@ -32,20 +32,6 @@ class Reader2Table(
 
     outputAnnotatorType = AnnotatorType.DOCUMENT
 
-    flattenOutput = Param(
-        Params._dummy(),
-        "flattenOutput",
-        "If true, output is flattened to plain text with minimal metadata",
-        typeConverter=TypeConverters.toBoolean
-    )
-
-    titleThreshold = Param(
-        Params._dummy(),
-        "titleThreshold",
-        "Minimum font size threshold for title detection in PDF docs",
-        typeConverter=TypeConverters.toFloat
-    )
-
     @keyword_only
     def __init__(self):
         super(Reader2Table, self).__init__(classname="com.johnsnowlabs.reader.Reader2Table")
@@ -55,23 +41,3 @@ class Reader2Table(
     def setParams(self):
         kwargs = self._input_kwargs
         return self._set(**kwargs)
-
-    def setFlattenOutput(self, value):
-        """Sets whether to flatten the output to plain text with minimal metadata.
-
-        Parameters
-        ----------
-        value : bool
-            If true, output is flattened to plain text with minimal metadata
-        """
-        return self._set(flattenOutput=value)
-
-    def setTitleThreshold(self, value):
-        """Sets the minimum font size threshold for title detection in PDF documents.
-
-        Parameters
-        ----------
-        value : float
-            Minimum font size threshold for title detection in PDF docs
-        """
-        return self._set(titleThreshold=value)

sparknlp/reader/reader_assembler.py

@@ -0,0 +1,159 @@
+#  Copyright 2017-2025 John Snow Labs
+#
+#  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.
+
+from pyspark import keyword_only
+
+from sparknlp.common import AnnotatorType
+from sparknlp.internal import AnnotatorTransformer
+from sparknlp.partition.partition_properties import *
+
+class ReaderAssembler(
+    AnnotatorTransformer,
+    HasReaderProperties,
+    HasHTMLReaderProperties,
+    HasEmailReaderProperties,
+    HasExcelReaderProperties,
+    HasPowerPointProperties,
+    HasTextReaderProperties,
+    HasPdfProperties
+):
+    """
+    The ReaderAssembler annotator provides a unified interface for combining multiple Spark NLP
+    readers (such as Reader2Doc, Reader2Table, and Reader2Image) into a single, configurable
+    component. It automatically orchestrates the execution of different readers based on input type,
+    configured priorities, and fallback strategies allowing you to handle diverse content formats
+    without manually chaining multiple readers in your pipeline.
+
+    ReaderAssembler simplifies the process of building flexible pipelines capable of ingesting and
+    processing documents, tables, and images in a consistent way. It handles reader selection,
+    ordering, and fault-tolerance internally, ensuring that pipelines remain concise, robust, and
+    easy to maintain.
+
+    Examples
+    --------
+    >>> from johnsnowlabs.reader import ReaderAssembler
+    >>> from pyspark.ml import Pipeline
+    >>>
+    >>> reader_assembler = ReaderAssembler() \\
+    ...     .setContentType("text/html") \\
+    ...     .setContentPath("/table-image.html") \\
+    ...     .setOutputCol("document")
+    >>>
+    >>> pipeline = Pipeline(stages=[reader_assembler])
+    >>> pipeline_model = pipeline.fit(empty_data_set)
+    >>> result_df = pipeline_model.transform(empty_data_set)
+    >>>
+    >>> result_df.show()
+    +--------+--------------------+--------------------+--------------------+---------+
+    |fileName|       document_text|      document_table|      document_image|exception|
+    +--------+--------------------+--------------------+--------------------+---------+
+    |    null|[{'document', 0, 26...|[{'document', 0, 50...|[{'image', , 5, 5, ...|     null|
+    +--------+--------------------+--------------------+--------------------+---------+
+
+    This annotator is especially useful when working with heterogeneous input data — for example,
+    when a dataset includes PDFs, spreadsheets, and images — allowing Spark NLP to automatically
+    invoke the appropriate reader for each file type while preserving a unified schema in the output.
+"""
+
+
+    name = 'ReaderAssembler'
+
+    outputAnnotatorType = AnnotatorType.DOCUMENT
+
+    excludeNonText = Param(
+        Params._dummy(),
+        "excludeNonText",
+        "Whether to exclude non-text content from the output. Default is False.",
+        typeConverter=TypeConverters.toBoolean
+    )
+
+    userMessage = Param(
+        Params._dummy(),
+        "userMessage",
+        "Custom user message.",
+        typeConverter=TypeConverters.toString
+    )
+
+    promptTemplate = Param(
+        Params._dummy(),
+        "promptTemplate",
+        "Format of the output prompt.",
+        typeConverter=TypeConverters.toString
+    )
+
+    customPromptTemplate = Param(
+        Params._dummy(),
+        "customPromptTemplate",
+        "Custom prompt template for image models.",
+        typeConverter=TypeConverters.toString
+    )
+
+    @keyword_only
+    def __init__(self):
+        super(ReaderAssembler, self).__init__(classname="com.johnsnowlabs.reader.ReaderAssembler")
+        self._setDefault(contentType="",
+                         explodeDocs=False,
+                         userMessage="Describe this image",
+                         promptTemplate="qwen2vl-chat",
+                         readAsImage=True,
+                         customPromptTemplate="",
+                         ignoreExceptions=True,
+                         flattenOutput=False,
+                         titleThreshold=18)
+
+
+    @keyword_only
+    def setParams(self):
+        kwargs = self._input_kwargs
+        return self._set(**kwargs)
+
+    def setExcludeNonText(self, value):
+        """Sets whether to exclude non-text content from the output.
+
+        Parameters
+        ----------
+        value : bool
+            Whether to exclude non-text content from the output. Default is False.
+        """
+        return self._set(excludeNonText=value)
+
+    def setUserMessage(self, value: str):
+        """Sets custom user message.
+
+        Parameters
+        ----------
+        value : str
+            Custom user message to include.
+        """
+        return self._set(userMessage=value)
+
+    def setPromptTemplate(self, value: str):
+        """Sets format of the output prompt.
+
+        Parameters
+        ----------
+        value : str
+            Prompt template format.
+        """
+        return self._set(promptTemplate=value)
+
+    def setCustomPromptTemplate(self, value: str):
+        """Sets custom prompt template for image models.
+
+        Parameters
+        ----------
+        value : str
+            Custom prompt template string.
+        """
+        return self._set(customPromptTemplate=value)