Synapse.ML.Services.Vision.OCR Class Reference

OCR implements OCR More...

Inheritance diagram for Synapse.ML.Services.Vision.OCR:

Collaboration diagram for Synapse.ML.Services.Vision.OCR:

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	SetAADToken (string value)
	Sets value for AADToken More...
OCR	SetAADTokenCol (string value)
	Sets value for AADToken column More...
OCR	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...
OCR	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column 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...
string	GetAADToken ()
	Gets AADToken value More...
string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value 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< OCR >	Read ()
	Get the corresponding JavaMLReader instance. More...
OCR	SetCustomServiceName (string value)
	Sets value for service name More...
OCR	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Vision.OCR.OCR ( )

inline

Creates a OCR without any parameters.

OCR() [2/2]

Synapse.ML.Services.Vision.OCR.OCR ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetAADToken()

string Synapse.ML.Services.Vision.OCR.GetAADToken

(

)

Gets AADToken value

Returns

AADToken: AAD Token used for authentication

GetConcurrency()

int Synapse.ML.Services.Vision.OCR.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Services.Vision.OCR.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetCustomAuthHeader()

string Synapse.ML.Services.Vision.OCR.GetCustomAuthHeader

(

)

Gets CustomAuthHeader value

Returns

CustomAuthHeader: A Custom Value for Authorization Header

GetDetectOrientation()

bool Synapse.ML.Services.Vision.OCR.GetDetectOrientation

(

)

Gets detectOrientation value

Returns

detectOrientation: whether to detect image orientation prior to processing

GetErrorCol()

string Synapse.ML.Services.Vision.OCR.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetHandler()

object Synapse.ML.Services.Vision.OCR.GetHandler

(

)

Gets handler value

Returns

handler: Which strategy to use when handling requests

GetImageBytes()

byte [] Synapse.ML.Services.Vision.OCR.GetImageBytes

(

)

Gets imageBytes value

Returns

imageBytes: bytestream of the image to use

GetImageUrl()

string Synapse.ML.Services.Vision.OCR.GetImageUrl

(

)

Gets imageUrl value

Returns

imageUrl: the url of the image to use

GetLanguage()

string Synapse.ML.Services.Vision.OCR.GetLanguage

(

)

Gets language value

Returns

language: the language to use

GetOutputCol()

string Synapse.ML.Services.Vision.OCR.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetSubscriptionKey()

string Synapse.ML.Services.Vision.OCR.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetTimeout()

double Synapse.ML.Services.Vision.OCR.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Services.Vision.OCR.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

static OCR Synapse.ML.Services.Vision.OCR.Load ( string  path )

static

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

Parameters

path	The path the previous OCR was saved to

Returns

New OCR object, loaded from path.

Read()

JavaMLReader<OCR> Synapse.ML.Services.Vision.OCR.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<OCR> instance for this ML instance.

Save()

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

path	The path to save the object to

SetAADToken()

OCR Synapse.ML.Services.Vision.OCR.SetAADToken

(

string

value

)

Sets value for AADToken

Parameters

value

AAD Token used for authentication

Returns

New OCR object

SetAADTokenCol()

OCR Synapse.ML.Services.Vision.OCR.SetAADTokenCol

(

string

value

)

Sets value for AADToken column

Parameters

value

AAD Token used for authentication

Returns

New OCR object

SetConcurrency()

OCR Synapse.ML.Services.Vision.OCR.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New OCR object

SetConcurrentTimeout()

OCR Synapse.ML.Services.Vision.OCR.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New OCR object

SetCustomAuthHeader()

OCR Synapse.ML.Services.Vision.OCR.SetCustomAuthHeader

(

string

value

)

Sets value for CustomAuthHeader

Parameters

value

A Custom Value for Authorization Header

Returns

New OCR object

SetCustomAuthHeaderCol()

OCR Synapse.ML.Services.Vision.OCR.SetCustomAuthHeaderCol

(

string

value

)

Sets value for CustomAuthHeader column

Parameters

value

A Custom Value for Authorization Header

Returns

New OCR object

SetCustomServiceName()

OCR Synapse.ML.Services.Vision.OCR.SetCustomServiceName

(

string

value

)

Sets value for service name

Parameters

value

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

Returns

New OCR object

SetDetectOrientation()

OCR Synapse.ML.Services.Vision.OCR.SetDetectOrientation

(

bool

value

)

Sets value for detectOrientation

Parameters

value

whether to detect image orientation prior to processing

Returns

New OCR object

SetDetectOrientationCol()

OCR Synapse.ML.Services.Vision.OCR.SetDetectOrientationCol

(

string

value

)

Sets value for detectOrientation column

Parameters

value

whether to detect image orientation prior to processing

Returns

New OCR object

SetEndpoint()

OCR Synapse.ML.Services.Vision.OCR.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

Endpoint of the cognitive service

Returns

New OCR object

SetErrorCol()

OCR Synapse.ML.Services.Vision.OCR.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New OCR object

SetHandler()

OCR Synapse.ML.Services.Vision.OCR.SetHandler

(

object

value

)

Sets value for handler

Parameters

value

Which strategy to use when handling requests

Returns

New OCR object

SetImageBytes()

OCR Synapse.ML.Services.Vision.OCR.SetImageBytes

(

byte[]

value

)

Sets value for imageBytes

Parameters

value

bytestream of the image to use

Returns

New OCR object

SetImageBytesCol()

OCR Synapse.ML.Services.Vision.OCR.SetImageBytesCol

(

string

value

)

Sets value for imageBytes column

Parameters

value

bytestream of the image to use

Returns

New OCR object

SetImageUrl()

OCR Synapse.ML.Services.Vision.OCR.SetImageUrl

(

string

value

)

Sets value for imageUrl

Parameters

value

the url of the image to use

Returns

New OCR object

SetImageUrlCol()

OCR Synapse.ML.Services.Vision.OCR.SetImageUrlCol

(

string

value

)

Sets value for imageUrl column

Parameters

value

the url of the image to use

Returns

New OCR object

SetLanguage()

OCR Synapse.ML.Services.Vision.OCR.SetLanguage

(

string

value

)

Sets value for language

Parameters

value

the language to use

Returns

New OCR object

SetLanguageCol()

OCR Synapse.ML.Services.Vision.OCR.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

the language to use

Returns

New OCR object

SetLinkedService()

OCR Synapse.ML.Services.Vision.OCR.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New OCR object

SetLocation()

OCR Synapse.ML.Services.Vision.OCR.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New OCR object

SetOutputCol()

OCR Synapse.ML.Services.Vision.OCR.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New OCR object

SetSubscriptionKey()

OCR Synapse.ML.Services.Vision.OCR.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New OCR object

SetSubscriptionKeyCol()

OCR Synapse.ML.Services.Vision.OCR.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New OCR object

SetTimeout()

OCR Synapse.ML.Services.Vision.OCR.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New OCR object

SetUrl()

OCR Synapse.ML.Services.Vision.OCR.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New OCR object

---

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

• synapse/ml/services/vision/OCR.cs