synapse.ml.services.vision package

Submodules

synapse.ml.services.vision.AnalyzeImage module

class synapse.ml.services.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_017d47ad1fc6_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='AnalyzeImage_017d47ad1fc6_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, visualFeatures=None, visualFeaturesCol=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getDescriptionExclude()

Returns

Whether to exclude certain parts of the model in the description

Return type

descriptionExclude

getDetails()

Returns

what visual feature types to return

Return type

details

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getLanguage()

Returns

the language of the response (en if none given)

Return type

language

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

Returns

Url of the service

Return type

url

getVisualFeatures()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setDescriptionExclude(value)

Parameters

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

setDescriptionExcludeCol(value)

Parameters

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

setDetails(value)

Parameters

details – what visual feature types to return

setDetailsCol(value)

Parameters

details – what visual feature types to return

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLanguage(value)

Parameters

language – the language of the response (en if none given)

setLanguageCol(value)

Parameters

language – the language of the response (en if none given)

setLinkedService(value)

setLocation(value)

setOutputCol(value)

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_017d47ad1fc6_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='AnalyzeImage_017d47ad1fc6_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, visualFeatures=None, visualFeaturesCol=None)

Set the (keyword only) parameters

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

Parameters

url – Url of the service

setVisualFeatures(value)

Parameters

visualFeatures – what visual feature types to return

setVisualFeaturesCol(value)

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.services.vision.DescribeImage module

class synapse.ml.services.vision.DescribeImage.DescribeImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='DescribeImage_b1c3e1fffb2b_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, maxCandidates=None, maxCandidatesCol=None, outputCol='DescribeImage_b1c3e1fffb2b_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getLanguage()

Returns

Language of image description

Return type

language

getMaxCandidates()

Returns

Maximum candidate descriptions to return

Return type

maxCandidates

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLanguage(value)

Parameters

language – Language of image description

setLanguageCol(value)

Parameters

language – Language of image description

setLinkedService(value)

setLocation(value)

setMaxCandidates(value)

Parameters

maxCandidates – Maximum candidate descriptions to return

setMaxCandidatesCol(value)

Parameters

maxCandidates – Maximum candidate descriptions to return

setOutputCol(value)

Parameters

outputCol – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='DescribeImage_b1c3e1fffb2b_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, maxCandidates=None, maxCandidatesCol=None, outputCol='DescribeImage_b1c3e1fffb2b_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Set the (keyword only) parameters

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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.services.vision.GenerateThumbnails module

class synapse.ml.services.vision.GenerateThumbnails.GenerateThumbnails(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='GenerateThumbnails_254695a7886e_error', handler=None, height=None, heightCol=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, outputCol='GenerateThumbnails_254695a7886e_output', smartCropping=None, smartCroppingCol=None, subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, width=None, widthCol=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getHeight()

Returns

the desired height of the image

Return type

height

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSmartCropping()

Returns

whether to intelligently crop the image

Return type

smartCropping

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

Returns

Url of the service

Return type

url

getWidth()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setHeight(value)

Parameters

height – the desired height of the image

setHeightCol(value)

Parameters

height – the desired height of the image

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLinkedService(value)

setLocation(value)

setOutputCol(value)

Parameters

outputCol – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='GenerateThumbnails_254695a7886e_error', handler=None, height=None, heightCol=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, outputCol='GenerateThumbnails_254695a7886e_output', smartCropping=None, smartCroppingCol=None, subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None, width=None, widthCol=None)

Set the (keyword only) parameters

setSmartCropping(value)

Parameters

smartCropping – whether to intelligently crop the image

setSmartCroppingCol(value)

Parameters

smartCropping – whether to intelligently crop the image

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

Parameters

url – Url of the service

setWidth(value)

Parameters

width – the desired width of the image

setWidthCol(value)

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.services.vision.OCR module

