GroupFaces implements GroupFaces More...

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

[legend]

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

[legend]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

object	GetHandler ()
	Gets handler 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< GroupFaces >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

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

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

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

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

Detailed Description

GroupFaces implements GroupFaces

Constructor & Destructor Documentation

◆ GroupFaces() [1/2]

Synapse.ML.Services.Face.GroupFaces.GroupFaces ( )

inline

Creates a GroupFaces without any parameters.

◆ GroupFaces() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

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

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

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

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetFaceIds()

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

Gets faceIds value

Returns: faceIds: Array of candidate faceId created by Face - Detect. The maximum is 1000 faces.

◆ GetHandler()

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

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous GroupFaces was saved to

Returns: New GroupFaces object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New GroupFaces object

◆ SetAADTokenCol()

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

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New GroupFaces object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New GroupFaces object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New GroupFaces object

◆ SetCustomAuthHeader()

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

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New GroupFaces object

◆ SetCustomAuthHeaderCol()

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

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New GroupFaces object

◆ SetCustomServiceName()

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

Sets value for service name

Parameters

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

Returns: New GroupFaces object

◆ SetEndpoint()

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

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New GroupFaces object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New GroupFaces object

◆ SetFaceIds()

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

Sets value for faceIds

Parameters

value Array of candidate faceId created by Face - Detect. The maximum is 1000 faces.

Returns: New GroupFaces object

◆ SetFaceIdsCol()

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

Sets value for faceIds column

Parameters

value Array of candidate faceId created by Face - Detect. The maximum is 1000 faces.

Returns: New GroupFaces object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New GroupFaces object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New GroupFaces object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New GroupFaces object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New GroupFaces object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New GroupFaces object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New GroupFaces object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New GroupFaces object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New GroupFaces object

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

synapse/ml/services/face/GroupFaces.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GroupFaces() [1/2]

◆ GroupFaces() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetFaceIds()

◆ GetHandler()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetFaceIds()

◆ SetFaceIdsCol()

◆ SetHandler()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()