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

GetCustomModel implements GetCustomModel More...

Inheritance diagram for Synapse.ML.Cognitive.GetCustomModel:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.GetCustomModel:
Collaboration graph
[legend]

Public Member Functions

 GetCustomModel ()
 Creates a GetCustomModel without any parameters. More...
 
 GetCustomModel (string uid)
 Creates a GetCustomModel with a UID that is used to give the GetCustomModel a unique ID. More...
 
GetCustomModel SetConcurrency (int value)
 Sets value for concurrency More...
 
GetCustomModel SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
GetCustomModel SetErrorCol (string value)
 Sets value for errorCol More...
 
GetCustomModel SetHandler (object value)
 Sets value for handler More...
 
GetCustomModel SetIncludeKeys (bool value)
 Sets value for includeKeys More...
 
GetCustomModel SetIncludeKeysCol (string value)
 Sets value for includeKeys column More...
 
GetCustomModel SetModelId (string value)
 Sets value for modelId More...
 
GetCustomModel SetModelIdCol (string value)
 Sets value for modelId column More...
 
GetCustomModel SetOutputCol (string value)
 Sets value for outputCol More...
 
GetCustomModel SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
GetCustomModel SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
GetCustomModel SetTimeout (double value)
 Sets value for timeout More...
 
GetCustomModel 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...
 
object GetHandler ()
 Gets handler value More...
 
bool GetIncludeKeys ()
 Gets includeKeys value More...
 
string GetModelId ()
 Gets modelId 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< GetCustomModelRead ()
 Get the corresponding JavaMLReader instance. More...
 
GetCustomModel SetLocation (string value)
 Sets value for location More...
 
GetCustomModel SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

static GetCustomModel Load (string path)
 Loads the GetCustomModel that was previously saved using Save(string). More...
 

Detailed Description

GetCustomModel implements GetCustomModel

Constructor & Destructor Documentation

◆ GetCustomModel() [1/2]

Synapse.ML.Cognitive.GetCustomModel.GetCustomModel ( )
inline

Creates a GetCustomModel without any parameters.

◆ GetCustomModel() [2/2]

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

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

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

Member Function Documentation

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns
handler: Which strategy to use when handling requests

◆ GetIncludeKeys()

bool Synapse.ML.Cognitive.GetCustomModel.GetIncludeKeys ( )

Gets includeKeys value

Returns
includeKeys: Include list of extracted keys in model information.

◆ GetModelId()

string Synapse.ML.Cognitive.GetCustomModel.GetModelId ( )

Gets modelId value

Returns
modelId: Model identifier.

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.GetCustomModel.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()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New GetCustomModel object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New GetCustomModel object

◆ SetHandler()

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

Sets value for handler

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

◆ SetIncludeKeys()

GetCustomModel Synapse.ML.Cognitive.GetCustomModel.SetIncludeKeys ( bool  value)

Sets value for includeKeys

Parameters
valueInclude list of extracted keys in model information.
Returns
New GetCustomModel object

◆ SetIncludeKeysCol()

GetCustomModel Synapse.ML.Cognitive.GetCustomModel.SetIncludeKeysCol ( string  value)

Sets value for includeKeys column

Parameters
valueInclude list of extracted keys in model information.
Returns
New GetCustomModel object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New GetCustomModel object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New GetCustomModel object

◆ SetModelId()

GetCustomModel Synapse.ML.Cognitive.GetCustomModel.SetModelId ( string  value)

Sets value for modelId

Parameters
valueModel identifier.
Returns
New GetCustomModel object

◆ SetModelIdCol()

GetCustomModel Synapse.ML.Cognitive.GetCustomModel.SetModelIdCol ( string  value)

Sets value for modelId column

Parameters
valueModel identifier.
Returns
New GetCustomModel object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New GetCustomModel object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New GetCustomModel object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New GetCustomModel object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New GetCustomModel object

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