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

VerifyFaces implements VerifyFaces More...

Inheritance diagram for Synapse.ML.Cognitive.VerifyFaces:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.VerifyFaces:
Collaboration graph
[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 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...
 
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< VerifyFacesRead ()
 Get the corresponding JavaMLReader instance. 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.Cognitive.VerifyFaces.VerifyFaces ( )
inline

Creates a VerifyFaces without any parameters.

◆ VerifyFaces() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetFaceId()

string Synapse.ML.Cognitive.VerifyFaces.GetFaceId ( )

Gets faceId value

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

◆ GetFaceId1()

string Synapse.ML.Cognitive.VerifyFaces.GetFaceId1 ( )

Gets faceId1 value

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

◆ GetFaceId2()

string Synapse.ML.Cognitive.VerifyFaces.GetFaceId2 ( )

Gets faceId2 value

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

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetLargePersonGroupId()

string Synapse.ML.Cognitive.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.Cognitive.VerifyFaces.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPersonGroupId()

string Synapse.ML.Cognitive.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.Cognitive.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.Cognitive.VerifyFaces.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.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
pathThe path to save the object to

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New VerifyFaces object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New VerifyFaces object

◆ SetFaceId()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceId ( string  value)

Sets value for faceId

Parameters
valuefaceId of the face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetFaceId1()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceId1 ( string  value)

Sets value for faceId1

Parameters
valuefaceId of one face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetFaceId1Col()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceId1Col ( string  value)

Sets value for faceId1 column

Parameters
valuefaceId of one face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetFaceId2()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceId2 ( string  value)

Sets value for faceId2

Parameters
valuefaceId of another face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetFaceId2Col()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceId2Col ( string  value)

Sets value for faceId2 column

Parameters
valuefaceId of another face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetFaceIdCol()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetFaceIdCol ( string  value)

Sets value for faceId column

Parameters
valuefaceId of the face, comes from Face - Detect.
Returns
New VerifyFaces object

◆ SetHandler()

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

Sets value for handler

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

◆ SetLargePersonGroupId()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetLargePersonGroupId ( string  value)

Sets value for largePersonGroupId

Parameters
valueUsing 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.Cognitive.VerifyFaces.SetLargePersonGroupIdCol ( string  value)

Sets value for largePersonGroupId column

Parameters
valueUsing 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.Cognitive.VerifyFaces.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New VerifyFaces object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New VerifyFaces object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New VerifyFaces object

◆ SetPersonGroupId()

VerifyFaces Synapse.ML.Cognitive.VerifyFaces.SetPersonGroupId ( string  value)

Sets value for personGroupId

Parameters
valueUsing 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.Cognitive.VerifyFaces.SetPersonGroupIdCol ( string  value)

Sets value for personGroupId column

Parameters
valueUsing 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.Cognitive.VerifyFaces.SetPersonId ( string  value)

Sets value for personId

Parameters
valueSpecify 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.Cognitive.VerifyFaces.SetPersonIdCol ( string  value)

Sets value for personId column

Parameters
valueSpecify 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.Cognitive.VerifyFaces.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New VerifyFaces object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New VerifyFaces object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New VerifyFaces object

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