Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.AnalyzeLayout Class Reference

AnalyzeLayout implements AnalyzeLayout More...

Inheritance diagram for Synapse.ML.Cognitive.AnalyzeLayout:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.AnalyzeLayout:
Collaboration graph
[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 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 SetModelVersion (string value)
 Sets value for modelVersion More...
 
AnalyzeLayout SetModelVersionCol (string value)
 Sets value for modelVersion column 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 SetSuppressMaxRetriesExceededException (bool value)
 Sets value for suppressMaxRetriesExceededException More...
 
AnalyzeLayout SetTimeout (double value)
 Sets value for timeout More...
 
AnalyzeLayout 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...
 
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 GetModelVersion ()
 Gets modelVersion 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 GetSuppressMaxRetriesExceededException ()
 Gets suppressMaxRetriesExceededException 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< AnalyzeLayoutRead ()
 Get the corresponding JavaMLReader instance. 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.Cognitive.AnalyzeLayout.AnalyzeLayout ( )
inline

Creates a AnalyzeLayout without any parameters.

◆ AnalyzeLayout() [2/2]

Synapse.ML.Cognitive.AnalyzeLayout.AnalyzeLayout ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetBackoffs()

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

Gets backoffs value

Returns
backoffs: array of backoffs to use in the handler

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetImageBytes()

byte [] Synapse.ML.Cognitive.AnalyzeLayout.GetImageBytes ( )

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

string Synapse.ML.Cognitive.AnalyzeLayout.GetImageUrl ( )

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetInitialPollingDelay()

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

Gets initialPollingDelay value

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

◆ GetLanguage()

string Synapse.ML.Cognitive.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.Cognitive.AnalyzeLayout.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns
maxPollingRetries: number of times to poll

◆ GetModelVersion()

string Synapse.ML.Cognitive.AnalyzeLayout.GetModelVersion ( )

Gets modelVersion value

Returns
modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPages()

string Synapse.ML.Cognitive.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.Cognitive.AnalyzeLayout.GetPollingDelay ( )

Gets pollingDelay value

Returns
pollingDelay: number of milliseconds to wait between polling

◆ GetReadingOrder()

string Synapse.ML.Cognitive.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.Cognitive.AnalyzeLayout.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

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

Gets suppressMaxRetriesExceededException value

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

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

Parameters
pathThe path the previous AnalyzeLayout was saved to
Returns
New AnalyzeLayout object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.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
pathThe path to save the object to

◆ SetBackoffs()

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

Sets value for backoffs

Parameters
valuearray of backoffs to use in the handler
Returns
New AnalyzeLayout object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New AnalyzeLayout object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters
valuemax number seconds to wait on futures if concurrency >= 1
Returns
New AnalyzeLayout object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New AnalyzeLayout object

◆ SetImageBytes()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetImageBytes ( byte []  value)

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New AnalyzeLayout object

◆ SetImageBytesCol()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetImageBytesCol ( string  value)

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New AnalyzeLayout object

◆ SetImageUrl()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetImageUrl ( string  value)

Sets value for imageUrl

Parameters
valuethe url of the image to use
Returns
New AnalyzeLayout object

◆ SetImageUrlCol()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetImageUrlCol ( string  value)

Sets value for imageUrl column

Parameters
valuethe url of the image to use
Returns
New AnalyzeLayout object

◆ SetInitialPollingDelay()

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

Sets value for initialPollingDelay

Parameters
valuenumber of milliseconds to wait before first poll for result
Returns
New AnalyzeLayout object

◆ SetLanguage()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetLanguage ( string  value)

Sets value for language

Parameters
valueThe 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.Cognitive.AnalyzeLayout.SetLanguageCol ( string  value)

Sets value for language column

Parameters
valueThe 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.Cognitive.AnalyzeLayout.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New AnalyzeLayout object

◆ SetLocation()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetLocation ( string  value)

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New AnalyzeLayout object

◆ SetMaxPollingRetries()

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

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New AnalyzeLayout object

◆ SetModelVersion()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetModelVersion ( string  value)

Sets value for modelVersion

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New AnalyzeLayout object

◆ SetModelVersionCol()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetModelVersionCol ( string  value)

Sets value for modelVersion column

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New AnalyzeLayout object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New AnalyzeLayout object

◆ SetPages()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetPages ( string  value)

Sets value for pages

Parameters
valueThe 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.Cognitive.AnalyzeLayout.SetPagesCol ( string  value)

Sets value for pages column

Parameters
valueThe 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.Cognitive.AnalyzeLayout.SetPollingDelay ( int  value)

Sets value for pollingDelay

Parameters
valuenumber of milliseconds to wait between polling
Returns
New AnalyzeLayout object

◆ SetReadingOrder()

AnalyzeLayout Synapse.ML.Cognitive.AnalyzeLayout.SetReadingOrder ( string  value)

Sets value for readingOrder

Parameters
valueOptional 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.Cognitive.AnalyzeLayout.SetReadingOrderCol ( string  value)

Sets value for readingOrder column

Parameters
valueOptional 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.Cognitive.AnalyzeLayout.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New AnalyzeLayout object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New AnalyzeLayout object

◆ SetSuppressMaxRetriesExceededException()

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

Sets value for suppressMaxRetriesExceededException

Parameters
valueset true to suppress the maxumimum retries exception and report in the error column
Returns
New AnalyzeLayout object

◆ SetTimeout()

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

Sets value for timeout

Parameters
valuenumber of seconds to wait before closing the connection
Returns
New AnalyzeLayout object

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New AnalyzeLayout object

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