class synapse.ml.services.vision.OCR.OCR(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, detectOrientation=None, detectOrientationCol=None, errorCol='OCR_a89a89d80749_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='OCR_a89a89d80749_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getDetectOrientation()

Returns

whether to detect image orientation prior to processing

Return type

detectOrientation

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getLanguage()

Returns

the language to use

Return type

language

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setDetectOrientation(value)

Parameters

detectOrientation – whether to detect image orientation prior to processing

setDetectOrientationCol(value)

Parameters

detectOrientation – whether to detect image orientation prior to processing

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLanguage(value)

Parameters

language – the language to use

setLanguageCol(value)

Parameters

language – the language to use

setLinkedService(value)

setLocation(value)

setOutputCol(value)

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_a89a89d80749_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='OCR_a89a89d80749_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Set the (keyword only) parameters

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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.services.vision.ReadImage module

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

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getBackoffs()

Returns

array of backoffs to use in the handler

Return type

backoffs

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

getInitialPollingDelay()

Returns

number of milliseconds to wait before first poll for result

Return type

initialPollingDelay

static getJavaPackage()

Returns package name String.

getLanguage()

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()

Returns

number of times to poll

Return type

maxPollingRetries

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getPollingDelay()

Returns

number of milliseconds to wait between polling

Return type

pollingDelay

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getSuppressMaxRetriesException()

Returns

set true to suppress the maxumimum retries exception and report in the error column

Return type

suppressMaxRetriesException

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setBackoffs(value)

Parameters

backoffs – array of backoffs to use in the handler

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setInitialPollingDelay(value)

Parameters

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

setLanguage(value)

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)

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)

setLocation(value)

setMaxPollingRetries(value)

Parameters

maxPollingRetries – number of times to poll

setOutputCol(value)

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_b7b8a37bfd38_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, language=None, languageCol=None, maxPollingRetries=1000, outputCol='ReadImage_b7b8a37bfd38_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)

Set the (keyword only) parameters

setPollingDelay(value)

Parameters

pollingDelay – number of milliseconds to wait between polling

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setSuppressMaxRetriesException(value)

Parameters

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

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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.services.vision.RecognizeDomainSpecificContent module

