DetectFace implements DetectFace More...

Inheritance diagram for Synapse.ML.Services.Face.DetectFace:

[legend]

Collaboration diagram for Synapse.ML.Services.Face.DetectFace:

[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	SetAADToken (string value)
	Sets value for AADToken More...

DetectFace	SetAADTokenCol (string value)
	Sets value for AADToken column More...

DetectFace	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...

DetectFace	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column 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...

string	GetAADToken ()
	Gets AADToken value More...

string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value 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< DetectFace >	Read ()
	Get the corresponding JavaMLReader instance. More...

DetectFace	SetCustomServiceName (string value)
	Sets value for service name More...

DetectFace	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Face.DetectFace.DetectFace ( )

inline

Creates a DetectFace without any parameters.

◆ DetectFace() [2/2]

Synapse.ML.Services.Face.DetectFace.DetectFace ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Face.DetectFace.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

int Synapse.ML.Services.Face.DetectFace.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Face.DetectFace.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Face.DetectFace.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

string Synapse.ML.Services.Face.DetectFace.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Face.DetectFace.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetImageUrl()

string Synapse.ML.Services.Face.DetectFace.GetImageUrl ( )

Gets imageUrl value

Returns: imageUrl: the url of the image to use

◆ GetOutputCol()

string Synapse.ML.Services.Face.DetectFace.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetReturnFaceAttributes()

string [] Synapse.ML.Services.Face.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.Services.Face.DetectFace.GetReturnFaceId ( )

Gets returnFaceId value

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

◆ GetReturnFaceLandmarks()

bool Synapse.ML.Services.Face.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.Services.Face.DetectFace.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Services.Face.DetectFace.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Face.DetectFace.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ Load()

static DetectFace Synapse.ML.Services.Face.DetectFace.Load ( string path )

static

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

Parameters

path	The path the previous DetectFace was saved to

Returns: New DetectFace object, loaded from path.

◆ Read()

JavaMLReader<DetectFace> Synapse.ML.Services.Face.DetectFace.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

path	The path to save the object to

◆ SetAADToken()

DetectFace Synapse.ML.Services.Face.DetectFace.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New DetectFace object

◆ SetAADTokenCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New DetectFace object

◆ SetConcurrency()

DetectFace Synapse.ML.Services.Face.DetectFace.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New DetectFace object

◆ SetConcurrentTimeout()

DetectFace Synapse.ML.Services.Face.DetectFace.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New DetectFace object

◆ SetCustomAuthHeader()

DetectFace Synapse.ML.Services.Face.DetectFace.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New DetectFace object

◆ SetCustomAuthHeaderCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New DetectFace object

◆ SetCustomServiceName()

DetectFace Synapse.ML.Services.Face.DetectFace.SetCustomServiceName ( string value )

Sets value for service name

Parameters

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

Returns: New DetectFace object

◆ SetEndpoint()

DetectFace Synapse.ML.Services.Face.DetectFace.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New DetectFace object

◆ SetErrorCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New DetectFace object

◆ SetHandler()

DetectFace Synapse.ML.Services.Face.DetectFace.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New DetectFace object

◆ SetImageUrl()

DetectFace Synapse.ML.Services.Face.DetectFace.SetImageUrl ( string value )

Sets value for imageUrl

Parameters

value the url of the image to use

Returns: New DetectFace object

◆ SetImageUrlCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetImageUrlCol ( string value )

Sets value for imageUrl column

Parameters

value the url of the image to use

Returns: New DetectFace object

◆ SetLinkedService()

DetectFace Synapse.ML.Services.Face.DetectFace.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New DetectFace object

◆ SetLocation()

DetectFace Synapse.ML.Services.Face.DetectFace.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New DetectFace object

◆ SetOutputCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New DetectFace object

◆ SetReturnFaceAttributes()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceAttributes ( string[] value )

Sets value for returnFaceAttributes

Parameters

value 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.

Returns: New DetectFace object

◆ SetReturnFaceAttributesCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceAttributesCol ( string value )

Sets value for returnFaceAttributes column

Parameters

value 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.

Returns: New DetectFace object

◆ SetReturnFaceId()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceId ( bool value )

Sets value for returnFaceId

Parameters

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

Returns: New DetectFace object

◆ SetReturnFaceIdCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceIdCol ( string value )

Sets value for returnFaceId column

Parameters

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

Returns: New DetectFace object

◆ SetReturnFaceLandmarks()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceLandmarks ( bool value )

Sets value for returnFaceLandmarks

Parameters

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

Returns: New DetectFace object

◆ SetReturnFaceLandmarksCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetReturnFaceLandmarksCol ( string value )

Sets value for returnFaceLandmarks column

Parameters

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

Returns: New DetectFace object

◆ SetSubscriptionKey()

DetectFace Synapse.ML.Services.Face.DetectFace.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New DetectFace object

◆ SetSubscriptionKeyCol()

DetectFace Synapse.ML.Services.Face.DetectFace.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New DetectFace object

◆ SetTimeout()

DetectFace Synapse.ML.Services.Face.DetectFace.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New DetectFace object

◆ SetUrl()

DetectFace Synapse.ML.Services.Face.DetectFace.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New DetectFace object

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

synapse/ml/services/face/DetectFace.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DetectFace() [1/2]

◆ DetectFace() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetHandler()

◆ GetImageUrl()

◆ GetOutputCol()

◆ GetReturnFaceAttributes()

◆ GetReturnFaceId()

◆ GetReturnFaceLandmarks()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetImageUrl()

◆ SetImageUrlCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetReturnFaceAttributes()

◆ SetReturnFaceAttributesCol()

◆ SetReturnFaceId()

◆ SetReturnFaceIdCol()

◆ SetReturnFaceLandmarks()

◆ SetReturnFaceLandmarksCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()