Synapse.ML.Cognitive.ReadImage Class Reference

ReadImage implements ReadImage More...

Inheritance diagram for Synapse.ML.Cognitive.ReadImage:

Collaboration diagram for Synapse.ML.Cognitive.ReadImage:

Public Member Functions
	ReadImage ()
	Creates a ReadImage without any parameters. More...
	ReadImage (string uid)
	Creates a ReadImage with a UID that is used to give the ReadImage a unique ID. More...
ReadImage	SetBackoffs (int[] value)
	Sets value for backoffs More...
ReadImage	SetConcurrency (int value)
	Sets value for concurrency More...
ReadImage	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...
ReadImage	SetErrorCol (string value)
	Sets value for errorCol More...
ReadImage	SetImageBytes (byte[] value)
	Sets value for imageBytes More...
ReadImage	SetImageBytesCol (string value)
	Sets value for imageBytes column More...
ReadImage	SetImageUrl (string value)
	Sets value for imageUrl More...
ReadImage	SetImageUrlCol (string value)
	Sets value for imageUrl column More...
ReadImage	SetInitialPollingDelay (int value)
	Sets value for initialPollingDelay More...
ReadImage	SetLanguage (string value)
	Sets value for language More...
ReadImage	SetLanguageCol (string value)
	Sets value for language column More...
ReadImage	SetMaxPollingRetries (int value)
	Sets value for maxPollingRetries More...
ReadImage	SetOutputCol (string value)
	Sets value for outputCol More...
ReadImage	SetPollingDelay (int value)
	Sets value for pollingDelay More...
ReadImage	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...
ReadImage	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...
ReadImage	SetSuppressMaxRetriesExceededException (bool value)
	Sets value for suppressMaxRetriesExceededException More...
ReadImage	SetTimeout (double value)
	Sets value for timeout More...
ReadImage	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	GetOutputCol ()
	Gets outputCol value More...
int	GetPollingDelay ()
	Gets pollingDelay 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< ReadImage >	Read ()
	Get the corresponding JavaMLReader instance. More...
ReadImage	SetLocation (string value)
	Sets value for location More...
ReadImage	SetLinkedService (string value)
	Sets value for linkedService More...

Static Public Member Functions
static ReadImage	Load (string path)
	Loads the ReadImage that was previously saved using Save(string). More...

Detailed Description

ReadImage implements ReadImage

Constructor & Destructor Documentation

ReadImage() [1/2]

Synapse.ML.Cognitive.ReadImage.ReadImage ( )

inline

Creates a ReadImage without any parameters.

ReadImage() [2/2]

Synapse.ML.Cognitive.ReadImage.ReadImage ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetBackoffs()

int [] Synapse.ML.Cognitive.ReadImage.GetBackoffs

(

)

Gets backoffs value

Returns

backoffs: array of backoffs to use in the handler

GetConcurrency()

int Synapse.ML.Cognitive.ReadImage.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Cognitive.ReadImage.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetErrorCol()

string Synapse.ML.Cognitive.ReadImage.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetImageBytes()

byte [] Synapse.ML.Cognitive.ReadImage.GetImageBytes

(

)

Gets imageBytes value

Returns

imageBytes: bytestream of the image to use

GetImageUrl()

string Synapse.ML.Cognitive.ReadImage.GetImageUrl

(

)

Gets imageUrl value

Returns

imageUrl: the url of the image to use

GetInitialPollingDelay()

int Synapse.ML.Cognitive.ReadImage.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

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

GetLanguage()

string Synapse.ML.Cognitive.ReadImage.GetLanguage

(

)

Gets language value

Returns

language: IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read 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.ReadImage.GetMaxPollingRetries

(

)

Gets maxPollingRetries value

Returns

maxPollingRetries: number of times to poll

GetOutputCol()

string Synapse.ML.Cognitive.ReadImage.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPollingDelay()

int Synapse.ML.Cognitive.ReadImage.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSubscriptionKey()

string Synapse.ML.Cognitive.ReadImage.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.ReadImage.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.ReadImage.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Cognitive.ReadImage.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

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

static

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

Parameters

path	The path the previous ReadImage was saved to

Returns

New ReadImage object, loaded from path.

Read()

JavaMLReader<ReadImage> Synapse.ML.Cognitive.ReadImage.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<ReadImage> instance for this ML instance.

Save()

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

SetBackoffs()

ReadImage Synapse.ML.Cognitive.ReadImage.SetBackoffs

(

int []

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New ReadImage object

SetConcurrency()

ReadImage Synapse.ML.Cognitive.ReadImage.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New ReadImage object

SetConcurrentTimeout()

ReadImage Synapse.ML.Cognitive.ReadImage.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New ReadImage object

SetErrorCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New ReadImage object

SetImageBytes()

ReadImage Synapse.ML.Cognitive.ReadImage.SetImageBytes

(

byte []

value

)

Sets value for imageBytes

Parameters

value

bytestream of the image to use

Returns

New ReadImage object

SetImageBytesCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetImageBytesCol

(

string

value

)

Sets value for imageBytes column

Parameters

value

bytestream of the image to use

Returns

New ReadImage object

SetImageUrl()

ReadImage Synapse.ML.Cognitive.ReadImage.SetImageUrl

(

string

value

)

Sets value for imageUrl

Parameters

value

the url of the image to use

Returns

New ReadImage object

SetImageUrlCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetImageUrlCol

(

string

value

)

Sets value for imageUrl column

Parameters

value

the url of the image to use

Returns

New ReadImage object

SetInitialPollingDelay()

ReadImage Synapse.ML.Cognitive.ReadImage.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number of milliseconds to wait before first poll for result

Returns

New ReadImage object

SetLanguage()

ReadImage Synapse.ML.Cognitive.ReadImage.SetLanguage

(

string

value

)

Sets value for language

Parameters

value

IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read 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 ReadImage object

SetLanguageCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetLanguageCol

(

string

value

)

Sets value for language column

Parameters

value

IThe BCP-47 language code of the text in the document. Currently, only English (en), Dutch (nl), French (fr), German (de), Italian (it), Portuguese (pt), and Spanish (es) are supported. Read 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 ReadImage object

SetLinkedService()

ReadImage Synapse.ML.Cognitive.ReadImage.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New ReadImage object

SetLocation()

ReadImage Synapse.ML.Cognitive.ReadImage.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New ReadImage object

SetMaxPollingRetries()

ReadImage Synapse.ML.Cognitive.ReadImage.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New ReadImage object

SetOutputCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New ReadImage object

SetPollingDelay()

ReadImage Synapse.ML.Cognitive.ReadImage.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New ReadImage object

SetSubscriptionKey()

ReadImage Synapse.ML.Cognitive.ReadImage.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New ReadImage object

SetSubscriptionKeyCol()

ReadImage Synapse.ML.Cognitive.ReadImage.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New ReadImage object

SetSuppressMaxRetriesExceededException()

ReadImage Synapse.ML.Cognitive.ReadImage.SetSuppressMaxRetriesExceededException

(

bool

value

)

Sets value for suppressMaxRetriesExceededException

Parameters

value

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

Returns

New ReadImage object

SetTimeout()

ReadImage Synapse.ML.Cognitive.ReadImage.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New ReadImage object

SetUrl()

ReadImage Synapse.ML.Cognitive.ReadImage.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New ReadImage object

---

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

• synapse/ml/cognitive/ReadImage.cs