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

DescribeImage implements DescribeImage More...

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

Public Member Functions

 DescribeImage ()
 Creates a DescribeImage without any parameters. More...
 
 DescribeImage (string uid)
 Creates a DescribeImage with a UID that is used to give the DescribeImage a unique ID. More...
 
DescribeImage SetConcurrency (int value)
 Sets value for concurrency More...
 
DescribeImage SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
DescribeImage SetErrorCol (string value)
 Sets value for errorCol More...
 
DescribeImage SetHandler (object value)
 Sets value for handler More...
 
DescribeImage SetImageBytes (byte[] value)
 Sets value for imageBytes More...
 
DescribeImage SetImageBytesCol (string value)
 Sets value for imageBytes column More...
 
DescribeImage SetImageUrl (string value)
 Sets value for imageUrl More...
 
DescribeImage SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
DescribeImage SetLanguage (string value)
 Sets value for language More...
 
DescribeImage SetLanguageCol (string value)
 Sets value for language column More...
 
DescribeImage SetMaxCandidates (int value)
 Sets value for maxCandidates More...
 
DescribeImage SetMaxCandidatesCol (string value)
 Sets value for maxCandidates column More...
 
DescribeImage SetOutputCol (string value)
 Sets value for outputCol More...
 
DescribeImage SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
DescribeImage SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
DescribeImage SetTimeout (double value)
 Sets value for timeout More...
 
DescribeImage SetUrl (string value)
 Sets value for url More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout 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...
 
int GetMaxCandidates ()
 Gets maxCandidates 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< DescribeImageRead ()
 Get the corresponding JavaMLReader instance. More...
 
DescribeImage SetLocation (string value)
 Sets value for location More...
 
DescribeImage SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

DescribeImage implements DescribeImage

Constructor & Destructor Documentation

◆ DescribeImage() [1/2]

Synapse.ML.Cognitive.DescribeImage.DescribeImage ( )
inline

Creates a DescribeImage without any parameters.

◆ DescribeImage() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetImageBytes()

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

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

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

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetLanguage()

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

Gets language value

Returns
language: Language of image description

◆ GetMaxCandidates()

int Synapse.ML.Cognitive.DescribeImage.GetMaxCandidates ( )

Gets maxCandidates value

Returns
maxCandidates: Maximum candidate descriptions to return

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.DescribeImage.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()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New DescribeImage object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New DescribeImage object

◆ SetHandler()

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

Sets value for handler

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

◆ SetImageBytes()

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

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New DescribeImage object

◆ SetImageBytesCol()

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

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New DescribeImage object

◆ SetImageUrl()

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

Sets value for imageUrl

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

◆ SetImageUrlCol()

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

Sets value for imageUrl column

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

◆ SetLanguage()

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

Sets value for language

Parameters
valueLanguage of image description
Returns
New DescribeImage object

◆ SetLanguageCol()

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

Sets value for language column

Parameters
valueLanguage of image description
Returns
New DescribeImage object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New DescribeImage object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New DescribeImage object

◆ SetMaxCandidates()

DescribeImage Synapse.ML.Cognitive.DescribeImage.SetMaxCandidates ( int  value)

Sets value for maxCandidates

Parameters
valueMaximum candidate descriptions to return
Returns
New DescribeImage object

◆ SetMaxCandidatesCol()

DescribeImage Synapse.ML.Cognitive.DescribeImage.SetMaxCandidatesCol ( string  value)

Sets value for maxCandidates column

Parameters
valueMaximum candidate descriptions to return
Returns
New DescribeImage object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New DescribeImage object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New DescribeImage object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New DescribeImage object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New DescribeImage object

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