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

OCR implements OCR More...

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

Public Member Functions

 OCR ()
 Creates a OCR without any parameters. More...
 
 OCR (string uid)
 Creates a OCR with a UID that is used to give the OCR a unique ID. More...
 
OCR SetConcurrency (int value)
 Sets value for concurrency More...
 
OCR SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
OCR SetDetectOrientation (bool value)
 Sets value for detectOrientation More...
 
OCR SetDetectOrientationCol (string value)
 Sets value for detectOrientation column More...
 
OCR SetErrorCol (string value)
 Sets value for errorCol More...
 
OCR SetHandler (object value)
 Sets value for handler More...
 
OCR SetImageBytes (byte[] value)
 Sets value for imageBytes More...
 
OCR SetImageBytesCol (string value)
 Sets value for imageBytes column More...
 
OCR SetImageUrl (string value)
 Sets value for imageUrl More...
 
OCR SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
OCR SetLanguage (string value)
 Sets value for language More...
 
OCR SetLanguageCol (string value)
 Sets value for language column More...
 
OCR SetOutputCol (string value)
 Sets value for outputCol More...
 
OCR SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
OCR SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
OCR SetTimeout (double value)
 Sets value for timeout More...
 
OCR SetUrl (string value)
 Sets value for url More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
bool GetDetectOrientation ()
 Gets detectOrientation value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
object GetHandler ()
 Gets handler value More...
 
byte [] GetImageBytes ()
 Gets imageBytes value More...
 
string GetImageUrl ()
 Gets imageUrl value More...
 
string GetLanguage ()
 Gets language value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey 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< OCRRead ()
 Get the corresponding JavaMLReader instance. More...
 
OCR SetLocation (string value)
 Sets value for location More...
 
OCR SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

OCR implements OCR

Constructor & Destructor Documentation

◆ OCR() [1/2]

Synapse.ML.Cognitive.OCR.OCR ( )
inline

Creates a OCR without any parameters.

◆ OCR() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetDetectOrientation()

bool Synapse.ML.Cognitive.OCR.GetDetectOrientation ( )

Gets detectOrientation value

Returns
detectOrientation: whether to detect image orientation prior to processing

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Cognitive.OCR.GetHandler ( )

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetImageBytes()

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

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

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

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetLanguage()

string Synapse.ML.Cognitive.OCR.GetLanguage ( )

Gets language value

Returns
language: the language to use

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New OCR object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetDetectOrientation()

OCR Synapse.ML.Cognitive.OCR.SetDetectOrientation ( bool  value)

Sets value for detectOrientation

Parameters
valuewhether to detect image orientation prior to processing
Returns
New OCR object

◆ SetDetectOrientationCol()

OCR Synapse.ML.Cognitive.OCR.SetDetectOrientationCol ( string  value)

Sets value for detectOrientation column

Parameters
valuewhether to detect image orientation prior to processing
Returns
New OCR object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New OCR object

◆ SetHandler()

OCR Synapse.ML.Cognitive.OCR.SetHandler ( object  value)

Sets value for handler

Parameters
valueWhich strategy to use when handling requests
Returns
New OCR object

◆ SetImageBytes()

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

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New OCR object

◆ SetImageBytesCol()

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

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New OCR object

◆ SetImageUrl()

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

Sets value for imageUrl

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

◆ SetImageUrlCol()

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

Sets value for imageUrl column

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

◆ SetLanguage()

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

Sets value for language

Parameters
valuethe language to use
Returns
New OCR object

◆ SetLanguageCol()

OCR Synapse.ML.Cognitive.OCR.SetLanguageCol ( string  value)

Sets value for language column

Parameters
valuethe language to use
Returns
New OCR object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New OCR object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New OCR object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New OCR object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New OCR object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New OCR object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New OCR object

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