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

DetectFace implements DetectFace More...

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

Public Member Functions

 DetectFace ()
 Creates a DetectFace without any parameters. More...
 
 DetectFace (string uid)
 Creates a DetectFace with a UID that is used to give the DetectFace a unique ID. More...
 
DetectFace SetConcurrency (int value)
 Sets value for concurrency More...
 
DetectFace SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
DetectFace SetErrorCol (string value)
 Sets value for errorCol More...
 
DetectFace SetHandler (object value)
 Sets value for handler More...
 
DetectFace SetImageUrl (string value)
 Sets value for imageUrl More...
 
DetectFace SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
DetectFace SetOutputCol (string value)
 Sets value for outputCol More...
 
DetectFace SetReturnFaceAttributes (string[] value)
 Sets value for returnFaceAttributes More...
 
DetectFace SetReturnFaceAttributesCol (string value)
 Sets value for returnFaceAttributes column More...
 
DetectFace SetReturnFaceId (bool value)
 Sets value for returnFaceId More...
 
DetectFace SetReturnFaceIdCol (string value)
 Sets value for returnFaceId column More...
 
DetectFace SetReturnFaceLandmarks (bool value)
 Sets value for returnFaceLandmarks More...
 
DetectFace SetReturnFaceLandmarksCol (string value)
 Sets value for returnFaceLandmarks column More...
 
DetectFace SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
DetectFace SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
DetectFace SetTimeout (double value)
 Sets value for timeout More...
 
DetectFace 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...
 
string GetImageUrl ()
 Gets imageUrl value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string [] GetReturnFaceAttributes ()
 Gets returnFaceAttributes value More...
 
bool GetReturnFaceId ()
 Gets returnFaceId value More...
 
bool GetReturnFaceLandmarks ()
 Gets returnFaceLandmarks 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< DetectFaceRead ()
 Get the corresponding JavaMLReader instance. More...
 
DetectFace SetLocation (string value)
 Sets value for location More...
 
DetectFace SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

DetectFace implements DetectFace

Constructor & Destructor Documentation

◆ DetectFace() [1/2]

Synapse.ML.Cognitive.DetectFace.DetectFace ( )
inline

Creates a DetectFace without any parameters.

◆ DetectFace() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetImageUrl()

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

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetReturnFaceAttributes()

string [] Synapse.ML.Cognitive.DetectFace.GetReturnFaceAttributes ( )

Gets returnFaceAttributes value

Returns
returnFaceAttributes: Analyze and return the one or more specified face attributes Supported face attributes include: age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Face attribute analysis has additional computational and time cost.

◆ GetReturnFaceId()

bool Synapse.ML.Cognitive.DetectFace.GetReturnFaceId ( )

Gets returnFaceId value

Returns
returnFaceId: Return faceIds of the detected faces or not. The default value is true

◆ GetReturnFaceLandmarks()

bool Synapse.ML.Cognitive.DetectFace.GetReturnFaceLandmarks ( )

Gets returnFaceLandmarks value

Returns
returnFaceLandmarks: Return face landmarks of the detected faces or not. The default value is false.

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New DetectFace object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New DetectFace object

◆ SetHandler()

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

Sets value for handler

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

◆ SetImageUrl()

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

Sets value for imageUrl

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

◆ SetImageUrlCol()

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

Sets value for imageUrl column

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

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New DetectFace object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New DetectFace object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New DetectFace object

◆ SetReturnFaceAttributes()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceAttributes ( string []  value)

Sets value for returnFaceAttributes

Parameters
valueAnalyze and return the one or more specified face attributes Supported face attributes include: age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Face attribute analysis has additional computational and time cost.
Returns
New DetectFace object

◆ SetReturnFaceAttributesCol()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceAttributesCol ( string  value)

Sets value for returnFaceAttributes column

Parameters
valueAnalyze and return the one or more specified face attributes Supported face attributes include: age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Face attribute analysis has additional computational and time cost.
Returns
New DetectFace object

◆ SetReturnFaceId()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceId ( bool  value)

Sets value for returnFaceId

Parameters
valueReturn faceIds of the detected faces or not. The default value is true
Returns
New DetectFace object

◆ SetReturnFaceIdCol()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceIdCol ( string  value)

Sets value for returnFaceId column

Parameters
valueReturn faceIds of the detected faces or not. The default value is true
Returns
New DetectFace object

◆ SetReturnFaceLandmarks()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceLandmarks ( bool  value)

Sets value for returnFaceLandmarks

Parameters
valueReturn face landmarks of the detected faces or not. The default value is false.
Returns
New DetectFace object

◆ SetReturnFaceLandmarksCol()

DetectFace Synapse.ML.Cognitive.DetectFace.SetReturnFaceLandmarksCol ( string  value)

Sets value for returnFaceLandmarks column

Parameters
valueReturn face landmarks of the detected faces or not. The default value is false.
Returns
New DetectFace object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New DetectFace object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New DetectFace object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New DetectFace object

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