VerifyFaces implements VerifyFaces More...

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

[legend]

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

[legend]

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

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

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

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

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

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

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

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

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

VerifyFaces	SetFaceId (string value)
	Sets value for faceId More...

VerifyFaces	SetFaceIdCol (string value)
	Sets value for faceId column More...

VerifyFaces	SetFaceId1 (string value)
	Sets value for faceId1 More...

VerifyFaces	SetFaceId1Col (string value)
	Sets value for faceId1 column More...

VerifyFaces	SetFaceId2 (string value)
	Sets value for faceId2 More...

VerifyFaces	SetFaceId2Col (string value)
	Sets value for faceId2 column More...

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

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

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

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

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

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

VerifyFaces	SetPersonId (string value)
	Sets value for personId More...

VerifyFaces	SetPersonIdCol (string value)
	Sets value for personId column More...

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

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

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

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

string	GetFaceId ()
	Gets faceId value More...

string	GetFaceId1 ()
	Gets faceId1 value More...

string	GetFaceId2 ()
	Gets faceId2 value More...

object	GetHandler ()
	Gets handler value More...

string	GetLargePersonGroupId ()
	Gets largePersonGroupId value More...

string	GetOutputCol ()
	Gets outputCol value More...

string	GetPersonGroupId ()
	Gets personGroupId value More...

string	GetPersonId ()
	Gets personId 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< VerifyFaces >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

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

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

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

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

Detailed Description

VerifyFaces implements VerifyFaces

Constructor & Destructor Documentation

◆ VerifyFaces() [1/2]

Synapse.ML.Services.Face.VerifyFaces.VerifyFaces ( )

inline

Creates a VerifyFaces without any parameters.

◆ VerifyFaces() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

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

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

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

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFaceId()

string Synapse.ML.Services.Face.VerifyFaces.GetFaceId ( )

Gets faceId value

Returns: faceId: faceId of the face, comes from Face - Detect.

◆ GetFaceId1()

string Synapse.ML.Services.Face.VerifyFaces.GetFaceId1 ( )

Gets faceId1 value

Returns: faceId1: faceId of one face, comes from Face - Detect.

◆ GetFaceId2()

string Synapse.ML.Services.Face.VerifyFaces.GetFaceId2 ( )

Gets faceId2 value

Returns: faceId2: faceId of another face, comes from Face - Detect.

◆ GetHandler()

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

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetLargePersonGroupId()

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

Gets largePersonGroupId value

Returns: largePersonGroupId: Using existing largePersonGroupId and personId for fast adding a specified person. largePersonGroupId is created in LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetPersonGroupId()

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

Gets personGroupId value

Returns: personGroupId: Using existing personGroupId and personId for fast loading a specified person. personGroupId is created in PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

◆ GetPersonId()

string Synapse.ML.Services.Face.VerifyFaces.GetPersonId ( )

Gets personId value

Returns: personId: Specify a certain person in a person group or a large person group. personId is created in PersonGroup Person - Create or LargePersonGroup Person - Create.

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous VerifyFaces was saved to

Returns: New VerifyFaces object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New VerifyFaces object

◆ SetAADTokenCol()

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

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New VerifyFaces object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New VerifyFaces object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New VerifyFaces object

◆ SetCustomAuthHeader()

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

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New VerifyFaces object

◆ SetCustomAuthHeaderCol()

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

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New VerifyFaces object

◆ SetCustomServiceName()

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

Sets value for service name

Parameters

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

Returns: New VerifyFaces object

◆ SetEndpoint()

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

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New VerifyFaces object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New VerifyFaces object

◆ SetFaceId()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceId ( string value )

Sets value for faceId

Parameters

value faceId of the face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetFaceId1()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceId1 ( string value )

Sets value for faceId1

Parameters

value faceId of one face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetFaceId1Col()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceId1Col ( string value )

Sets value for faceId1 column

Parameters

value faceId of one face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetFaceId2()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceId2 ( string value )

Sets value for faceId2

Parameters

value faceId of another face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetFaceId2Col()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceId2Col ( string value )

Sets value for faceId2 column

Parameters

value faceId of another face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetFaceIdCol()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetFaceIdCol ( string value )

Sets value for faceId column

Parameters

value faceId of the face, comes from Face - Detect.

Returns: New VerifyFaces object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New VerifyFaces object

◆ SetLargePersonGroupId()

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

Sets value for largePersonGroupId

Parameters

value Using existing largePersonGroupId and personId for fast adding a specified person. largePersonGroupId is created in LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New VerifyFaces object

◆ SetLargePersonGroupIdCol()

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

Sets value for largePersonGroupId column

Parameters

value Using existing largePersonGroupId and personId for fast adding a specified person. largePersonGroupId is created in LargePersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New VerifyFaces object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New VerifyFaces object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New VerifyFaces object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New VerifyFaces object

◆ SetPersonGroupId()

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

Sets value for personGroupId

Parameters

value Using existing personGroupId and personId for fast loading a specified person. personGroupId is created in PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New VerifyFaces object

◆ SetPersonGroupIdCol()

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

Sets value for personGroupId column

Parameters

value Using existing personGroupId and personId for fast loading a specified person. personGroupId is created in PersonGroup - Create. Parameter personGroupId and largePersonGroupId should not be provided at the same time.

Returns: New VerifyFaces object

◆ SetPersonId()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetPersonId ( string value )

Sets value for personId

Parameters

value Specify a certain person in a person group or a large person group. personId is created in PersonGroup Person - Create or LargePersonGroup Person - Create.

Returns: New VerifyFaces object

◆ SetPersonIdCol()

VerifyFaces Synapse.ML.Services.Face.VerifyFaces.SetPersonIdCol ( string value )

Sets value for personId column

Parameters

value Specify a certain person in a person group or a large person group. personId is created in PersonGroup Person - Create or LargePersonGroup Person - Create.

Returns: New VerifyFaces object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New VerifyFaces object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New VerifyFaces object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New VerifyFaces object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New VerifyFaces object

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

synapse/ml/services/face/VerifyFaces.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VerifyFaces() [1/2]

◆ VerifyFaces() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetFaceId()

◆ GetFaceId1()

◆ GetFaceId2()

◆ GetHandler()

◆ GetLargePersonGroupId()

◆ GetOutputCol()

◆ GetPersonGroupId()

◆ GetPersonId()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetFaceId()

◆ SetFaceId1()

◆ SetFaceId1Col()

◆ SetFaceId2()

◆ SetFaceId2Col()

◆ SetFaceIdCol()

◆ SetHandler()

◆ SetLargePersonGroupId()

◆ SetLargePersonGroupIdCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetPersonGroupId()

◆ SetPersonGroupIdCol()

◆ SetPersonId()

◆ SetPersonIdCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()