|
Synapseml
1.0.4
|
AnalyzeDocument implements AnalyzeDocument More...


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 | SetAADToken (string value) |
| Sets value for AADToken More... | |
| AnalyzeDocument | SetAADTokenCol (string value) |
| Sets value for AADToken column More... | |
| AnalyzeDocument | SetCustomAuthHeader (string value) |
| Sets value for CustomAuthHeader More... | |
| AnalyzeDocument | SetCustomAuthHeaderCol (string value) |
| Sets value for CustomAuthHeader column 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 | SetSuppressMaxRetriesException (bool value) |
| Sets value for suppressMaxRetriesException More... | |
| AnalyzeDocument | SetTimeout (double value) |
| Sets value for timeout More... | |
| AnalyzeDocument | SetUrl (string value) |
| Sets value for url More... | |
| string | GetAADToken () |
| Gets AADToken value More... | |
| string | GetCustomAuthHeader () |
| Gets CustomAuthHeader value 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 | 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 () |
| |
| JavaMLReader< AnalyzeDocument > | Read () |
| Get the corresponding JavaMLReader instance. More... | |
| AnalyzeDocument | SetCustomServiceName (string value) |
| Sets value for service name More... | |
| AnalyzeDocument | SetEndpoint (string value) |
| Sets value for endpoint More... | |
| AnalyzeDocument | SetLocation (string value) |
| Sets value for location More... | |
| AnalyzeDocument | SetLinkedService (string value) |
| Sets value for linkedService More... | |
Static Public Member Functions | |
| static AnalyzeDocument | Load (string path) |
| Loads the AnalyzeDocument that was previously saved using Save(string). More... | |
AnalyzeDocument implements AnalyzeDocument
|
inline |
Creates a AnalyzeDocument without any parameters.
|
inline |
Creates a AnalyzeDocument with a UID that is used to give the AnalyzeDocument a unique ID.
| uid | An immutable unique ID for the object and its derivatives. |
| string Synapse.ML.Services.Form.AnalyzeDocument.GetAADToken | ( | ) |
Gets AADToken value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetApiVersion | ( | ) |
Gets apiVersion value
| int [] Synapse.ML.Services.Form.AnalyzeDocument.GetBackoffs | ( | ) |
Gets backoffs value
| int Synapse.ML.Services.Form.AnalyzeDocument.GetConcurrency | ( | ) |
Gets concurrency value
| double Synapse.ML.Services.Form.AnalyzeDocument.GetConcurrentTimeout | ( | ) |
Gets concurrentTimeout value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetCustomAuthHeader | ( | ) |
Gets CustomAuthHeader value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetErrorCol | ( | ) |
Gets errorCol value
| byte [] Synapse.ML.Services.Form.AnalyzeDocument.GetImageBytes | ( | ) |
Gets imageBytes value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetImageUrl | ( | ) |
Gets imageUrl value
| int Synapse.ML.Services.Form.AnalyzeDocument.GetInitialPollingDelay | ( | ) |
Gets initialPollingDelay value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetLocale | ( | ) |
Gets locale value
| int Synapse.ML.Services.Form.AnalyzeDocument.GetMaxPollingRetries | ( | ) |
Gets maxPollingRetries value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetOutputCol | ( | ) |
Gets outputCol value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetPages | ( | ) |
Gets pages value
| int Synapse.ML.Services.Form.AnalyzeDocument.GetPollingDelay | ( | ) |
Gets pollingDelay value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetPrebuiltModelId | ( | ) |
Gets prebuiltModelId value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetStringIndexType | ( | ) |
Gets stringIndexType value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetSubscriptionKey | ( | ) |
Gets subscriptionKey value
| bool Synapse.ML.Services.Form.AnalyzeDocument.GetSuppressMaxRetriesException | ( | ) |
Gets suppressMaxRetriesException value
| double Synapse.ML.Services.Form.AnalyzeDocument.GetTimeout | ( | ) |
Gets timeout value
| string Synapse.ML.Services.Form.AnalyzeDocument.GetUrl | ( | ) |
Gets url value
|
static |
Loads the AnalyzeDocument that was previously saved using Save(string).
| path | The path the previous AnalyzeDocument was saved to |
| JavaMLReader<AnalyzeDocument> Synapse.ML.Services.Form.AnalyzeDocument.Read | ( | ) |
Get the corresponding JavaMLReader instance.
| void Synapse.ML.Services.Form.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.
| path | The path to save the object to |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetAADToken | ( | string | value | ) |
Sets value for AADToken
| value | AAD Token used for authentication |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetAADTokenCol | ( | string | value | ) |
Sets value for AADToken column
| value | AAD Token used for authentication |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetApiVersion | ( | string | value | ) |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetApiVersionCol | ( | string | value | ) |
Sets value for apiVersion column
| value | version of the api |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetBackoffs | ( | int[] | value | ) |
Sets value for backoffs
| value | array of backoffs to use in the handler |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetConcurrency | ( | int | value | ) |
Sets value for concurrency
| value | max number of concurrent calls |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetConcurrentTimeout | ( | double | value | ) |
Sets value for concurrentTimeout
| value | max number seconds to wait on futures if concurrency >= 1 |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetCustomAuthHeader | ( | string | value | ) |
Sets value for CustomAuthHeader
| value | A Custom Value for Authorization Header |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetCustomAuthHeaderCol | ( | string | value | ) |
Sets value for CustomAuthHeader column
| value | A Custom Value for Authorization Header |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetCustomServiceName | ( | string | value | ) |
Sets value for service name
| value | Service name of the cognitive service if it's custom domain |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetEndpoint | ( | string | value | ) |
Sets value for endpoint
| value | Endpoint of the cognitive service |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetErrorCol | ( | string | value | ) |
Sets value for errorCol
| value | column to hold http errors |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetImageBytes | ( | byte[] | value | ) |
Sets value for imageBytes
| value | bytestream of the image to use |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetImageBytesCol | ( | string | value | ) |
Sets value for imageBytes column
| value | bytestream of the image to use |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetImageUrl | ( | string | value | ) |
Sets value for imageUrl
| value | the url of the image to use |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetImageUrlCol | ( | string | value | ) |
Sets value for imageUrl column
| value | the url of the image to use |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetInitialPollingDelay | ( | int | value | ) |
Sets value for initialPollingDelay
| value | number of milliseconds to wait before first poll for result |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetLinkedService | ( | string | value | ) |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetLocale | ( | string | value | ) |
Sets value for locale
| value | Locale of the receipt. Supported locales: en-AU, en-CA, en-GB, en-IN, en-US. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetLocaleCol | ( | string | value | ) |
Sets value for locale column
| value | Locale of the receipt. Supported locales: en-AU, en-CA, en-GB, en-IN, en-US. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetLocation | ( | string | value | ) |
Sets value for location
| value | Location of the cognitive service |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetMaxPollingRetries | ( | int | value | ) |
Sets value for maxPollingRetries
| value | number of times to poll |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetOutputCol | ( | string | value | ) |
Sets value for outputCol
| value | The name of the output column |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetPages | ( | string | value | ) |
Sets value for pages
| 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. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetPagesCol | ( | string | value | ) |
Sets value for pages column
| 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. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetPollingDelay | ( | int | value | ) |
Sets value for pollingDelay
| value | number of milliseconds to wait between polling |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetPrebuiltModelId | ( | string | value | ) |
Sets value for prebuiltModelId
| value | 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 |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetPrebuiltModelIdCol | ( | string | value | ) |
Sets value for prebuiltModelId column
| value | 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 |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetStringIndexType | ( | string | value | ) |
Sets value for stringIndexType
| value | Method used to compute string offset and length. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetStringIndexTypeCol | ( | string | value | ) |
Sets value for stringIndexType column
| value | Method used to compute string offset and length. |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetSubscriptionKey | ( | string | value | ) |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetSubscriptionKeyCol | ( | string | value | ) |
Sets value for subscriptionKey column
| value | the API key to use |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetSuppressMaxRetriesException | ( | bool | value | ) |
Sets value for suppressMaxRetriesException
| value | set true to suppress the maxumimum retries exception and report in the error column |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetTimeout | ( | double | value | ) |
Sets value for timeout
| value | number of seconds to wait before closing the connection |
| AnalyzeDocument Synapse.ML.Services.Form.AnalyzeDocument.SetUrl | ( | string | value | ) |
1.8.17