AnalyzeLayout implements AnalyzeLayout More...

Inheritance diagram for Synapse.ML.Services.Form.AnalyzeLayout:

[legend]

Collaboration diagram for Synapse.ML.Services.Form.AnalyzeLayout:

[legend]

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

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

AnalyzeLayout	SetAADToken (string value)
	Sets value for AADToken More...

AnalyzeLayout	SetAADTokenCol (string value)
	Sets value for AADToken column More...

AnalyzeLayout	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...

AnalyzeLayout	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...

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

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

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

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

AnalyzeLayout	SetImageBytes (byte[] value)
	Sets value for imageBytes More...

AnalyzeLayout	SetImageBytesCol (string value)
	Sets value for imageBytes column More...

AnalyzeLayout	SetImageUrl (string value)
	Sets value for imageUrl More...

AnalyzeLayout	SetImageUrlCol (string value)
	Sets value for imageUrl column More...

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

AnalyzeLayout	SetLanguage (string value)
	Sets value for language More...

AnalyzeLayout	SetLanguageCol (string value)
	Sets value for language column More...

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

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

AnalyzeLayout	SetPages (string value)
	Sets value for pages More...

AnalyzeLayout	SetPagesCol (string value)
	Sets value for pages column More...

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

AnalyzeLayout	SetReadingOrder (string value)
	Sets value for readingOrder More...

AnalyzeLayout	SetReadingOrderCol (string value)
	Sets value for readingOrder column More...

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

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

AnalyzeLayout	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...

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

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

string	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value 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...

byte[]	GetImageBytes ()
	Gets imageBytes value More...

string	GetImageUrl ()
	Gets imageUrl value More...

int	GetInitialPollingDelay ()
	Gets initialPollingDelay value More...

string	GetLanguage ()
	Gets language value More...

int	GetMaxPollingRetries ()
	Gets maxPollingRetries value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetPages ()
	Gets pages value More...

int	GetPollingDelay ()
	Gets pollingDelay value More...

string	GetReadingOrder ()
	Gets readingOrder value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

bool	GetSuppressMaxRetriesException ()
	Gets suppressMaxRetriesException 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< AnalyzeLayout >	Read ()
	Get the corresponding JavaMLReader instance. More...

AnalyzeLayout	SetCustomServiceName (string value)
	Sets value for service name More...

AnalyzeLayout	SetEndpoint (string value)
	Sets value for endpoint More...

AnalyzeLayout	SetLocation (string value)
	Sets value for location More...

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

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

Detailed Description

AnalyzeLayout implements AnalyzeLayout

Constructor & Destructor Documentation

◆ AnalyzeLayout() [1/2]

Synapse.ML.Services.Form.AnalyzeLayout.AnalyzeLayout ( )

inline

Creates a AnalyzeLayout without any parameters.

◆ AnalyzeLayout() [2/2]

Synapse.ML.Services.Form.AnalyzeLayout.AnalyzeLayout ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Form.AnalyzeLayout.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetBackoffs()

int [] Synapse.ML.Services.Form.AnalyzeLayout.GetBackoffs ( )

Gets backoffs value

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

◆ GetConcurrency()

int Synapse.ML.Services.Form.AnalyzeLayout.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Form.AnalyzeLayout.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Form.AnalyzeLayout.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

string Synapse.ML.Services.Form.AnalyzeLayout.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetImageBytes()

byte [] Synapse.ML.Services.Form.AnalyzeLayout.GetImageBytes ( )

Gets imageBytes value

Returns: imageBytes: bytestream of the image to use

◆ GetImageUrl()

string Synapse.ML.Services.Form.AnalyzeLayout.GetImageUrl ( )

Gets imageUrl value

Returns: imageUrl: the url of the image to use

◆ GetInitialPollingDelay()

int Synapse.ML.Services.Form.AnalyzeLayout.GetInitialPollingDelay ( )

Gets initialPollingDelay value

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

◆ GetLanguage()

string Synapse.ML.Services.Form.AnalyzeLayout.GetLanguage ( )

Gets language value

Returns: language: The BCP-47 language code of the text in the document. Layout 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.

◆ GetMaxPollingRetries()

int Synapse.ML.Services.Form.AnalyzeLayout.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns: maxPollingRetries: number of times to poll

◆ GetOutputCol()

string Synapse.ML.Services.Form.AnalyzeLayout.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPages()

string Synapse.ML.Services.Form.AnalyzeLayout.GetPages ( )

Gets pages value

Returns: pages: The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed.

◆ GetPollingDelay()

int Synapse.ML.Services.Form.AnalyzeLayout.GetPollingDelay ( )

Gets pollingDelay value

Returns: pollingDelay: number of milliseconds to wait between polling

◆ GetReadingOrder()

string Synapse.ML.Services.Form.AnalyzeLayout.GetReadingOrder ( )

Gets readingOrder value

Returns: readingOrder: Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to basic if not specified

◆ GetSubscriptionKey()

string Synapse.ML.Services.Form.AnalyzeLayout.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesException()

bool Synapse.ML.Services.Form.AnalyzeLayout.GetSuppressMaxRetriesException ( )

Gets suppressMaxRetriesException value

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

◆ GetTimeout()

double Synapse.ML.Services.Form.AnalyzeLayout.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Form.AnalyzeLayout.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.Load ( string path )

static

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

Parameters

path	The path the previous AnalyzeLayout was saved to

Returns: New AnalyzeLayout object, loaded from path.

◆ Read()

JavaMLReader<AnalyzeLayout> Synapse.ML.Services.Form.AnalyzeLayout.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Services.Form.AnalyzeLayout.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

