IdentifyFaces implements IdentifyFaces More...

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

[legend]

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

[legend]

Public Member Functions
	IdentifyFaces ()
	Creates a IdentifyFaces without any parameters. More...

	IdentifyFaces (string uid)
	Creates a IdentifyFaces with a UID that is used to give the IdentifyFaces a unique ID. More...

IdentifyFaces	SetAADToken (string value)
	Sets value for AADToken More...

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

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

IdentifyFaces	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column More...

IdentifyFaces	SetConcurrency (int value)
	Sets value for concurrency More...

IdentifyFaces	SetConcurrentTimeout (double value)
	Sets value for concurrentTimeout More...

IdentifyFaces	SetConfidenceThreshold (double value)
	Sets value for confidenceThreshold More...

IdentifyFaces	SetConfidenceThresholdCol (string value)
	Sets value for confidenceThreshold column More...

IdentifyFaces	SetErrorCol (string value)
	Sets value for errorCol More...

IdentifyFaces	SetFaceIds (string[] value)
	Sets value for faceIds More...

IdentifyFaces	SetFaceIdsCol (string value)
	Sets value for faceIds column More...

IdentifyFaces	SetHandler (object value)
	Sets value for handler More...

IdentifyFaces	SetLargePersonGroupId (string value)
	Sets value for largePersonGroupId More...

IdentifyFaces	SetLargePersonGroupIdCol (string value)
	Sets value for largePersonGroupId column More...

IdentifyFaces	SetMaxNumOfCandidatesReturned (int value)
	Sets value for maxNumOfCandidatesReturned More...

IdentifyFaces	SetMaxNumOfCandidatesReturnedCol (string value)
	Sets value for maxNumOfCandidatesReturned column More...

IdentifyFaces	SetOutputCol (string value)
	Sets value for outputCol More...

IdentifyFaces	SetPersonGroupId (string value)
	Sets value for personGroupId More...

IdentifyFaces	SetPersonGroupIdCol (string value)
	Sets value for personGroupId column More...

IdentifyFaces	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

IdentifyFaces	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

IdentifyFaces	SetTimeout (double value)
	Sets value for timeout More...

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

double	GetConfidenceThreshold ()
	Gets confidenceThreshold value More...

string	GetErrorCol ()
	Gets errorCol value More...

string[]	GetFaceIds ()
	Gets faceIds value More...

object	GetHandler ()
	Gets handler value More...

string	GetLargePersonGroupId ()
	Gets largePersonGroupId value More...

int	GetMaxNumOfCandidatesReturned ()
	Gets maxNumOfCandidatesReturned value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetPersonGroupId ()
	Gets personGroupId 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< IdentifyFaces >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

IdentifyFaces	SetEndpoint (string value)
	Sets value for endpoint More...

IdentifyFaces	SetLocation (string value)
	Sets value for location More...

IdentifyFaces	SetLinkedService (string value)
	Sets value for linkedService More...

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

Detailed Description

IdentifyFaces implements IdentifyFaces

Constructor & Destructor Documentation

◆ IdentifyFaces() [1/2]

Synapse.ML.Services.Face.IdentifyFaces.IdentifyFaces ( )

inline

Creates a IdentifyFaces without any parameters.

◆ IdentifyFaces() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

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

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetConfidenceThreshold()

double Synapse.ML.Services.Face.IdentifyFaces.GetConfidenceThreshold ( )

Gets confidenceThreshold value

Returns: confidenceThreshold: Optional parameter.Customized identification confidence threshold, in the range of [0, 1].Advanced user can tweak this value to override defaultinternal threshold for better precision on their scenario data.Note there is no guarantee of this threshold value workingon other data and after algorithm updates.

◆ GetCustomAuthHeader()

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

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFaceIds()

string [] Synapse.ML.Services.Face.IdentifyFaces.GetFaceIds ( )

Gets faceIds value

Returns: faceIds: Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].

◆ GetHandler()

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

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetLargePersonGroupId()

string Synapse.ML.Services.Face.IdentifyFaces.GetLargePersonGroupId ( )

Gets largePersonGroupId value

Returns: largePersonGroupId: largePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

◆ GetMaxNumOfCandidatesReturned()

int Synapse.ML.Services.Face.IdentifyFaces.GetMaxNumOfCandidatesReturned ( )

Gets maxNumOfCandidatesReturned value

Returns: maxNumOfCandidatesReturned: The range of maxNumOfCandidatesReturned is between 1 and 100 (default is 10).

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPersonGroupId()

