DocumentTranslator implements DocumentTranslator More...

Inheritance diagram for Synapse.ML.Cognitive.DocumentTranslator:

Collaboration diagram for Synapse.ML.Cognitive.DocumentTranslator:

Public Member Functions
	DocumentTranslator ()
	Creates a DocumentTranslator without any parameters. More...

	DocumentTranslator (string uid)
	Creates a DocumentTranslator with a UID that is used to give the DocumentTranslator a unique ID. More...

DocumentTranslator	SetBackoffs (int[] value)
	Sets value for backoffs More...

DocumentTranslator	SetConcurrency (int value)
	Sets value for concurrency More...

DocumentTranslator	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

DocumentTranslator	SetErrorCol (string value)
	Sets value for errorCol More...

DocumentTranslator	SetFilterPrefix (string value)
	Sets value for filterPrefix More...

DocumentTranslator	SetFilterPrefixCol (string value)
	Sets value for filterPrefix column More...

DocumentTranslator	SetFilterSuffix (string value)
	Sets value for filterSuffix More...

DocumentTranslator	SetFilterSuffixCol (string value)
	Sets value for filterSuffix column More...

DocumentTranslator	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...

DocumentTranslator	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...

DocumentTranslator	SetOutputCol (string value)
	Sets value for outputCol More...

DocumentTranslator	SetPollingDelay (int value)
	Sets value for pollingDelay More...

DocumentTranslator	SetServiceName (string value)
	Sets value for serviceName More...

DocumentTranslator	SetSourceLanguage (string value)
	Sets value for sourceLanguage More...

DocumentTranslator	SetSourceLanguageCol (string value)
	Sets value for sourceLanguage column More...

DocumentTranslator	SetSourceStorageSource (string value)
	Sets value for sourceStorageSource More...

DocumentTranslator	SetSourceStorageSourceCol (string value)
	Sets value for sourceStorageSource column More...

DocumentTranslator	SetSourceUrl (string value)
	Sets value for sourceUrl More...

DocumentTranslator	SetSourceUrlCol (string value)
	Sets value for sourceUrl column More...

DocumentTranslator	SetStorageType (string value)
	Sets value for storageType More...

DocumentTranslator	SetStorageTypeCol (string value)
	Sets value for storageType column More...

DocumentTranslator	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

DocumentTranslator	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

DocumentTranslator	SetSuppressMaxRetriesExceededException (bool value)
	Sets value for suppressMaxRetriesExceededException More...

DocumentTranslator	SetTargets (TargetInput[] value)
	Sets value for targets More...

DocumentTranslator	SetTargetsCol (string value)
	Sets value for targets column More...

DocumentTranslator	SetTimeout (double value)
	Sets value for timeout More...

DocumentTranslator	SetUrl (string value)
	Sets value for url More...

int []	GetBackoffs ()
	Gets backoffs value More...

int	GetConcurrency ()
	Gets concurrency value More...

double	GetConcurrentTimeout ()
	Gets concurrentTimeout value More...

string	GetErrorCol ()
	Gets errorCol value More...

string	GetFilterPrefix ()
	Gets filterPrefix value More...

string	GetFilterSuffix ()
	Gets filterSuffix value More...

int	GetInitialPollingDelay ()
	Gets initialPollingDelay value More...

int	GetMaxPollingRetries ()
	Gets maxPollingRetries value More...

string	GetOutputCol ()
	Gets outputCol value More...

int	GetPollingDelay ()
	Gets pollingDelay value More...

string	GetServiceName ()
	Gets serviceName value More...

string	GetSourceLanguage ()
	Gets sourceLanguage value More...

string	GetSourceStorageSource ()
	Gets sourceStorageSource value More...

string	GetSourceUrl ()
	Gets sourceUrl value More...

string	GetStorageType ()
	Gets storageType value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

bool	GetSuppressMaxRetriesExceededException ()
	Gets suppressMaxRetriesExceededException value More...

TargetInput []	GetTargets ()
	Gets targets value More...

double	GetTimeout ()
	Gets timeout value More...

string	GetUrl ()
	Gets url value More...

void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...

JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.

JavaMLReader< DocumentTranslator >	Read ()
	Get the corresponding JavaMLReader instance. More...

DocumentTranslator	SetLinkedService (string value)
	Sets value for linkedService More...

Static Public Member Functions
static DocumentTranslator	Load (string path)
	Loads the DocumentTranslator that was previously saved using Save(string). More...

Detailed Description

DocumentTranslator implements DocumentTranslator

Constructor & Destructor Documentation

◆ DocumentTranslator() [1/2]

Synapse.ML.Cognitive.DocumentTranslator.DocumentTranslator ( )

inline

Creates a DocumentTranslator without any parameters.

◆ DocumentTranslator() [2/2]

Synapse.ML.Cognitive.DocumentTranslator.DocumentTranslator ( string uid )

inline

Creates a DocumentTranslator with a UID that is used to give the DocumentTranslator a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetBackoffs()