◆ SetAADToken()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New AnalyzeLayout object

◆ SetAADTokenCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New AnalyzeLayout object

◆ SetBackoffs()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetBackoffs ( int[] value )

Sets value for backoffs

Parameters

value array of backoffs to use in the handler

Returns: New AnalyzeLayout object

◆ SetConcurrency()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New AnalyzeLayout object

◆ SetConcurrentTimeout()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New AnalyzeLayout object

◆ SetCustomAuthHeader()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeLayout object

◆ SetCustomAuthHeaderCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeLayout object

◆ SetCustomServiceName()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetCustomServiceName ( string value )

Sets value for service name

Parameters

value Service name of the cognitive service if it's custom domain

Returns: New AnalyzeLayout object

◆ SetEndpoint()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New AnalyzeLayout object

◆ SetErrorCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New AnalyzeLayout object

◆ SetImageBytes()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetImageBytes ( byte[] value )

Sets value for imageBytes

Parameters

value bytestream of the image to use

Returns: New AnalyzeLayout object

◆ SetImageBytesCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetImageBytesCol ( string value )

Sets value for imageBytes column

Parameters

value bytestream of the image to use

Returns: New AnalyzeLayout object

◆ SetImageUrl()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetImageUrl ( string value )

Sets value for imageUrl

Parameters

value the url of the image to use

Returns: New AnalyzeLayout object

◆ SetImageUrlCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetImageUrlCol ( string value )

Sets value for imageUrl column

Parameters

value the url of the image to use

Returns: New AnalyzeLayout object

◆ SetInitialPollingDelay()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetInitialPollingDelay ( int value )

Sets value for initialPollingDelay

Parameters

value number of milliseconds to wait before first poll for result

Returns: New AnalyzeLayout object

◆ SetLanguage()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetLanguage ( string value )

Sets value for language

Parameters

value The BCP-47 language code of the text in the document. Layout 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.

Returns: New AnalyzeLayout object

◆ SetLanguageCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetLanguageCol ( string value )

Sets value for language column

Parameters

value The BCP-47 language code of the text in the document. Layout 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.

Returns: New AnalyzeLayout object

◆ SetLinkedService()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New AnalyzeLayout object

◆ SetLocation()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New AnalyzeLayout object

◆ SetMaxPollingRetries()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetMaxPollingRetries ( int value )

Sets value for maxPollingRetries

Parameters

value number of times to poll

Returns: New AnalyzeLayout object

◆ SetOutputCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New AnalyzeLayout object

◆ SetPages()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetPages ( string value )

Sets value for pages

Parameters

value The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed.

Returns: New AnalyzeLayout object

◆ SetPagesCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetPagesCol ( string value )

Sets value for pages column

Parameters

value The page selection only leveraged for multi-page PDF and TIFF documents. Accepted input include single pages (e.g.'1, 2' -> pages 1 and 2 will be processed), finite (e.g. '2-5' -> pages 2 to 5 will be processed) and open-ended ranges (e.g. '5-' -> all the pages from page 5 will be processed; e.g. '-10' -> pages 1 to 10 will be processed). All of these can be mixed together and ranges are allowed to overlap (eg. '-5, 1, 3, 5-10' - pages 1 to 10 will be processed). The service will accept the request if it can process at least one page of the document (e.g. using '5-100' on a 5 page document is a valid input where page 5 will be processed). If no page range is provided, the entire document will be processed.

Returns: New AnalyzeLayout object

◆ SetPollingDelay()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetPollingDelay ( int value )

Sets value for pollingDelay

Parameters

value number of milliseconds to wait between polling

Returns: New AnalyzeLayout object

◆ SetReadingOrder()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetReadingOrder ( string value )

Sets value for readingOrder

Parameters

value Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to basic if not specified

Returns: New AnalyzeLayout object

◆ SetReadingOrderCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetReadingOrderCol ( string value )

Sets value for readingOrder column

Parameters

value Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either 'basic' or 'natural'. Will default to basic if not specified

Returns: New AnalyzeLayout object

◆ SetSubscriptionKey()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New AnalyzeLayout object

◆ SetSubscriptionKeyCol()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New AnalyzeLayout object

◆ SetSuppressMaxRetriesException()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetSuppressMaxRetriesException ( bool value )

Sets value for suppressMaxRetriesException

Parameters

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

Returns: New AnalyzeLayout object

◆ SetTimeout()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New AnalyzeLayout object

◆ SetUrl()

AnalyzeLayout Synapse.ML.Services.Form.AnalyzeLayout.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New AnalyzeLayout object

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

synapse/ml/services/form/AnalyzeLayout.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AnalyzeLayout() [1/2]

◆ AnalyzeLayout() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetBackoffs()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetImageBytes()

◆ GetImageUrl()

◆ GetInitialPollingDelay()

◆ GetLanguage()

◆ GetMaxPollingRetries()

◆ GetOutputCol()

◆ GetPages()

◆ GetPollingDelay()

◆ GetReadingOrder()

◆ GetSubscriptionKey()

◆ GetSuppressMaxRetriesException()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetBackoffs()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetImageBytes()

◆ SetImageBytesCol()

◆ SetImageUrl()

◆ SetImageUrlCol()

◆ SetInitialPollingDelay()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetMaxPollingRetries()

◆ SetOutputCol()

◆ SetPages()

◆ SetPagesCol()

◆ SetPollingDelay()

◆ SetReadingOrder()

◆ SetReadingOrderCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetSuppressMaxRetriesException()

◆ SetTimeout()

◆ SetUrl()