synapse.ml.cognitive.vision package

Submodules

synapse.ml.cognitive.vision.AnalyzeImage module

class synapse.ml.cognitive.vision.AnalyzeImage.AnalyzeImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, descriptionExclude=None, descriptionExcludeCol=None, details=None, detailsCol=None, errorCol='AnalyzeImage_02887d2c4fba_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='AnalyzeImage_02887d2c4fba_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, visualFeatures=None, visualFeaturesCol=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
concurrency¶ (int) – max number of concurrent calls
concurrentTimeout¶ (float) – max number seconds to wait on futures if concurrency >= 1
descriptionExclude¶ (object) – Whether to exclude certain parts of the model in the description
details¶ (object) – what visual feature types to return
errorCol¶ (str) – column to hold http errors
handler¶ (object) – Which strategy to use when handling requests
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
language¶ (object) – the language of the response (en if none given)
outputCol¶ (str) – The name of the output column
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service
visualFeatures¶ (object) – what visual feature types to return

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

descriptionExclude = Param(parent='undefined', name='descriptionExclude', doc='ServiceParam: Whether to exclude certain parts of the model in the description')

details = Param(parent='undefined', name='details', doc='ServiceParam: what visual feature types to return')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getDescriptionExclude()[source]

Returns: Whether to exclude certain parts of the model in the description
Return type: descriptionExclude

getDetails()[source]

Returns: what visual feature types to return
Return type: details

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getLanguage()[source]

Returns: the language of the response (en if none given)
Return type: language

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

getVisualFeatures()[source]

Returns: what visual feature types to return
Return type: visualFeatures

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

language = Param(parent='undefined', name='language', doc='ServiceParam: the language of the response (en if none given)')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setDescriptionExclude(value)[source]

Parameters: descriptionExclude¶ – Whether to exclude certain parts of the model in the description

setDescriptionExcludeCol(value)[source]

Parameters: descriptionExclude¶ – Whether to exclude certain parts of the model in the description

setDetails(value)[source]

Parameters: details¶ – what visual feature types to return

setDetailsCol(value)[source]

Parameters: details¶ – what visual feature types to return

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLanguage(value)[source]

Parameters: language¶ – the language of the response (en if none given)

setLanguageCol(value)[source]

Parameters: language¶ – the language of the response (en if none given)

setLinkedService(value)[source]

setLocation(value)[source]

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, descriptionExclude=None, descriptionExcludeCol=None, details=None, detailsCol=None, errorCol='AnalyzeImage_02887d2c4fba_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='AnalyzeImage_02887d2c4fba_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, visualFeatures=None, visualFeaturesCol=None)[source]: Set the (keyword only) parameters

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

setVisualFeatures(value)[source]

Parameters: visualFeatures¶ – what visual feature types to return

setVisualFeaturesCol(value)[source]

Parameters: visualFeatures¶ – what visual feature types to return

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

visualFeatures = Param(parent='undefined', name='visualFeatures', doc='ServiceParam: what visual feature types to return')

synapse.ml.cognitive.vision.DescribeImage module

class synapse.ml.cognitive.vision.DescribeImage.DescribeImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='DescribeImage_82de6aa85391_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, maxCandidates=None, maxCandidatesCol=None, outputCol='DescribeImage_82de6aa85391_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
handler¶ (object) – Which strategy to use when handling requests
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
language¶ (object) – Language of image description
maxCandidates¶ (object) – Maximum candidate descriptions to return
outputCol¶ (str) – The name of the output column
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getLanguage()[source]

Returns: Language of image description
Return type: language

getMaxCandidates()[source]

Returns: Maximum candidate descriptions to return
Return type: maxCandidates

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

language = Param(parent='undefined', name='language', doc='ServiceParam: Language of image description')

maxCandidates = Param(parent='undefined', name='maxCandidates', doc='ServiceParam: Maximum candidate descriptions to return')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLanguage(value)[source]

Parameters: language¶ – Language of image description

setLanguageCol(value)[source]

Parameters: language¶ – Language of image description

setLinkedService(value)[source]

setLocation(value)[source]

setMaxCandidates(value)[source]

Parameters: maxCandidates¶ – Maximum candidate descriptions to return

setMaxCandidatesCol(value)[source]

Parameters: maxCandidates¶ – Maximum candidate descriptions to return

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='DescribeImage_82de6aa85391_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, maxCandidates=None, maxCandidatesCol=None, outputCol='DescribeImage_82de6aa85391_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

synapse.ml.cognitive.vision.GenerateThumbnails module

