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

[legend]

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

[legend]

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

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

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

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

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

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

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

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

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

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

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

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

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

FindSimilarFace	SetFaceListId (string value)
	Sets value for faceListId More...

FindSimilarFace	SetFaceListIdCol (string value)
	Sets value for faceListId column More...

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

FindSimilarFace	SetLargeFaceListId (string value)
	Sets value for largeFaceListId More...

FindSimilarFace	SetLargeFaceListIdCol (string value)
	Sets value for largeFaceListId column More...

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

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

FindSimilarFace	SetMode (string value)
	Sets value for mode More...

FindSimilarFace	SetModeCol (string value)
	Sets value for mode column More...

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

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

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

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

FindSimilarFace	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[]	GetFaceIds ()
	Gets faceIds value More...

string	GetFaceListId ()
	Gets faceListId value More...

object	GetHandler ()
	Gets handler value More...

string	GetLargeFaceListId ()
	Gets largeFaceListId value More...

int	GetMaxNumOfCandidatesReturned ()
	Gets maxNumOfCandidatesReturned value More...

string	GetMode ()
	Gets mode value More...

string	GetOutputCol ()
	Gets outputCol 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< FindSimilarFace >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

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

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

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

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

Detailed Description

Constructor & Destructor Documentation

◆ FindSimilarFace() [1/2]

Synapse.ML.Services.Face.FindSimilarFace.FindSimilarFace ( )

inline

Creates a FindSimilarFace without any parameters.

◆ FindSimilarFace() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

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

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

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

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFaceId()

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

Gets faceId value

Returns: faceId: faceId of the query face. User needs to call FaceDetect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call.

◆ GetFaceIds()

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

Gets faceIds value

Returns: faceIds: An array of candidate faceIds. All of them are created by FaceDetect and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

◆ GetFaceListId()

string Synapse.ML.Services.Face.FindSimilarFace.GetFaceListId ( )

Gets faceListId value

Returns: faceListId: An existing user-specified unique candidate face list, created in FaceList - Create. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

◆ GetHandler()

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

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetLargeFaceListId()

string Synapse.ML.Services.Face.FindSimilarFace.GetLargeFaceListId ( )

Gets largeFaceListId value

Returns: largeFaceListId: An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

◆ GetMaxNumOfCandidatesReturned()

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

Gets maxNumOfCandidatesReturned value

Returns: maxNumOfCandidatesReturned: Optional parameter. The number of top similar faces returned. The valid range is [1, 1000].It defaults to 20.

◆ GetMode()

string Synapse.ML.Services.Face.FindSimilarFace.GetMode ( )

Gets mode value

Returns: mode: Optional parameter. Similar face searching mode. It can be 'matchPerson' or 'matchFace'. It defaults to 'matchPerson'.

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous FindSimilarFace was saved to

Returns: New FindSimilarFace object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New FindSimilarFace object

◆ SetAADTokenCol()

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

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New FindSimilarFace object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New FindSimilarFace object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New FindSimilarFace object

◆ SetCustomAuthHeader()

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

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New FindSimilarFace object

◆ SetCustomAuthHeaderCol()

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

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New FindSimilarFace object

◆ SetCustomServiceName()

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

Sets value for service name

Parameters

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

Returns: New FindSimilarFace object

◆ SetEndpoint()

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

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New FindSimilarFace object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New FindSimilarFace object

◆ SetFaceId()

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

Sets value for faceId

Parameters

value faceId of the query face. User needs to call FaceDetect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call.

Returns: New FindSimilarFace object

◆ SetFaceIdCol()

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

Sets value for faceId column

Parameters

value faceId of the query face. User needs to call FaceDetect first to get a valid faceId. Note that this faceId is not persisted and will expire 24 hours after the detection call.

Returns: New FindSimilarFace object

◆ SetFaceIds()

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

Sets value for faceIds

Parameters

value An array of candidate faceIds. All of them are created by FaceDetect and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetFaceIdsCol()

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

Sets value for faceIds column

Parameters

value An array of candidate faceIds. All of them are created by FaceDetect and the faceIds will expire 24 hours after the detection call. The number of faceIds is limited to 1000. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetFaceListId()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetFaceListId ( string value )

Sets value for faceListId

Parameters

value An existing user-specified unique candidate face list, created in FaceList - Create. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetFaceListIdCol()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetFaceListIdCol ( string value )

Sets value for faceListId column

Parameters

value An existing user-specified unique candidate face list, created in FaceList - Create. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New FindSimilarFace object

◆ SetLargeFaceListId()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetLargeFaceListId ( string value )

Sets value for largeFaceListId

Parameters

value An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetLargeFaceListIdCol()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetLargeFaceListIdCol ( string value )

Sets value for largeFaceListId column

Parameters

value An existing user-specified unique candidate large face list, created in LargeFaceList - Create. Large face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.

Returns: New FindSimilarFace object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New FindSimilarFace object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New FindSimilarFace object

◆ SetMaxNumOfCandidatesReturned()

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

Sets value for maxNumOfCandidatesReturned

Parameters

value Optional parameter. The number of top similar faces returned. The valid range is [1, 1000].It defaults to 20.

Returns: New FindSimilarFace object

◆ SetMaxNumOfCandidatesReturnedCol()

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

Sets value for maxNumOfCandidatesReturned column

Parameters

value Optional parameter. The number of top similar faces returned. The valid range is [1, 1000].It defaults to 20.

Returns: New FindSimilarFace object

◆ SetMode()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetMode ( string value )

Sets value for mode

Parameters

value Optional parameter. Similar face searching mode. It can be 'matchPerson' or 'matchFace'. It defaults to 'matchPerson'.

Returns: New FindSimilarFace object

◆ SetModeCol()

FindSimilarFace Synapse.ML.Services.Face.FindSimilarFace.SetModeCol ( string value )

Sets value for mode column

Parameters

value Optional parameter. Similar face searching mode. It can be 'matchPerson' or 'matchFace'. It defaults to 'matchPerson'.

Returns: New FindSimilarFace object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New FindSimilarFace object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New FindSimilarFace object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New FindSimilarFace object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New FindSimilarFace object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New FindSimilarFace object

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

synapse/ml/services/face/FindSimilarFace.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FindSimilarFace() [1/2]

◆ FindSimilarFace() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetFaceId()

◆ GetFaceIds()

◆ GetFaceListId()

◆ GetHandler()

◆ GetLargeFaceListId()

◆ GetMaxNumOfCandidatesReturned()

◆ GetMode()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetFaceId()

◆ SetFaceIdCol()

◆ SetFaceIds()

◆ SetFaceIdsCol()

◆ SetFaceListId()

◆ SetFaceListIdCol()

◆ SetHandler()

◆ SetLargeFaceListId()

◆ SetLargeFaceListIdCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetMaxNumOfCandidatesReturned()

◆ SetMaxNumOfCandidatesReturnedCol()

◆ SetMode()

◆ SetModeCol()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()