# 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.platform import running_on_synapse_internal
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 AnalyzeText(ComplexParamsMixin, JavaMLReadable, JavaMLWritable, JavaTransformer):
"""
Args:
AADToken (object): AAD Token used for authentication
apiVersion (object): version of the api
batchSize (int): The max size of the buffer
concurrency (int): max number of concurrent calls
concurrentTimeout (float): max number seconds to wait on futures if concurrency >= 1
countryHint (object): the countryHint for language detection
domain (object): if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
errorCol (str): column to hold http errors
handler (object): Which strategy to use when handling requests
kind (str): Enumeration of supported Text Analysis tasks
language (object): the language code of the text (optional for some services)
loggingOptOut (object): loggingOptOut for task
modelVersion (object): Version of the model
opinionMining (object): opinionMining option for SentimentAnalysisTask
outputCol (str): The name of the output column
piiCategories (object): describes the PII categories to return
showStats (object): Whether to include detailed statistics in the response
stringIndexType (object): Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
subscriptionKey (object): the API key to use
text (object): the text in the request body
timeout (float): number of seconds to wait before closing the connection
url (str): Url of the service
"""
AADToken = Param(Params._dummy(), "AADToken", "ServiceParam: AAD Token used for authentication")
apiVersion = Param(Params._dummy(), "apiVersion", "ServiceParam: version of the api")
batchSize = Param(Params._dummy(), "batchSize", "The max size of the buffer", typeConverter=TypeConverters.toInt)
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)
countryHint = Param(Params._dummy(), "countryHint", "ServiceParam: the countryHint for language detection")
domain = Param(Params._dummy(), "domain", "ServiceParam: if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.")
errorCol = Param(Params._dummy(), "errorCol", "column to hold http errors", typeConverter=TypeConverters.toString)
handler = Param(Params._dummy(), "handler", "Which strategy to use when handling requests")
kind = Param(Params._dummy(), "kind", "Enumeration of supported Text Analysis tasks", typeConverter=TypeConverters.toString)
language = Param(Params._dummy(), "language", "ServiceParam: the language code of the text (optional for some services)")
loggingOptOut = Param(Params._dummy(), "loggingOptOut", "ServiceParam: loggingOptOut for task")
modelVersion = Param(Params._dummy(), "modelVersion", "ServiceParam: Version of the model")
opinionMining = Param(Params._dummy(), "opinionMining", "ServiceParam: opinionMining option for SentimentAnalysisTask")
outputCol = Param(Params._dummy(), "outputCol", "The name of the output column", typeConverter=TypeConverters.toString)
piiCategories = Param(Params._dummy(), "piiCategories", "ServiceParam: describes the PII categories to return")
showStats = Param(Params._dummy(), "showStats", "ServiceParam: Whether to include detailed statistics in the response")
stringIndexType = Param(Params._dummy(), "stringIndexType", "ServiceParam: Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets")
subscriptionKey = Param(Params._dummy(), "subscriptionKey", "ServiceParam: the API key to use")
text = Param(Params._dummy(), "text", "ServiceParam: the text in the request body")
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,
AADToken=None,
AADTokenCol=None,
apiVersion=None,
apiVersionCol=None,
batchSize=10,
concurrency=1,
concurrentTimeout=None,
countryHint=None,
countryHintCol=None,
domain=None,
domainCol=None,
errorCol="AnalyzeText_cc7f64df9498_error",
handler=None,
kind=None,
language=None,
languageCol=None,
loggingOptOut=None,
loggingOptOutCol=None,
modelVersion=None,
modelVersionCol=None,
opinionMining=None,
opinionMiningCol=None,
outputCol="AnalyzeText_cc7f64df9498_output",
piiCategories=None,
piiCategoriesCol=None,
showStats=None,
showStatsCol=None,
stringIndexType=None,
stringIndexTypeCol=None,
subscriptionKey=None,
subscriptionKeyCol=None,
text=None,
textCol=None,
timeout=60.0,
url=None
):
super(AnalyzeText, self).__init__()
if java_obj is None:
self._java_obj = self._new_java_obj("com.microsoft.azure.synapse.ml.cognitive.language.AnalyzeText", self.uid)
else:
self._java_obj = java_obj
self._setDefault(batchSize=10)
self._setDefault(concurrency=1)
self._setDefault(errorCol="AnalyzeText_cc7f64df9498_error")
self._setDefault(outputCol="AnalyzeText_cc7f64df9498_output")
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,
AADToken=None,
AADTokenCol=None,
apiVersion=None,
apiVersionCol=None,
batchSize=10,
concurrency=1,
concurrentTimeout=None,
countryHint=None,
countryHintCol=None,
domain=None,
domainCol=None,
errorCol="AnalyzeText_cc7f64df9498_error",
handler=None,
kind=None,
language=None,
languageCol=None,
loggingOptOut=None,
loggingOptOutCol=None,
modelVersion=None,
modelVersionCol=None,
opinionMining=None,
opinionMiningCol=None,
outputCol="AnalyzeText_cc7f64df9498_output",
piiCategories=None,
piiCategoriesCol=None,
showStats=None,
showStatsCol=None,
stringIndexType=None,
stringIndexTypeCol=None,
subscriptionKey=None,
subscriptionKeyCol=None,
text=None,
textCol=None,
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.language.AnalyzeText"
@staticmethod
def _from_java(java_stage):
module_name=AnalyzeText.__module__
module_name=module_name.rsplit(".", 1)[0] + ".AnalyzeText"
return from_java(java_stage, module_name)
[docs] def setAADToken(self, value):
"""
Args:
AADToken: AAD Token used for authentication
"""
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.setAADToken(value)
return self
[docs] def setAADTokenCol(self, value):
"""
Args:
AADToken: AAD Token used for authentication
"""
self._java_obj = self._java_obj.setAADTokenCol(value)
return self
[docs] def setApiVersion(self, value):
"""
Args:
apiVersion: version of the api
"""
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.setApiVersion(value)
return self
[docs] def setApiVersionCol(self, value):
"""
Args:
apiVersion: version of the api
"""
self._java_obj = self._java_obj.setApiVersionCol(value)
return self
[docs] def setBatchSize(self, value):
"""
Args:
batchSize: The max size of the buffer
"""
self._set(batchSize=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 setCountryHint(self, value):
"""
Args:
countryHint: the countryHint for language detection
"""
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.setCountryHint(value)
return self
[docs] def setCountryHintCol(self, value):
"""
Args:
countryHint: the countryHint for language detection
"""
self._java_obj = self._java_obj.setCountryHintCol(value)
return self
[docs] def setDomain(self, value):
"""
Args:
domain: if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
"""
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.setDomain(value)
return self
[docs] def setDomainCol(self, value):
"""
Args:
domain: if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
"""
self._java_obj = self._java_obj.setDomainCol(value)
return self
[docs] def setErrorCol(self, value):
"""
Args:
errorCol: column to hold http errors
"""
self._set(errorCol=value)
return self
[docs] def setHandler(self, value):
"""
Args:
handler: Which strategy to use when handling requests
"""
self._set(handler=value)
return self
[docs] def setKind(self, value):
"""
Args:
kind: Enumeration of supported Text Analysis tasks
"""
self._set(kind=value)
return self
[docs] def setLanguage(self, value):
"""
Args:
language: the language code of the text (optional for some services)
"""
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.setLanguage(value)
return self
[docs] def setLanguageCol(self, value):
"""
Args:
language: the language code of the text (optional for some services)
"""
self._java_obj = self._java_obj.setLanguageCol(value)
return self
[docs] def setLoggingOptOut(self, value):
"""
Args:
loggingOptOut: loggingOptOut for task
"""
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.setLoggingOptOut(value)
return self
[docs] def setLoggingOptOutCol(self, value):
"""
Args:
loggingOptOut: loggingOptOut for task
"""
self._java_obj = self._java_obj.setLoggingOptOutCol(value)
return self
[docs] def setModelVersion(self, value):
"""
Args:
modelVersion: Version of the model
"""
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: Version of the model
"""
self._java_obj = self._java_obj.setModelVersionCol(value)
return self
[docs] def setOpinionMining(self, value):
"""
Args:
opinionMining: opinionMining option for SentimentAnalysisTask
"""
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.setOpinionMining(value)
return self
[docs] def setOpinionMiningCol(self, value):
"""
Args:
opinionMining: opinionMining option for SentimentAnalysisTask
"""
self._java_obj = self._java_obj.setOpinionMiningCol(value)
return self
[docs] def setOutputCol(self, value):
"""
Args:
outputCol: The name of the output column
"""
self._set(outputCol=value)
return self
[docs] def setPiiCategories(self, value):
"""
Args:
piiCategories: describes the PII categories to return
"""
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.setPiiCategories(value)
return self
[docs] def setPiiCategoriesCol(self, value):
"""
Args:
piiCategories: describes the PII categories to return
"""
self._java_obj = self._java_obj.setPiiCategoriesCol(value)
return self
[docs] def setShowStats(self, value):
"""
Args:
showStats: Whether to include detailed statistics in the response
"""
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.setShowStats(value)
return self
[docs] def setShowStatsCol(self, value):
"""
Args:
showStats: Whether to include detailed statistics in the response
"""
self._java_obj = self._java_obj.setShowStatsCol(value)
return self
[docs] def setStringIndexType(self, value):
"""
Args:
stringIndexType: Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
"""
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.setStringIndexType(value)
return self
[docs] def setStringIndexTypeCol(self, value):
"""
Args:
stringIndexType: Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
"""
self._java_obj = self._java_obj.setStringIndexTypeCol(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 setText(self, value):
"""
Args:
text: the text in the request body
"""
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.setText(value)
return self
[docs] def setTextCol(self, value):
"""
Args:
text: the text in the request body
"""
self._java_obj = self._java_obj.setTextCol(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 getAADToken(self):
"""
Returns:
AADToken: AAD Token used for authentication
"""
return self._java_obj.getAADToken()
[docs] def getApiVersion(self):
"""
Returns:
apiVersion: version of the api
"""
return self._java_obj.getApiVersion()
[docs] def getBatchSize(self):
"""
Returns:
batchSize: The max size of the buffer
"""
return self.getOrDefault(self.batchSize)
[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 getCountryHint(self):
"""
Returns:
countryHint: the countryHint for language detection
"""
return self._java_obj.getCountryHint()
[docs] def getDomain(self):
"""
Returns:
domain: if specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'PHI', 'none'.
"""
return self._java_obj.getDomain()
[docs] def getErrorCol(self):
"""
Returns:
errorCol: column to hold http errors
"""
return self.getOrDefault(self.errorCol)
[docs] def getHandler(self):
"""
Returns:
handler: Which strategy to use when handling requests
"""
return self.getOrDefault(self.handler)
[docs] def getKind(self):
"""
Returns:
kind: Enumeration of supported Text Analysis tasks
"""
return self.getOrDefault(self.kind)
[docs] def getLanguage(self):
"""
Returns:
language: the language code of the text (optional for some services)
"""
return self._java_obj.getLanguage()
[docs] def getLoggingOptOut(self):
"""
Returns:
loggingOptOut: loggingOptOut for task
"""
return self._java_obj.getLoggingOptOut()
[docs] def getModelVersion(self):
"""
Returns:
modelVersion: Version of the model
"""
return self._java_obj.getModelVersion()
[docs] def getOpinionMining(self):
"""
Returns:
opinionMining: opinionMining option for SentimentAnalysisTask
"""
return self._java_obj.getOpinionMining()
[docs] def getOutputCol(self):
"""
Returns:
outputCol: The name of the output column
"""
return self.getOrDefault(self.outputCol)
[docs] def getPiiCategories(self):
"""
Returns:
piiCategories: describes the PII categories to return
"""
return self._java_obj.getPiiCategories()
[docs] def getShowStats(self):
"""
Returns:
showStats: Whether to include detailed statistics in the response
"""
return self._java_obj.getShowStats()
[docs] def getStringIndexType(self):
"""
Returns:
stringIndexType: Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets
"""
return self._java_obj.getStringIndexType()
[docs] def getSubscriptionKey(self):
"""
Returns:
subscriptionKey: the API key to use
"""
return self._java_obj.getSubscriptionKey()
[docs] def getText(self):
"""
Returns:
text: the text in the request body
"""
return self._java_obj.getText()
[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 setCustomServiceName(self, value):
self._java_obj = self._java_obj.setCustomServiceName(value)
return self
[docs] def setEndpoint(self, value):
self._java_obj = self._java_obj.setEndpoint(value)
return self
def _transform(self, dataset: DataFrame) -> DataFrame:
if running_on_synapse_internal():
from synapse.ml.mlflow import get_mlflow_env_config
mlflow_env_configs = get_mlflow_env_config()
self.setAADToken(mlflow_env_configs.driver_aad_token)
self.setEndpoint(mlflow_env_configs.workload_endpoint + "/cognitive/api/")
return super()._transform(dataset)
[docs] def setLocation(self, value):
self._java_obj = self._java_obj.setLocation(value)
return self