class synapse.ml.cognitive.vision.GenerateThumbnails.GenerateThumbnails(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='GenerateThumbnails_233e0270bb22_error', handler=None, height=None, heightCol=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, outputCol='GenerateThumbnails_233e0270bb22_output', smartCropping=None, smartCroppingCol=None, subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, width=None, widthCol=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
handler¶ (object) – Which strategy to use when handling requests
height¶ (object) – the desired height of the image
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
outputCol¶ (str) – The name of the output column
smartCropping¶ (object) – whether to intelligently crop the image
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service
width¶ (object) – the desired width of the image

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getHeight()[source]

Returns: the desired height of the image
Return type: height

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSmartCropping()[source]

Returns: whether to intelligently crop the image
Return type: smartCropping

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

getWidth()[source]

Returns: the desired width of the image
Return type: width

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

height = Param(parent='undefined', name='height', doc='ServiceParam: the desired height of the image')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setHeight(value)[source]

Parameters: height¶ – the desired height of the image

setHeightCol(value)[source]

Parameters: height¶ – the desired height of the image

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLinkedService(value)[source]

setLocation(value)[source]

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='GenerateThumbnails_233e0270bb22_error', handler=None, height=None, heightCol=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, outputCol='GenerateThumbnails_233e0270bb22_output', smartCropping=None, smartCroppingCol=None, subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, width=None, widthCol=None)[source]: Set the (keyword only) parameters

setSmartCropping(value)[source]

Parameters: smartCropping¶ – whether to intelligently crop the image

setSmartCroppingCol(value)[source]

Parameters: smartCropping¶ – whether to intelligently crop the image

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

setWidth(value)[source]

Parameters: width¶ – the desired width of the image

setWidthCol(value)[source]

Parameters: width¶ – the desired width of the image

smartCropping = Param(parent='undefined', name='smartCropping', doc='ServiceParam: whether to intelligently crop the image')

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

width = Param(parent='undefined', name='width', doc='ServiceParam: the desired width of the image')

synapse.ml.cognitive.vision.OCR module

