# 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 Transliterate(ComplexParamsMixin, JavaMLReadable, JavaMLWritable, JavaTransformer):
"""
Args:
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
fromScript (object): Specifies the script of the input text.
handler (object): Which strategy to use when handling requests
language (object): Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.
outputCol (str): The name of the output column
subscriptionKey (object): the API key to use
subscriptionRegion (object): the API region to use
text (object): the string to translate
timeout (float): number of seconds to wait before closing the connection
toScript (object): Specifies the script of the translated text.
url (str): Url of the service
"""
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)
fromScript = Param(Params._dummy(), "fromScript", "ServiceParam: Specifies the script of the input text.")
handler = Param(Params._dummy(), "handler", "Which strategy to use when handling requests")
language = Param(Params._dummy(), "language", "ServiceParam: Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.")
outputCol = Param(Params._dummy(), "outputCol", "The name of the output column", typeConverter=TypeConverters.toString)
subscriptionKey = Param(Params._dummy(), "subscriptionKey", "ServiceParam: the API key to use")
subscriptionRegion = Param(Params._dummy(), "subscriptionRegion", "ServiceParam: the API region to use")
text = Param(Params._dummy(), "text", "ServiceParam: the string to translate")
timeout = Param(Params._dummy(), "timeout", "number of seconds to wait before closing the connection", typeConverter=TypeConverters.toFloat)
toScript = Param(Params._dummy(), "toScript", "ServiceParam: Specifies the script of the translated text.")
url = Param(Params._dummy(), "url", "Url of the service", typeConverter=TypeConverters.toString)
@keyword_only
def __init__(
self,
java_obj=None,
concurrency=1,
concurrentTimeout=None,
errorCol="Transliterate_0f6748921d49_error",
fromScript=None,
fromScriptCol=None,
handler=None,
language=None,
languageCol=None,
outputCol="Transliterate_0f6748921d49_output",
subscriptionKey=None,
subscriptionKeyCol=None,
subscriptionRegion=None,
subscriptionRegionCol=None,
text=None,
textCol=None,
timeout=60.0,
toScript=None,
toScriptCol=None,
url=None
):
super(Transliterate, self).__init__()
if java_obj is None:
self._java_obj = self._new_java_obj("com.microsoft.azure.synapse.ml.cognitive.Transliterate", self.uid)
else:
self._java_obj = java_obj
self._setDefault(concurrency=1)
self._setDefault(errorCol="Transliterate_0f6748921d49_error")
self._setDefault(outputCol="Transliterate_0f6748921d49_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,
concurrency=1,
concurrentTimeout=None,
errorCol="Transliterate_0f6748921d49_error",
fromScript=None,
fromScriptCol=None,
handler=None,
language=None,
languageCol=None,
outputCol="Transliterate_0f6748921d49_output",
subscriptionKey=None,
subscriptionKeyCol=None,
subscriptionRegion=None,
subscriptionRegionCol=None,
text=None,
textCol=None,
timeout=60.0,
toScript=None,
toScriptCol=None,
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.Transliterate"
@staticmethod
def _from_java(java_stage):
module_name=Transliterate.__module__
module_name=module_name.rsplit(".", 1)[0] + ".Transliterate"
return from_java(java_stage, module_name)
[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 setFromScript(self, value):
"""
Args:
fromScript: Specifies the script of the input text.
"""
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.setFromScript(value)
return self
[docs] def setFromScriptCol(self, value):
"""
Args:
fromScript: Specifies the script of the input text.
"""
self._java_obj = self._java_obj.setFromScriptCol(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 setLanguage(self, value):
"""
Args:
language: Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.
"""
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: Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.
"""
self._java_obj = self._java_obj.setLanguageCol(value)
return self
[docs] def setOutputCol(self, value):
"""
Args:
outputCol: The name of the output column
"""
self._set(outputCol=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 setSubscriptionRegion(self, value):
"""
Args:
subscriptionRegion: the API region 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.setSubscriptionRegion(value)
return self
[docs] def setSubscriptionRegionCol(self, value):
"""
Args:
subscriptionRegion: the API region to use
"""
self._java_obj = self._java_obj.setSubscriptionRegionCol(value)
return self
[docs] def setText(self, value):
"""
Args:
text: the string to translate
"""
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 string to translate
"""
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 setToScript(self, value):
"""
Args:
toScript: Specifies the script of the translated text.
"""
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.setToScript(value)
return self
[docs] def setToScriptCol(self, value):
"""
Args:
toScript: Specifies the script of the translated text.
"""
self._java_obj = self._java_obj.setToScriptCol(value)
return self
[docs] def setUrl(self, value):
"""
Args:
url: Url of the service
"""
self._set(url=value)
return self
[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 getFromScript(self):
"""
Returns:
fromScript: Specifies the script of the input text.
"""
return self._java_obj.getFromScript()
[docs] def getHandler(self):
"""
Returns:
handler: Which strategy to use when handling requests
"""
return self.getOrDefault(self.handler)
[docs] def getLanguage(self):
"""
Returns:
language: Language tag identifying the language of the input text. If a code is not specified, automatic language detection will be applied.
"""
return self._java_obj.getLanguage()
[docs] def getOutputCol(self):
"""
Returns:
outputCol: The name of the output column
"""
return self.getOrDefault(self.outputCol)
[docs] def getSubscriptionKey(self):
"""
Returns:
subscriptionKey: the API key to use
"""
return self._java_obj.getSubscriptionKey()
[docs] def getSubscriptionRegion(self):
"""
Returns:
subscriptionRegion: the API region to use
"""
return self._java_obj.getSubscriptionRegion()
[docs] def getText(self):
"""
Returns:
text: the string to translate
"""
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 getToScript(self):
"""
Returns:
toScript: Specifies the script of the translated text.
"""
return self._java_obj.getToScript()
[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