class synapse.ml.services.vision.RecognizeDomainSpecificContent.RecognizeDomainSpecificContent(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='RecognizeDomainSpecificContent_a4e5a45ad41d_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, model=None, modelCol=None, outputCol='RecognizeDomainSpecificContent_a4e5a45ad41d_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getModel()

Returns

the domain specific model: celebrities, landmarks

Return type

model

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLinkedService(value)

setLocation(value)

setModel(value)

Parameters

model – the domain specific model: celebrities, landmarks

setModelCol(value)

Parameters

model – the domain specific model: celebrities, landmarks

setOutputCol(value)

Parameters

outputCol – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='RecognizeDomainSpecificContent_a4e5a45ad41d_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, model=None, modelCol=None, outputCol='RecognizeDomainSpecificContent_a4e5a45ad41d_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Set the (keyword only) parameters

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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.services.vision.RecognizeText module

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

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getBackoffs()

Returns

array of backoffs to use in the handler

Return type

backoffs

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

getInitialPollingDelay()

Returns

number of milliseconds to wait before first poll for result

Return type

initialPollingDelay

static getJavaPackage()

Returns package name String.

getMaxPollingRetries()

Returns

number of times to poll

Return type

maxPollingRetries

getMode()

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()

Returns

The name of the output column

Return type

outputCol

getPollingDelay()

Returns

number of milliseconds to wait between polling

Return type

pollingDelay

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getSuppressMaxRetriesException()

Returns

set true to suppress the maxumimum retries exception and report in the error column

Return type

suppressMaxRetriesException

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setBackoffs(value)

Parameters

backoffs – array of backoffs to use in the handler

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setInitialPollingDelay(value)

Parameters

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

setLinkedService(value)

setLocation(value)

setMaxPollingRetries(value)

Parameters

maxPollingRetries – number of times to poll

setMode(value)

Parameters

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

setModeCol(value)

Parameters

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

setOutputCol(value)

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_207022ed4651_error', imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, initialPollingDelay=300, maxPollingRetries=1000, mode=None, modeCol=None, outputCol='RecognizeText_207022ed4651_output', pollingDelay=300, subscriptionKey=None, subscriptionKeyCol=None, suppressMaxRetriesException=False, timeout=60.0, url=None)

Set the (keyword only) parameters

setPollingDelay(value)

Parameters

pollingDelay – number of milliseconds to wait between polling

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setSuppressMaxRetriesException(value)

Parameters

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

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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.services.vision.TagImage module

class synapse.ml.services.vision.TagImage.TagImage(java_obj=None, AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='TagImage_a80e1f0bdf28_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='TagImage_a80e1f0bdf28_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Bases: pyspark.ml.util.MLReadable[pyspark.ml.util.RL]

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()

Returns

AAD Token used for authentication

Return type

AADToken

getConcurrency()

Returns

max number of concurrent calls

Return type

concurrency

getConcurrentTimeout()

Returns

max number seconds to wait on futures if concurrency >= 1

Return type

concurrentTimeout

getCustomAuthHeader()

Returns

A Custom Value for Authorization Header

Return type

CustomAuthHeader

getErrorCol()

Returns

column to hold http errors

Return type

errorCol

getHandler()

Returns

Which strategy to use when handling requests

Return type

handler

getImageBytes()

Returns

bytestream of the image to use

Return type

imageBytes

getImageUrl()

Returns

the url of the image to use

Return type

imageUrl

static getJavaPackage()

Returns package name String.

getLanguage()

Returns

The desired language for output generation.

Return type

language

getOutputCol()

Returns

The name of the output column

Return type

outputCol

getSubscriptionKey()

Returns

the API key to use

Return type

subscriptionKey

getTimeout()

Returns

number of seconds to wait before closing the connection

Return type

timeout

getUrl()

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()

Returns an MLReader instance for this class.

setAADToken(value)

Parameters

AADToken – AAD Token used for authentication

setAADTokenCol(value)

Parameters

AADToken – AAD Token used for authentication

setConcurrency(value)

Parameters

concurrency – max number of concurrent calls

setConcurrentTimeout(value)

Parameters

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

setCustomAuthHeader(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomAuthHeaderCol(value)

Parameters

CustomAuthHeader – A Custom Value for Authorization Header

setCustomServiceName(value)

setDefaultInternalEndpoint(value)

setEndpoint(value)

setErrorCol(value)

Parameters

errorCol – column to hold http errors

setHandler(value)

Parameters

handler – Which strategy to use when handling requests

setImageBytes(value)

Parameters

imageBytes – bytestream of the image to use

setImageBytesCol(value)

Parameters

imageBytes – bytestream of the image to use

setImageUrl(value)

Parameters

imageUrl – the url of the image to use

setImageUrlCol(value)

Parameters

imageUrl – the url of the image to use

setLanguage(value)

Parameters

language – The desired language for output generation.

setLanguageCol(value)

Parameters

language – The desired language for output generation.

setLinkedService(value)

setLocation(value)

setOutputCol(value)

Parameters

outputCol – The name of the output column

setParams(AADToken=None, AADTokenCol=None, CustomAuthHeader=None, CustomAuthHeaderCol=None, concurrency=1, concurrentTimeout=None, errorCol='TagImage_a80e1f0bdf28_error', handler=None, imageBytes=None, imageBytesCol=None, imageUrl=None, imageUrlCol=None, language=None, languageCol=None, outputCol='TagImage_a80e1f0bdf28_output', subscriptionKey=None, subscriptionKeyCol=None, timeout=60.0, url=None)

Set the (keyword only) parameters

setSubscriptionKey(value)

Parameters

subscriptionKey – the API key to use

setSubscriptionKeyCol(value)

Parameters

subscriptionKey – the API key to use

setTimeout(value)

Parameters

timeout – number of seconds to wait before closing the connection

setUrl(value)

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+.