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

GroupFaces implements GroupFaces More...

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

Creates a GroupFaces without any parameters.

◆ GroupFaces() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetFaceIds()

string [] Synapse.ML.Cognitive.GroupFaces.GetFaceIds ( )

Gets faceIds value

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

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetOutputCol()

string Synapse.ML.Cognitive.GroupFaces.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.GroupFaces.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New GroupFaces object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New GroupFaces object

◆ SetFaceIds()

GroupFaces Synapse.ML.Cognitive.GroupFaces.SetFaceIds ( string []  value)

Sets value for faceIds

Parameters
valueArray of candidate faceId created by Face - Detect. The maximum is 1000 faces.
Returns
New GroupFaces object

◆ SetFaceIdsCol()

GroupFaces Synapse.ML.Cognitive.GroupFaces.SetFaceIdsCol ( string  value)

Sets value for faceIds column

Parameters
valueArray of candidate faceId created by Face - Detect. The maximum is 1000 faces.
Returns
New GroupFaces object

◆ SetHandler()

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

Sets value for handler

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

◆ SetLinkedService()

GroupFaces Synapse.ML.Cognitive.GroupFaces.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New GroupFaces object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New GroupFaces object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New GroupFaces object

◆ SetSubscriptionKey()

GroupFaces Synapse.ML.Cognitive.GroupFaces.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New GroupFaces object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New GroupFaces object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New GroupFaces object

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