string Synapse.ML.Services.Face.IdentifyFaces.GetPersonGroupId ( )

Gets personGroupId value

Returns: personGroupId: personGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

◆ GetSubscriptionKey()

string Synapse.ML.Services.Face.IdentifyFaces.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous IdentifyFaces was saved to

Returns: New IdentifyFaces object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New IdentifyFaces object

◆ SetAADTokenCol()

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

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New IdentifyFaces object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New IdentifyFaces object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New IdentifyFaces object

◆ SetConfidenceThreshold()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetConfidenceThreshold ( double value )

Sets value for confidenceThreshold

Parameters

value Optional parameter.Customized identification confidence threshold, in the range of [0, 1].Advanced user can tweak this value to override defaultinternal threshold for better precision on their scenario data.Note there is no guarantee of this threshold value workingon other data and after algorithm updates.

Returns: New IdentifyFaces object

◆ SetConfidenceThresholdCol()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetConfidenceThresholdCol ( string value )

Sets value for confidenceThreshold column

Parameters

value Optional parameter.Customized identification confidence threshold, in the range of [0, 1].Advanced user can tweak this value to override defaultinternal threshold for better precision on their scenario data.Note there is no guarantee of this threshold value workingon other data and after algorithm updates.

Returns: New IdentifyFaces object

◆ SetCustomAuthHeader()

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

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New IdentifyFaces object

◆ SetCustomAuthHeaderCol()

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

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New IdentifyFaces object

◆ SetCustomServiceName()

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

Sets value for service name

Parameters

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

Returns: New IdentifyFaces object

◆ SetEndpoint()

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

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New IdentifyFaces object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New IdentifyFaces object

◆ SetFaceIds()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetFaceIds ( string[] value )

Sets value for faceIds

Parameters

value Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].

Returns: New IdentifyFaces object

◆ SetFaceIdsCol()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetFaceIdsCol ( string value )

Sets value for faceIds column

Parameters

value Array of query faces faceIds, created by the Face - Detect. Each of the faces are identified independently. The valid number of faceIds is between [1, 10].

Returns: New IdentifyFaces object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New IdentifyFaces object

◆ SetLargePersonGroupId()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetLargePersonGroupId ( string value )

Sets value for largePersonGroupId

Parameters

value largePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New IdentifyFaces object

◆ SetLargePersonGroupIdCol()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetLargePersonGroupIdCol ( string value )

Sets value for largePersonGroupId column

Parameters

value largePersonGroupId of the target large person group, created by LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New IdentifyFaces object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New IdentifyFaces object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New IdentifyFaces object

◆ SetMaxNumOfCandidatesReturned()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetMaxNumOfCandidatesReturned ( int value )

Sets value for maxNumOfCandidatesReturned

Parameters

value The range of maxNumOfCandidatesReturned is between 1 and 100 (default is 10).

Returns: New IdentifyFaces object

◆ SetMaxNumOfCandidatesReturnedCol()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetMaxNumOfCandidatesReturnedCol ( string value )

Sets value for maxNumOfCandidatesReturned column

Parameters

value The range of maxNumOfCandidatesReturned is between 1 and 100 (default is 10).

Returns: New IdentifyFaces object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New IdentifyFaces object

◆ SetPersonGroupId()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetPersonGroupId ( string value )

Sets value for personGroupId

Parameters

value personGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New IdentifyFaces object

◆ SetPersonGroupIdCol()

IdentifyFaces Synapse.ML.Services.Face.IdentifyFaces.SetPersonGroupIdCol ( string value )

Sets value for personGroupId column

Parameters

value personGroupId of the target person group, created by PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New IdentifyFaces object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New IdentifyFaces object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New IdentifyFaces object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New IdentifyFaces object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New IdentifyFaces object

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

synapse/ml/services/face/IdentifyFaces.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IdentifyFaces() [1/2]

◆ IdentifyFaces() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetConfidenceThreshold()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetFaceIds()

◆ GetHandler()

◆ GetLargePersonGroupId()

◆ GetMaxNumOfCandidatesReturned()

◆ GetOutputCol()

◆ GetPersonGroupId()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetConfidenceThreshold()

◆ SetConfidenceThresholdCol()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetFaceIds()

◆ SetFaceIdsCol()

◆ SetHandler()

◆ SetLargePersonGroupId()

◆ SetLargePersonGroupIdCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetMaxNumOfCandidatesReturned()

◆ SetMaxNumOfCandidatesReturnedCol()

◆ SetOutputCol()

◆ SetPersonGroupId()

◆ SetPersonGroupIdCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()