Source code for synapse.ml.cognitive.AnalyzeIDDocuments

# Copyright (C) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE in project root for information.


import sys
if sys.version >= '3':
    basestring = str

from pyspark import SparkContext, SQLContext
from pyspark.sql import DataFrame
from pyspark.ml.param.shared import *
from pyspark import keyword_only
from pyspark.ml.util import JavaMLReadable, JavaMLWritable
from synapse.ml.core.serialize.java_params_patch import *
from pyspark.ml.wrapper import JavaTransformer, JavaEstimator, JavaModel
from pyspark.ml.evaluation import JavaEvaluator
from pyspark.ml.common import inherit_doc
from synapse.ml.core.schema.Utils import *
from pyspark.ml.param import TypeConverters
from synapse.ml.core.schema.TypeConversionUtils import generateTypeConverter, complexTypeConverter


[docs]@inherit_doc class AnalyzeIDDocuments(ComplexParamsMixin, JavaMLReadable, JavaMLWritable, JavaTransformer): """ Args: backoffs (list): array of backoffs to use in the handler concurrency (int): max number of concurrent calls concurrentTimeout (float): max number seconds to wait on futures if concurrency >= 1 errorCol (str): column to hold http errors imageBytes (object): bytestream of the image to use imageUrl (object): the url of the image to use includeTextDetails (object): Include text lines and element references in the result. initialPollingDelay (int): number of milliseconds to wait before first poll for result maxPollingRetries (int): number of times to poll modelVersion (object): This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. outputCol (str): The name of the output column pages (object): The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed. pollingDelay (int): number of milliseconds to wait between polling subscriptionKey (object): the API key to use suppressMaxRetriesExceededException (bool): set true to suppress the maxumimum retries exception and report in the error column timeout (float): number of seconds to wait before closing the connection url (str): Url of the service """ backoffs = Param(Params._dummy(), "backoffs", "array of backoffs to use in the handler", typeConverter=TypeConverters.toListInt) concurrency = Param(Params._dummy(), "concurrency", "max number of concurrent calls", typeConverter=TypeConverters.toInt) concurrentTimeout = Param(Params._dummy(), "concurrentTimeout", "max number seconds to wait on futures if concurrency >= 1", typeConverter=TypeConverters.toFloat) errorCol = Param(Params._dummy(), "errorCol", "column to hold http errors", typeConverter=TypeConverters.toString) imageBytes = Param(Params._dummy(), "imageBytes", "ServiceParam: bytestream of the image to use") imageUrl = Param(Params._dummy(), "imageUrl", "ServiceParam: the url of the image to use") includeTextDetails = Param(Params._dummy(), "includeTextDetails", "ServiceParam: Include text lines and element references in the result.") initialPollingDelay = Param(Params._dummy(), "initialPollingDelay", "number of milliseconds to wait before first poll for result", typeConverter=TypeConverters.toInt) maxPollingRetries = Param(Params._dummy(), "maxPollingRetries", "number of times to poll", typeConverter=TypeConverters.toInt) modelVersion = Param(Params._dummy(), "modelVersion", "ServiceParam: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.") outputCol = Param(Params._dummy(), "outputCol", "The name of the output column", typeConverter=TypeConverters.toString) pages = Param(Params._dummy(), "pages", "ServiceParam: The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed.") pollingDelay = Param(Params._dummy(), "pollingDelay", "number of milliseconds to wait between polling", typeConverter=TypeConverters.toInt) subscriptionKey = Param(Params._dummy(), "subscriptionKey", "ServiceParam: the API key to use") suppressMaxRetriesExceededException = Param(Params._dummy(), "suppressMaxRetriesExceededException", "set true to suppress the maxumimum retries exception and report in the error column", typeConverter=TypeConverters.toBoolean) timeout = Param(Params._dummy(), "timeout", "number of seconds to wait before closing the connection", typeConverter=TypeConverters.toFloat) url = Param(Params._dummy(), "url", "Url of the service", typeConverter=TypeConverters.toString) @keyword_only def __init__( self, java_obj=None, backoffs=[100,500,1000], concurrency=1, concurrentTimeout=None, errorCol="AnalyzeIDDocuments_d43966693cb6_error", imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, includeTextDetails=None, includeTextDetailsCol=None, initialPollingDelay=300, maxPollingRetries=1000, modelVersion=None, modelVersionCol=None, outputCol="AnalyzeIDDocuments_d43966693cb6_output", pages=None, pagesCol=None, pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesExceededException=False, timeout=60.0, url=None ): super(AnalyzeIDDocuments, self).__init__() if java_obj is None: self._java_obj = self._new_java_obj("com.microsoft.azure.synapse.ml.cognitive.AnalyzeIDDocuments", self.uid) else: self._java_obj = java_obj self._setDefault(backoffs=[100,500,1000]) self._setDefault(concurrency=1) self._setDefault(errorCol="AnalyzeIDDocuments_d43966693cb6_error") self._setDefault(initialPollingDelay=300) self._setDefault(maxPollingRetries=1000) self._setDefault(outputCol="AnalyzeIDDocuments_d43966693cb6_output") self._setDefault(pollingDelay=300) self._setDefault(suppressMaxRetriesExceededException=False) self._setDefault(timeout=60.0) if hasattr(self, "_input_kwargs"): kwargs = self._input_kwargs else: kwargs = self.__init__._input_kwargs if java_obj is None: for k,v in kwargs.items(): if v is not None: getattr(self, "set" + k[0].upper() + k[1:])(v)
[docs] @keyword_only def setParams( self, backoffs=[100,500,1000], concurrency=1, concurrentTimeout=None, errorCol="AnalyzeIDDocuments_d43966693cb6_error", imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, includeTextDetails=None, includeTextDetailsCol=None, initialPollingDelay=300, maxPollingRetries=1000, modelVersion=None, modelVersionCol=None, outputCol="AnalyzeIDDocuments_d43966693cb6_output", pages=None, pagesCol=None, pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesExceededException=False, timeout=60.0, url=None ): """ Set the (keyword only) parameters """ if hasattr(self, "_input_kwargs"): kwargs = self._input_kwargs else: kwargs = self.__init__._input_kwargs return self._set(**kwargs)
[docs] @classmethod def read(cls): """ Returns an MLReader instance for this class. """ return JavaMMLReader(cls)
[docs] @staticmethod def getJavaPackage(): """ Returns package name String. """ return "com.microsoft.azure.synapse.ml.cognitive.AnalyzeIDDocuments"
@staticmethod def _from_java(java_stage): module_name=AnalyzeIDDocuments.__module__ module_name=module_name.rsplit(".", 1)[0] + ".AnalyzeIDDocuments" return from_java(java_stage, module_name)
[docs] def setBackoffs(self, value): """ Args: backoffs: array of backoffs to use in the handler """ self._set(backoffs=value) return self
[docs] def setConcurrency(self, value): """ Args: concurrency: max number of concurrent calls """ self._set(concurrency=value) return self
[docs] def setConcurrentTimeout(self, value): """ Args: concurrentTimeout: max number seconds to wait on futures if concurrency >= 1 """ self._set(concurrentTimeout=value) return self
[docs] def setErrorCol(self, value): """ Args: errorCol: column to hold http errors """ self._set(errorCol=value) return self
[docs] def setImageBytes(self, value): """ Args: imageBytes: bytestream of the image to use """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setImageBytes(value) return self
[docs] def setImageBytesCol(self, value): """ Args: imageBytes: bytestream of the image to use """ self._java_obj = self._java_obj.setImageBytesCol(value) return self
[docs] def setImageUrl(self, value): """ Args: imageUrl: the url of the image to use """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setImageUrl(value) return self
[docs] def setImageUrlCol(self, value): """ Args: imageUrl: the url of the image to use """ self._java_obj = self._java_obj.setImageUrlCol(value) return self
[docs] def setIncludeTextDetails(self, value): """ Args: includeTextDetails: Include text lines and element references in the result. """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setIncludeTextDetails(value) return self
[docs] def setIncludeTextDetailsCol(self, value): """ Args: includeTextDetails: Include text lines and element references in the result. """ self._java_obj = self._java_obj.setIncludeTextDetailsCol(value) return self
[docs] def setInitialPollingDelay(self, value): """ Args: initialPollingDelay: number of milliseconds to wait before first poll for result """ self._set(initialPollingDelay=value) return self
[docs] def setMaxPollingRetries(self, value): """ Args: maxPollingRetries: number of times to poll """ self._set(maxPollingRetries=value) return self
[docs] def setModelVersion(self, value): """ Args: modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setModelVersion(value) return self
[docs] def setModelVersionCol(self, value): """ Args: modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. """ self._java_obj = self._java_obj.setModelVersionCol(value) return self
[docs] def setOutputCol(self, value): """ Args: outputCol: The name of the output column """ self._set(outputCol=value) return self
[docs] def setPages(self, value): """ Args: pages: The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed. """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setPages(value) return self
[docs] def setPagesCol(self, value): """ Args: pages: The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed. """ self._java_obj = self._java_obj.setPagesCol(value) return self
[docs] def setPollingDelay(self, value): """ Args: pollingDelay: number of milliseconds to wait between polling """ self._set(pollingDelay=value) return self
[docs] def setSubscriptionKey(self, value): """ Args: subscriptionKey: the API key to use """ if isinstance(value, list): value = SparkContext._active_spark_context._jvm.com.microsoft.azure.synapse.ml.param.ServiceParam.toSeq(value) self._java_obj = self._java_obj.setSubscriptionKey(value) return self
[docs] def setSubscriptionKeyCol(self, value): """ Args: subscriptionKey: the API key to use """ self._java_obj = self._java_obj.setSubscriptionKeyCol(value) return self
[docs] def setSuppressMaxRetriesExceededException(self, value): """ Args: suppressMaxRetriesExceededException: set true to suppress the maxumimum retries exception and report in the error column """ self._set(suppressMaxRetriesExceededException=value) return self
[docs] def setTimeout(self, value): """ Args: timeout: number of seconds to wait before closing the connection """ self._set(timeout=value) return self
[docs] def setUrl(self, value): """ Args: url: Url of the service """ self._set(url=value) return self
[docs] def getBackoffs(self): """ Returns: backoffs: array of backoffs to use in the handler """ return self.getOrDefault(self.backoffs)
[docs] def getConcurrency(self): """ Returns: concurrency: max number of concurrent calls """ return self.getOrDefault(self.concurrency)
[docs] def getConcurrentTimeout(self): """ Returns: concurrentTimeout: max number seconds to wait on futures if concurrency >= 1 """ return self.getOrDefault(self.concurrentTimeout)
[docs] def getErrorCol(self): """ Returns: errorCol: column to hold http errors """ return self.getOrDefault(self.errorCol)
[docs] def getImageBytes(self): """ Returns: imageBytes: bytestream of the image to use """ return self._java_obj.getImageBytes()
[docs] def getImageUrl(self): """ Returns: imageUrl: the url of the image to use """ return self._java_obj.getImageUrl()
[docs] def getIncludeTextDetails(self): """ Returns: includeTextDetails: Include text lines and element references in the result. """ return self._java_obj.getIncludeTextDetails()
[docs] def getInitialPollingDelay(self): """ Returns: initialPollingDelay: number of milliseconds to wait before first poll for result """ return self.getOrDefault(self.initialPollingDelay)
[docs] def getMaxPollingRetries(self): """ Returns: maxPollingRetries: number of times to poll """ return self.getOrDefault(self.maxPollingRetries)
[docs] def getModelVersion(self): """ Returns: modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version. """ return self._java_obj.getModelVersion()
[docs] def getOutputCol(self): """ Returns: outputCol: The name of the output column """ return self.getOrDefault(self.outputCol)
[docs] def getPages(self): """ Returns: pages: The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed. """ return self._java_obj.getPages()
[docs] def getPollingDelay(self): """ Returns: pollingDelay: number of milliseconds to wait between polling """ return self.getOrDefault(self.pollingDelay)
[docs] def getSubscriptionKey(self): """ Returns: subscriptionKey: the API key to use """ return self._java_obj.getSubscriptionKey()
[docs] def getSuppressMaxRetriesExceededException(self): """ Returns: suppressMaxRetriesExceededException: set true to suppress the maxumimum retries exception and report in the error column """ return self.getOrDefault(self.suppressMaxRetriesExceededException)
[docs] def getTimeout(self): """ Returns: timeout: number of seconds to wait before closing the connection """ return self.getOrDefault(self.timeout)
[docs] def getUrl(self): """ Returns: url: Url of the service """ return self.getOrDefault(self.url)
[docs] def setLocation(self, value): self._java_obj = self._java_obj.setLocation(value) return self
[docs] def setLinkedService(self, value): self._java_obj = self._java_obj.setLinkedService(value) return self