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

AnalyzeDocument implements AnalyzeDocument More...

Inheritance diagram for Synapse.ML.Cognitive.AnalyzeDocument:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.AnalyzeDocument:
Collaboration graph
[legend]

Public Member Functions

 AnalyzeDocument ()
 Creates a AnalyzeDocument without any parameters. More...
 
 AnalyzeDocument (string uid)
 Creates a AnalyzeDocument with a UID that is used to give the AnalyzeDocument a unique ID. More...
 
AnalyzeDocument SetApiVersion (string value)
 Sets value for apiVersion More...
 
AnalyzeDocument SetApiVersionCol (string value)
 Sets value for apiVersion column More...
 
AnalyzeDocument SetBackoffs (int[] value)
 Sets value for backoffs More...
 
AnalyzeDocument SetConcurrency (int value)
 Sets value for concurrency More...
 
AnalyzeDocument SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
AnalyzeDocument SetErrorCol (string value)
 Sets value for errorCol More...
 
AnalyzeDocument SetImageBytes (byte[] value)
 Sets value for imageBytes More...
 
AnalyzeDocument SetImageBytesCol (string value)
 Sets value for imageBytes column More...
 
AnalyzeDocument SetImageUrl (string value)
 Sets value for imageUrl More...
 
AnalyzeDocument SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
AnalyzeDocument SetInitialPollingDelay (int value)
 Sets value for initialPollingDelay More...
 
AnalyzeDocument SetLocale (string value)
 Sets value for locale More...
 
AnalyzeDocument SetLocaleCol (string value)
 Sets value for locale column More...
 
AnalyzeDocument SetMaxPollingRetries (int value)
 Sets value for maxPollingRetries More...
 
AnalyzeDocument SetOutputCol (string value)
 Sets value for outputCol More...
 
AnalyzeDocument SetPages (string value)
 Sets value for pages More...
 
AnalyzeDocument SetPagesCol (string value)
 Sets value for pages column More...
 
AnalyzeDocument SetPollingDelay (int value)
 Sets value for pollingDelay More...
 
AnalyzeDocument SetPrebuiltModelId (string value)
 Sets value for prebuiltModelId More...
 
AnalyzeDocument SetPrebuiltModelIdCol (string value)
 Sets value for prebuiltModelId column More...
 
AnalyzeDocument SetStringIndexType (string value)
 Sets value for stringIndexType More...
 
AnalyzeDocument SetStringIndexTypeCol (string value)
 Sets value for stringIndexType column More...
 
AnalyzeDocument SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
AnalyzeDocument SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
AnalyzeDocument SetSuppressMaxRetriesExceededException (bool value)
 Sets value for suppressMaxRetriesExceededException More...
 
AnalyzeDocument SetTimeout (double value)
 Sets value for timeout More...
 
AnalyzeDocument SetUrl (string value)
 Sets value for url More...
 
string GetApiVersion ()
 Gets apiVersion 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 GetLocale ()
 Gets locale 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 GetPrebuiltModelId ()
 Gets prebuiltModelId value More...
 
string GetStringIndexType ()
 Gets stringIndexType 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< AnalyzeDocumentRead ()
 Get the corresponding JavaMLReader instance. More...
 
AnalyzeDocument SetLocation (string value)
 Sets value for location More...
 

Static Public Member Functions

static AnalyzeDocument Load (string path)
 Loads the AnalyzeDocument that was previously saved using Save(string). More...
 

Detailed Description

AnalyzeDocument implements AnalyzeDocument

Constructor & Destructor Documentation

◆ AnalyzeDocument() [1/2]

Synapse.ML.Cognitive.AnalyzeDocument.AnalyzeDocument ( )
inline

Creates a AnalyzeDocument without any parameters.

◆ AnalyzeDocument() [2/2]

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

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

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

Member Function Documentation

◆ GetApiVersion()

string Synapse.ML.Cognitive.AnalyzeDocument.GetApiVersion ( )

Gets apiVersion value

Returns
apiVersion: version of the api

◆ GetBackoffs()

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

Gets backoffs value

Returns
backoffs: array of backoffs to use in the handler

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetImageBytes()

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

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

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

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetInitialPollingDelay()

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

Gets initialPollingDelay value

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