int [] Synapse.ML.Cognitive.DocumentTranslator.GetBackoffs ( )

Gets backoffs value

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

◆ GetConcurrency()

int Synapse.ML.Cognitive.DocumentTranslator.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Cognitive.DocumentTranslator.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetErrorCol()

string Synapse.ML.Cognitive.DocumentTranslator.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFilterPrefix()

string Synapse.ML.Cognitive.DocumentTranslator.GetFilterPrefix ( )

Gets filterPrefix value

Returns: filterPrefix: A case-sensitive prefix string to filter documents in the source path for translation. For example, when using an Azure storage blob Uri, use the prefix to restrict sub folders for translation.

◆ GetFilterSuffix()

string Synapse.ML.Cognitive.DocumentTranslator.GetFilterSuffix ( )

Gets filterSuffix value

Returns: filterSuffix: A case-sensitive suffix string to filter documents in the source path for translation. This is most often use for file extensions.

◆ GetInitialPollingDelay()

int Synapse.ML.Cognitive.DocumentTranslator.GetInitialPollingDelay ( )

Gets initialPollingDelay value

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

◆ GetMaxPollingRetries()

int Synapse.ML.Cognitive.DocumentTranslator.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns: maxPollingRetries: number of times to poll

◆ GetOutputCol()

string Synapse.ML.Cognitive.DocumentTranslator.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPollingDelay()

int Synapse.ML.Cognitive.DocumentTranslator.GetPollingDelay ( )

Gets pollingDelay value

Returns: pollingDelay: number of milliseconds to wait between polling

◆ GetServiceName()

string Synapse.ML.Cognitive.DocumentTranslator.GetServiceName ( )

Gets serviceName value

Returns: serviceName:

◆ GetSourceLanguage()

string Synapse.ML.Cognitive.DocumentTranslator.GetSourceLanguage ( )

Gets sourceLanguage value

Returns: sourceLanguage: Language code. If none is specified, we will perform auto detect on the document.

◆ GetSourceStorageSource()

string Synapse.ML.Cognitive.DocumentTranslator.GetSourceStorageSource ( )

Gets sourceStorageSource value

Returns: sourceStorageSource: Storage source of source input.

◆ GetSourceUrl()

string Synapse.ML.Cognitive.DocumentTranslator.GetSourceUrl ( )

Gets sourceUrl value

Returns: sourceUrl: Location of the folder / container or single file with your documents.

◆ GetStorageType()

string Synapse.ML.Cognitive.DocumentTranslator.GetStorageType ( )

Gets storageType value

Returns: storageType: Storage type of the input documents source string. Required for single document translation only.

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.DocumentTranslator.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.DocumentTranslator.GetSuppressMaxRetriesExceededException ( )

Gets suppressMaxRetriesExceededException value

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

◆ GetTargets()

TargetInput [] Synapse.ML.Cognitive.DocumentTranslator.GetTargets ( )

inline

Gets targets value

Returns: targets: Destination for the finished translated documents.

◆ GetTimeout()

double Synapse.ML.Cognitive.DocumentTranslator.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Cognitive.DocumentTranslator.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.Load ( string path )

static

Loads the DocumentTranslator that was previously saved using Save(string).

Parameters

path	The path the previous DocumentTranslator was saved to

Returns: New DocumentTranslator object, loaded from path.

◆ Read()

JavaMLReader<DocumentTranslator> Synapse.ML.Cognitive.DocumentTranslator.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<DocumentTranslator> instance for this ML instance.

◆ Save()

void Synapse.ML.Cognitive.DocumentTranslator.Save ( string path )

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

◆ SetBackoffs()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetBackoffs ( int [] value )

Sets value for backoffs

Parameters

value array of backoffs to use in the handler

Returns: New DocumentTranslator object

◆ SetConcurrency()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New DocumentTranslator object

◆ SetConcurrentTimeout()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New DocumentTranslator object

◆ SetErrorCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New DocumentTranslator object

◆ SetFilterPrefix()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetFilterPrefix ( string value )

Sets value for filterPrefix

Parameters

value A case-sensitive prefix string to filter documents in the source path for translation. For example, when using an Azure storage blob Uri, use the prefix to restrict sub folders for translation.

Returns: New DocumentTranslator object

◆ SetFilterPrefixCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetFilterPrefixCol ( string value )

Sets value for filterPrefix column

Parameters

value A case-sensitive prefix string to filter documents in the source path for translation. For example, when using an Azure storage blob Uri, use the prefix to restrict sub folders for translation.

Returns: New DocumentTranslator object

◆ SetFilterSuffix()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetFilterSuffix ( string value )

Sets value for filterSuffix

Parameters

value A case-sensitive suffix string to filter documents in the source path for translation. This is most often use for file extensions.

Returns: New DocumentTranslator object

◆ SetFilterSuffixCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetFilterSuffixCol ( string value )

Sets value for filterSuffix column

Parameters

