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

AnalyzeImage implements AnalyzeImage More...

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

Public Member Functions

 AnalyzeImage ()
 Creates a AnalyzeImage without any parameters. More...
 
 AnalyzeImage (string uid)
 Creates a AnalyzeImage with a UID that is used to give the AnalyzeImage a unique ID. More...
 
AnalyzeImage SetConcurrency (int value)
 Sets value for concurrency More...
 
AnalyzeImage SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
AnalyzeImage SetDescriptionExclude (string[] value)
 Sets value for descriptionExclude More...
 
AnalyzeImage SetDescriptionExcludeCol (string value)
 Sets value for descriptionExclude column More...
 
AnalyzeImage SetDetails (string[] value)
 Sets value for details More...
 
AnalyzeImage SetDetailsCol (string value)
 Sets value for details column More...
 
AnalyzeImage SetErrorCol (string value)
 Sets value for errorCol More...
 
AnalyzeImage SetHandler (object value)
 Sets value for handler More...
 
AnalyzeImage SetImageBytes (byte[] value)
 Sets value for imageBytes More...
 
AnalyzeImage SetImageBytesCol (string value)
 Sets value for imageBytes column More...
 
AnalyzeImage SetImageUrl (string value)
 Sets value for imageUrl More...
 
AnalyzeImage SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
AnalyzeImage SetLanguage (string value)
 Sets value for language More...
 
AnalyzeImage SetLanguageCol (string value)
 Sets value for language column More...
 
AnalyzeImage SetOutputCol (string value)
 Sets value for outputCol More...
 
AnalyzeImage SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
AnalyzeImage SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
AnalyzeImage SetTimeout (double value)
 Sets value for timeout More...
 
AnalyzeImage SetUrl (string value)
 Sets value for url More...
 
AnalyzeImage SetVisualFeatures (string[] value)
 Sets value for visualFeatures More...
 
AnalyzeImage SetVisualFeaturesCol (string value)
 Sets value for visualFeatures column More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string[] GetDescriptionExclude ()
 Gets descriptionExclude value More...
 
string[] GetDetails ()
 Gets details 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...
 
string[] GetVisualFeatures ()
 Gets visualFeatures 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< AnalyzeImageRead ()
 Get the corresponding JavaMLReader instance. More...
 
AnalyzeImage SetLocation (string value)
 Sets value for location More...
 
AnalyzeImage SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

AnalyzeImage implements AnalyzeImage

Constructor & Destructor Documentation

◆ AnalyzeImage() [1/2]

Synapse.ML.Cognitive.AnalyzeImage.AnalyzeImage ( )
inline

Creates a AnalyzeImage without any parameters.

◆ AnalyzeImage() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetDescriptionExclude()

string [] Synapse.ML.Cognitive.AnalyzeImage.GetDescriptionExclude ( )

Gets descriptionExclude value

Returns
descriptionExclude: Whether to exclude certain parts of the model in the description

◆ GetDetails()

string [] Synapse.ML.Cognitive.AnalyzeImage.GetDetails ( )

Gets details value

Returns
details: what visual feature types to return

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetImageBytes()

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

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

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

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetLanguage()

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

Gets language value

Returns
language: the language of the response (en if none given)

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ GetVisualFeatures()

string [] Synapse.ML.Cognitive.AnalyzeImage.GetVisualFeatures ( )

Gets visualFeatures value

Returns
visualFeatures: what visual feature types to return

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New AnalyzeImage object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetDescriptionExclude()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetDescriptionExclude ( string[]  value)

Sets value for descriptionExclude

Parameters
valueWhether to exclude certain parts of the model in the description
Returns
New AnalyzeImage object

◆ SetDescriptionExcludeCol()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetDescriptionExcludeCol ( string  value)

Sets value for descriptionExclude column

Parameters
valueWhether to exclude certain parts of the model in the description
Returns
New AnalyzeImage object

◆ SetDetails()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetDetails ( string[]  value)

Sets value for details

Parameters
valuewhat visual feature types to return
Returns
New AnalyzeImage object

◆ SetDetailsCol()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetDetailsCol ( string  value)

Sets value for details column

Parameters
valuewhat visual feature types to return
Returns
New AnalyzeImage object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New AnalyzeImage object

◆ SetHandler()

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

Sets value for handler

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

◆ SetImageBytes()

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

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New AnalyzeImage object

◆ SetImageBytesCol()

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

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New AnalyzeImage object

◆ SetImageUrl()

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

Sets value for imageUrl

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

◆ SetImageUrlCol()

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

Sets value for imageUrl column

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

◆ SetLanguage()

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

Sets value for language

Parameters
valuethe language of the response (en if none given)
Returns
New AnalyzeImage object

◆ SetLanguageCol()

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

Sets value for language column

Parameters
valuethe language of the response (en if none given)
Returns
New AnalyzeImage object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New AnalyzeImage object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New AnalyzeImage object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New AnalyzeImage object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New AnalyzeImage object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New AnalyzeImage object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New AnalyzeImage object

◆ SetVisualFeatures()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetVisualFeatures ( string[]  value)

Sets value for visualFeatures

Parameters
valuewhat visual feature types to return
Returns
New AnalyzeImage object

◆ SetVisualFeaturesCol()

AnalyzeImage Synapse.ML.Cognitive.AnalyzeImage.SetVisualFeaturesCol ( string  value)

Sets value for visualFeatures column

Parameters
valuewhat visual feature types to return
Returns
New AnalyzeImage object

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