class synapse.ml.cognitive.vision.OCR.OCR(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, detectOrientation=None, detectOrientationCol=None, errorCol='OCR_c589046d2e96_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='OCR_c589046d2e96_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
concurrency¶ (int) – max number of concurrent calls
concurrentTimeout¶ (float) – max number seconds to wait on futures if concurrency >= 1
detectOrientation¶ (object) – whether to detect image orientation prior to processing
errorCol¶ (str) – column to hold http errors
handler¶ (object) – Which strategy to use when handling requests
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
language¶ (object) – the language to use
outputCol¶ (str) – The name of the output column
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

detectOrientation = Param(parent='undefined', name='detectOrientation', doc='ServiceParam: whether to detect image orientation prior to processing')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getDetectOrientation()[source]

Returns: whether to detect image orientation prior to processing
Return type: detectOrientation

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getLanguage()[source]

Returns: the language to use
Return type: language

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

language = Param(parent='undefined', name='language', doc='ServiceParam: the language to use')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setDetectOrientation(value)[source]

Parameters: detectOrientation¶ – whether to detect image orientation prior to processing

setDetectOrientationCol(value)[source]

Parameters: detectOrientation¶ – whether to detect image orientation prior to processing

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLanguage(value)[source]

Parameters: language¶ – the language to use

setLanguageCol(value)[source]

Parameters: language¶ – the language to use

setLinkedService(value)[source]

setLocation(value)[source]

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, detectOrientation=None, detectOrientationCol=None, errorCol='OCR_c589046d2e96_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='OCR_c589046d2e96_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

synapse.ml.cognitive.vision.ReadImage module

class synapse.ml.cognitive.vision.ReadImage.ReadImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, backoffs=[100, 500, 1000], concurrency=1, concurrentTimeout=None, errorCol='ReadImage_00ec4eaf6d8f_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, language=None, languageCol=None, maxPollingRetries=1000, outputCol='ReadImage_00ec4eaf6d8f_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
initialPollingDelay¶ (int) – number of milliseconds to wait before first poll for result
language¶ (object) – IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language.
maxPollingRetries¶ (int) – number of times to poll
outputCol¶ (str) – The name of the output column
pollingDelay¶ (int) – number of milliseconds to wait between polling
subscriptionKey¶ (object) – the API key to use
suppressMaxRetriesException¶ (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

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

backoffs = Param(parent='undefined', name='backoffs', doc='array of backoffs to use in the handler')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getBackoffs()[source]

Returns: array of backoffs to use in the handler
Return type: backoffs

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

getInitialPollingDelay()[source]

Returns: number of milliseconds to wait before first poll for result
Return type: initialPollingDelay

static getJavaPackage()[source]: Returns package name String.

getLanguage()[source]

Returns: IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language.
Return type: language

getMaxPollingRetries()[source]

Returns: number of times to poll
Return type: maxPollingRetries

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getPollingDelay()[source]

Returns: number of milliseconds to wait between polling
Return type: pollingDelay

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getSuppressMaxRetriesException()[source]

Returns: set true to suppress the maxumimum retries exception and report in the error column
Return type: suppressMaxRetriesException

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

initialPollingDelay = Param(parent='undefined', name='initialPollingDelay', doc='number of milliseconds to wait before first poll for result')

language = Param(parent='undefined', name='language', doc='ServiceParam: IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language.')

maxPollingRetries = Param(parent='undefined', name='maxPollingRetries', doc='number of times to poll')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

pollingDelay = Param(parent='undefined', name='pollingDelay', doc='number of milliseconds to wait between polling')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setBackoffs(value)[source]

Parameters: backoffs¶ – array of backoffs to use in the handler

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setInitialPollingDelay(value)[source]

Parameters: initialPollingDelay¶ – number of milliseconds to wait before first poll for result

setLanguage(value)[source]

Parameters: language¶ – IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language.

setLanguageCol(value)[source]

Parameters: language¶ – IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read supports auto language identification and multilanguage documents, so only provide a language code if you would like to force the documented to be processed as that specific language.

setLinkedService(value)[source]

setLocation(value)[source]

setMaxPollingRetries(value)[source]

Parameters: maxPollingRetries¶ – number of times to poll

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, backoffs=[100, 500, 1000], concurrency=1, concurrentTimeout=None, errorCol='ReadImage_00ec4eaf6d8f_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, language=None, languageCol=None, maxPollingRetries=1000, outputCol='ReadImage_00ec4eaf6d8f_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setPollingDelay(value)[source]

Parameters: pollingDelay¶ – number of milliseconds to wait between polling

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSuppressMaxRetriesException(value)[source]

Parameters: suppressMaxRetriesException¶ – set true to suppress the maxumimum retries exception and report in the error column

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

suppressMaxRetriesException = Param(parent='undefined', name='suppressMaxRetriesException', doc='set true to suppress the maxumimum retries exception and report in the error column')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

synapse.ml.cognitive.vision.RecognizeDomainSpecificContent module

class synapse.ml.cognitive.vision.RecognizeDomainSpecificContent.RecognizeDomainSpecificContent(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='RecognizeDomainSpecificContent_afc7ae01173d_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, model=None, modelCol=None, outputCol='RecognizeDomainSpecificContent_afc7ae01173d_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
handler¶ (object) – Which strategy to use when handling requests
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
model¶ (object) – the domain specific model: celebrities, landmarks
outputCol¶ (str) – The name of the output column
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getModel()[source]

Returns: the domain specific model: celebrities, landmarks
Return type: model

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

model = Param(parent='undefined', name='model', doc='ServiceParam: the domain specific model: celebrities, landmarks')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLinkedService(value)[source]

setLocation(value)[source]

setModel(value)[source]

Parameters: model¶ – the domain specific model: celebrities, landmarks

setModelCol(value)[source]

Parameters: model¶ – the domain specific model: celebrities, landmarks

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='RecognizeDomainSpecificContent_afc7ae01173d_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, model=None, modelCol=None, outputCol='RecognizeDomainSpecificContent_afc7ae01173d_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

synapse.ml.cognitive.vision.RecognizeText module

class synapse.ml.cognitive.vision.RecognizeText.RecognizeText(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, backoffs=[100, 500, 1000], concurrency=1, concurrentTimeout=None, errorCol='RecognizeText_66e63b43b80d_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, maxPollingRetries=1000, mode=None, modeCol=None, outputCol='RecognizeText_66e63b43b80d_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
initialPollingDelay¶ (int) – number of milliseconds to wait before first poll for result
maxPollingRetries¶ (int) – number of times to poll
mode¶ (object) – If this parameter is set to ‘Printed’, printed text recognition is performed. If ‘Handwritten’ is specified, handwriting recognition is performed
outputCol¶ (str) – The name of the output column
pollingDelay¶ (int) – number of milliseconds to wait between polling
subscriptionKey¶ (object) – the API key to use
suppressMaxRetriesException¶ (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

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

backoffs = Param(parent='undefined', name='backoffs', doc='array of backoffs to use in the handler')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getBackoffs()[source]

Returns: array of backoffs to use in the handler
Return type: backoffs

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

getInitialPollingDelay()[source]

Returns: number of milliseconds to wait before first poll for result
Return type: initialPollingDelay

static getJavaPackage()[source]: Returns package name String.

getMaxPollingRetries()[source]

Returns: number of times to poll
Return type: maxPollingRetries

getMode()[source]

Returns: If this parameter is set to ‘Printed’, printed text recognition is performed. If ‘Handwritten’ is specified, handwriting recognition is performed
Return type: mode

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getPollingDelay()[source]

Returns: number of milliseconds to wait between polling
Return type: pollingDelay

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getSuppressMaxRetriesException()[source]

Returns: set true to suppress the maxumimum retries exception and report in the error column
Return type: suppressMaxRetriesException

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

initialPollingDelay = Param(parent='undefined', name='initialPollingDelay', doc='number of milliseconds to wait before first poll for result')

maxPollingRetries = Param(parent='undefined', name='maxPollingRetries', doc='number of times to poll')

mode = Param(parent='undefined', name='mode', doc="ServiceParam: If this parameter is set to 'Printed', printed text recognition is performed. If 'Handwritten' is specified, handwriting recognition is performed")

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

pollingDelay = Param(parent='undefined', name='pollingDelay', doc='number of milliseconds to wait between polling')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setBackoffs(value)[source]

Parameters: backoffs¶ – array of backoffs to use in the handler

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setInitialPollingDelay(value)[source]

Parameters: initialPollingDelay¶ – number of milliseconds to wait before first poll for result

setLinkedService(value)[source]

setLocation(value)[source]

setMaxPollingRetries(value)[source]

Parameters: maxPollingRetries¶ – number of times to poll

setMode(value)[source]

Parameters: mode¶ – If this parameter is set to ‘Printed’, printed text recognition is performed. If ‘Handwritten’ is specified, handwriting recognition is performed

setModeCol(value)[source]

Parameters: mode¶ – If this parameter is set to ‘Printed’, printed text recognition is performed. If ‘Handwritten’ is specified, handwriting recognition is performed

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, backoffs=[100, 500, 1000], concurrency=1, concurrentTimeout=None, errorCol='RecognizeText_66e63b43b80d_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, maxPollingRetries=1000, mode=None, modeCol=None, outputCol='RecognizeText_66e63b43b80d_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setPollingDelay(value)[source]

Parameters: pollingDelay¶ – number of milliseconds to wait between polling

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSuppressMaxRetriesException(value)[source]

Parameters: suppressMaxRetriesException¶ – set true to suppress the maxumimum retries exception and report in the error column

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

suppressMaxRetriesException = Param(parent='undefined', name='suppressMaxRetriesException', doc='set true to suppress the maxumimum retries exception and report in the error column')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

synapse.ml.cognitive.vision.TagImage module

class synapse.ml.cognitive.vision.TagImage.TagImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='TagImage_064c56ebae85_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='TagImage_064c56ebae85_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]

Bases: synapse.ml.core.schema.Utils.ComplexParamsMixin, pyspark.ml.util.JavaMLReadable, pyspark.ml.util.JavaMLWritable, pyspark.ml.wrapper.JavaTransformer

Parameters

AADToken¶ (object) – AAD Token used for authentication
CustomAuthHeader¶ (object) – A Custom Value for Authorization Header
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
handler¶ (object) – Which strategy to use when handling requests
imageBytes¶ (object) – bytestream of the image to use
imageUrl¶ (object) – the url of the image to use
language¶ (object) – The desired language for output generation.
outputCol¶ (str) – The name of the output column
subscriptionKey¶ (object) – the API key to use
timeout¶ (float) – number of seconds to wait before closing the connection
url¶ (str) – Url of the service

AADToken = Param(parent='undefined', name='AADToken', doc='ServiceParam: AAD Token used for authentication')

CustomAuthHeader = Param(parent='undefined', name='CustomAuthHeader', doc='ServiceParam: A Custom Value for Authorization Header')

concurrency = Param(parent='undefined', name='concurrency', doc='max number of concurrent calls')

concurrentTimeout = Param(parent='undefined', name='concurrentTimeout', doc='max number seconds to wait on futures if concurrency >= 1')

errorCol = Param(parent='undefined', name='errorCol', doc='column to hold http errors')

getAADToken()[source]

Returns: AAD Token used for authentication
Return type: AADToken

getConcurrency()[source]

Returns: max number of concurrent calls
Return type: concurrency

getConcurrentTimeout()[source]

Returns: max number seconds to wait on futures if concurrency >= 1
Return type: concurrentTimeout

getCustomAuthHeader()[source]

Returns: A Custom Value for Authorization Header
Return type: CustomAuthHeader

getErrorCol()[source]

Returns: column to hold http errors
Return type: errorCol

getHandler()[source]

Returns: Which strategy to use when handling requests
Return type: handler

getImageBytes()[source]

Returns: bytestream of the image to use
Return type: imageBytes

getImageUrl()[source]

Returns: the url of the image to use
Return type: imageUrl

static getJavaPackage()[source]: Returns package name String.

getLanguage()[source]

Returns: The desired language for output generation.
Return type: language

getOutputCol()[source]

Returns: The name of the output column
Return type: outputCol

getSubscriptionKey()[source]

Returns: the API key to use
Return type: subscriptionKey

getTimeout()[source]

Returns: number of seconds to wait before closing the connection
Return type: timeout

getUrl()[source]

Returns: Url of the service
Return type: url

handler = Param(parent='undefined', name='handler', doc='Which strategy to use when handling requests')

imageBytes = Param(parent='undefined', name='imageBytes', doc='ServiceParam: bytestream of the image to use')

imageUrl = Param(parent='undefined', name='imageUrl', doc='ServiceParam: the url of the image to use')

language = Param(parent='undefined', name='language', doc='ServiceParam: The desired language for output generation.')

outputCol = Param(parent='undefined', name='outputCol', doc='The name of the output column')

classmethod read()[source]: Returns an MLReader instance for this class.

setAADToken(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setAADTokenCol(value)[source]

Parameters: AADToken¶ – AAD Token used for authentication

setConcurrency(value)[source]

Parameters: concurrency¶ – max number of concurrent calls

setConcurrentTimeout(value)[source]

Parameters: concurrentTimeout¶ – max number seconds to wait on futures if concurrency >= 1

setCustomAuthHeader(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)[source]

Parameters: CustomAuthHeader¶ – A Custom Value for Authorization Header

setCustomServiceName(value)[source]

setDefaultInternalEndpoint(value)[source]

setEndpoint(value)[source]

setErrorCol(value)[source]

Parameters: errorCol¶ – column to hold http errors

setHandler(value)[source]

Parameters: handler¶ – Which strategy to use when handling requests

setImageBytes(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageBytesCol(value)[source]

Parameters: imageBytes¶ – bytestream of the image to use

setImageUrl(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setImageUrlCol(value)[source]

Parameters: imageUrl¶ – the url of the image to use

setLanguage(value)[source]

Parameters: language¶ – The desired language for output generation.

setLanguageCol(value)[source]

Parameters: language¶ – The desired language for output generation.

setLinkedService(value)[source]

setLocation(value)[source]

setOutputCol(value)[source]

Parameters: outputCol¶ – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='TagImage_064c56ebae85_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='TagImage_064c56ebae85_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)[source]: Set the (keyword only) parameters

setSubscriptionKey(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setSubscriptionKeyCol(value)[source]

Parameters: subscriptionKey¶ – the API key to use

setTimeout(value)[source]

Parameters: timeout¶ – number of seconds to wait before closing the connection

setUrl(value)[source]

Parameters: url¶ – Url of the service

subscriptionKey = Param(parent='undefined', name='subscriptionKey', doc='ServiceParam: the API key to use')

timeout = Param(parent='undefined', name='timeout', doc='number of seconds to wait before closing the connection')

url = Param(parent='undefined', name='url', doc='Url of the service')

Module contents

SynapseML is an ecosystem of tools aimed towards expanding the distributed computing framework Apache Spark in several new directions. SynapseML adds many deep learning and data science tools to the Spark ecosystem, including seamless integration of Spark Machine Learning pipelines with Microsoft Cognitive Toolkit (CNTK), LightGBM and OpenCV. These tools enable powerful and highly-scalable predictive and analytical models for a variety of datasources.

SynapseML also brings new networking capabilities to the Spark Ecosystem. With the HTTP on Spark project, users can embed any web service into their SparkML models. In this vein, SynapseML provides easy to use SparkML transformers for a wide variety of Microsoft Cognitive Services. For production grade deployment, the Spark Serving project enables high throughput, sub-millisecond latency web services, backed by your Spark cluster.

SynapseML requires Scala 2.12, Spark 3.0+, and Python 3.6+.