value A case-sensitive suffix string to filter documents in the source path for translation. This is most often use for file extensions.

Returns: New DocumentTranslator object

◆ SetInitialPollingDelay()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetInitialPollingDelay ( int value )

Sets value for initialPollingDelay

Parameters

value number of milliseconds to wait before first poll for result

Returns: New DocumentTranslator object

◆ SetLinkedService()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New DocumentTranslator object

◆ SetMaxPollingRetries()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetMaxPollingRetries ( int value )

Sets value for maxPollingRetries

Parameters

value number of times to poll

Returns: New DocumentTranslator object

◆ SetOutputCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New DocumentTranslator object

◆ SetPollingDelay()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetPollingDelay ( int value )

Sets value for pollingDelay

Parameters

value number of milliseconds to wait between polling

Returns: New DocumentTranslator object

◆ SetServiceName()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetServiceName ( string value )

Sets value for serviceName

Parameters

value

Returns: New DocumentTranslator object

◆ SetSourceLanguage()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceLanguage ( string value )

Sets value for sourceLanguage

Parameters

value Language code. If none is specified, we will perform auto detect on the document.

Returns: New DocumentTranslator object

◆ SetSourceLanguageCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceLanguageCol ( string value )

Sets value for sourceLanguage column

Parameters

value Language code. If none is specified, we will perform auto detect on the document.

Returns: New DocumentTranslator object

◆ SetSourceStorageSource()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceStorageSource ( string value )

Sets value for sourceStorageSource

Parameters

value Storage source of source input.

Returns: New DocumentTranslator object

◆ SetSourceStorageSourceCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceStorageSourceCol ( string value )

Sets value for sourceStorageSource column

Parameters

value Storage source of source input.

Returns: New DocumentTranslator object

◆ SetSourceUrl()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceUrl ( string value )

Sets value for sourceUrl

Parameters

value Location of the folder / container or single file with your documents.

Returns: New DocumentTranslator object

◆ SetSourceUrlCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSourceUrlCol ( string value )

Sets value for sourceUrl column

Parameters

value Location of the folder / container or single file with your documents.

Returns: New DocumentTranslator object

◆ SetStorageType()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetStorageType ( string value )

Sets value for storageType

Parameters

value Storage type of the input documents source string. Required for single document translation only.

Returns: New DocumentTranslator object

◆ SetStorageTypeCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetStorageTypeCol ( string value )

Sets value for storageType column

Parameters

value Storage type of the input documents source string. Required for single document translation only.

Returns: New DocumentTranslator object

◆ SetSubscriptionKey()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New DocumentTranslator object

◆ SetSubscriptionKeyCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New DocumentTranslator object

◆ SetSuppressMaxRetriesExceededException()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetSuppressMaxRetriesExceededException ( bool value )

Sets value for suppressMaxRetriesExceededException

Parameters

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

Returns: New DocumentTranslator object

◆ SetTargets()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetTargets ( TargetInput [] value )

Sets value for targets

Parameters

value Destination for the finished translated documents.

Returns: New DocumentTranslator object

◆ SetTargetsCol()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetTargetsCol ( string value )

Sets value for targets column

Parameters

value Destination for the finished translated documents.

Returns: New DocumentTranslator object

◆ SetTimeout()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New DocumentTranslator object

◆ SetUrl()

DocumentTranslator Synapse.ML.Cognitive.DocumentTranslator.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New DocumentTranslator object

The documentation for this class was generated from the following file:

synapse/ml/cognitive/DocumentTranslator.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DocumentTranslator() [1/2]

◆ DocumentTranslator() [2/2]

Member Function Documentation

◆ GetBackoffs()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetErrorCol()

◆ GetFilterPrefix()

◆ GetFilterSuffix()

◆ GetInitialPollingDelay()

◆ GetMaxPollingRetries()

◆ GetOutputCol()

◆ GetPollingDelay()

◆ GetServiceName()

◆ GetSourceLanguage()

◆ GetSourceStorageSource()

◆ GetSourceUrl()

◆ GetStorageType()

◆ GetSubscriptionKey()

◆ GetSuppressMaxRetriesExceededException()

◆ GetTargets()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetBackoffs()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetErrorCol()

◆ SetFilterPrefix()

◆ SetFilterPrefixCol()

◆ SetFilterSuffix()

◆ SetFilterSuffixCol()

◆ SetInitialPollingDelay()

◆ SetLinkedService()

◆ SetMaxPollingRetries()

◆ SetOutputCol()

◆ SetPollingDelay()

◆ SetServiceName()

◆ SetSourceLanguage()

◆ SetSourceLanguageCol()

◆ SetSourceStorageSource()

◆ SetSourceStorageSourceCol()

◆ SetSourceUrl()

◆ SetSourceUrlCol()

◆ SetStorageType()

◆ SetStorageTypeCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSuppressMaxRetriesExceededException()

◆ SetTargets()

◆ SetTargetsCol()

◆ SetTimeout()

◆ SetUrl()