◆ GetLocale()

string Synapse.ML.Cognitive.AnalyzeDocument.GetLocale ( )

Gets locale value

Returns
locale: Locale of the receipt. Supported locales: en-AU, en-CA, en-GB, en-IN, en-US.

◆ GetMaxPollingRetries()

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

Gets maxPollingRetries value

Returns
maxPollingRetries: number of times to poll

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPages()

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

Gets pollingDelay value

Returns
pollingDelay: number of milliseconds to wait between polling

◆ GetPrebuiltModelId()

string Synapse.ML.Cognitive.AnalyzeDocument.GetPrebuiltModelId ( )

Gets prebuiltModelId value

Returns
prebuiltModelId: Prebuilt Model identifier for Form Recognizer V3.0, supported modelId: prebuilt-read, prebuilt-layout,prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt,or your custom modelId

◆ GetStringIndexType()

string Synapse.ML.Cognitive.AnalyzeDocument.GetStringIndexType ( )

Gets stringIndexType value

Returns
stringIndexType: Method used to compute string offset and length.

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.AnalyzeDocument.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.AnalyzeDocument.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.AnalyzeDocument.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

◆ SetApiVersion()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetApiVersion ( string  value)

Sets value for apiVersion

Parameters
valueversion of the api
Returns
New AnalyzeDocument object

◆ SetApiVersionCol()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetApiVersionCol ( string  value)

Sets value for apiVersion column

Parameters
valueversion of the api
Returns
New AnalyzeDocument object

◆ SetBackoffs()

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

Sets value for backoffs

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

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New AnalyzeDocument object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New AnalyzeDocument object

◆ SetImageBytes()

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

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New AnalyzeDocument object

◆ SetImageBytesCol()

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

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New AnalyzeDocument object

◆ SetImageUrl()

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

Sets value for imageUrl

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

◆ SetImageUrlCol()

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

Sets value for imageUrl column

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

◆ SetInitialPollingDelay()

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

Sets value for initialPollingDelay

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

◆ SetLocale()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetLocale ( string  value)

Sets value for locale

Parameters
valueLocale of the receipt. Supported locales: en-AU, en-CA, en-GB, en-IN, en-US.
Returns
New AnalyzeDocument object

◆ SetLocaleCol()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetLocaleCol ( string  value)

Sets value for locale column

Parameters
valueLocale of the receipt. Supported locales: en-AU, en-CA, en-GB, en-IN, en-US.
Returns
New AnalyzeDocument object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New AnalyzeDocument object

◆ SetMaxPollingRetries()

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

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New AnalyzeDocument object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New AnalyzeDocument object

◆ SetPages()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.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 AnalyzeDocument object

◆ SetPagesCol()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.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 AnalyzeDocument object

◆ SetPollingDelay()

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

Sets value for pollingDelay

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

◆ SetPrebuiltModelId()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetPrebuiltModelId ( string  value)

Sets value for prebuiltModelId

Parameters
valuePrebuilt Model identifier for Form Recognizer V3.0, supported modelId: prebuilt-read, prebuilt-layout,prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt,or your custom modelId
Returns
New AnalyzeDocument object

◆ SetPrebuiltModelIdCol()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetPrebuiltModelIdCol ( string  value)

Sets value for prebuiltModelId column

Parameters
valuePrebuilt Model identifier for Form Recognizer V3.0, supported modelId: prebuilt-read, prebuilt-layout,prebuilt-document, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt,or your custom modelId
Returns
New AnalyzeDocument object

◆ SetStringIndexType()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetStringIndexType ( string  value)

Sets value for stringIndexType

Parameters
valueMethod used to compute string offset and length.
Returns
New AnalyzeDocument object

◆ SetStringIndexTypeCol()

AnalyzeDocument Synapse.ML.Cognitive.AnalyzeDocument.SetStringIndexTypeCol ( string  value)

Sets value for stringIndexType column

Parameters
valueMethod used to compute string offset and length.
Returns
New AnalyzeDocument object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New AnalyzeDocument object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New AnalyzeDocument object

◆ SetSuppressMaxRetriesExceededException()

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

Sets value for suppressMaxRetriesExceededException

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

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New AnalyzeDocument object

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