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

AnalyzeCustomModel implements AnalyzeCustomModel More...

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

Public Member Functions

 AnalyzeCustomModel ()
 Creates a AnalyzeCustomModel without any parameters. More...
 
 AnalyzeCustomModel (string uid)
 Creates a AnalyzeCustomModel with a UID that is used to give the AnalyzeCustomModel a unique ID. More...
 
AnalyzeCustomModel SetBackoffs (int[] value)
 Sets value for backoffs More...
 
AnalyzeCustomModel SetConcurrency (int value)
 Sets value for concurrency More...
 
AnalyzeCustomModel SetConcurrentTimeout (double value)
 Sets value for concurrentTimeout More...
 
AnalyzeCustomModel SetErrorCol (string value)
 Sets value for errorCol More...
 
AnalyzeCustomModel SetImageBytes (byte[] value)
 Sets value for imageBytes More...
 
AnalyzeCustomModel SetImageBytesCol (string value)
 Sets value for imageBytes column More...
 
AnalyzeCustomModel SetImageUrl (string value)
 Sets value for imageUrl More...
 
AnalyzeCustomModel SetImageUrlCol (string value)
 Sets value for imageUrl column More...
 
AnalyzeCustomModel SetIncludeTextDetails (bool value)
 Sets value for includeTextDetails More...
 
AnalyzeCustomModel SetIncludeTextDetailsCol (string value)
 Sets value for includeTextDetails column More...
 
AnalyzeCustomModel SetInitialPollingDelay (int value)
 Sets value for initialPollingDelay More...
 
AnalyzeCustomModel SetMaxPollingRetries (int value)
 Sets value for maxPollingRetries More...
 
AnalyzeCustomModel SetModelId (string value)
 Sets value for modelId More...
 
AnalyzeCustomModel SetModelIdCol (string value)
 Sets value for modelId column More...
 
AnalyzeCustomModel SetModelVersion (string value)
 Sets value for modelVersion More...
 
AnalyzeCustomModel SetModelVersionCol (string value)
 Sets value for modelVersion column More...
 
AnalyzeCustomModel SetOutputCol (string value)
 Sets value for outputCol More...
 
AnalyzeCustomModel SetPollingDelay (int value)
 Sets value for pollingDelay More...
 
AnalyzeCustomModel SetSubscriptionKey (string value)
 Sets value for subscriptionKey More...
 
AnalyzeCustomModel SetSubscriptionKeyCol (string value)
 Sets value for subscriptionKey column More...
 
AnalyzeCustomModel SetSuppressMaxRetriesExceededException (bool value)
 Sets value for suppressMaxRetriesExceededException More...
 
AnalyzeCustomModel SetTimeout (double value)
 Sets value for timeout More...
 
AnalyzeCustomModel SetUrl (string value)
 Sets value for url More...
 
int [] GetBackoffs ()
 Gets backoffs value More...
 
int GetConcurrency ()
 Gets concurrency value More...
 
double GetConcurrentTimeout ()
 Gets concurrentTimeout value More...
 
string GetErrorCol ()
 Gets errorCol value More...
 
byte [] GetImageBytes ()
 Gets imageBytes value More...
 
string GetImageUrl ()
 Gets imageUrl value More...
 
bool GetIncludeTextDetails ()
 Gets includeTextDetails value More...
 
int GetInitialPollingDelay ()
 Gets initialPollingDelay value More...
 
int GetMaxPollingRetries ()
 Gets maxPollingRetries value More...
 
string GetModelId ()
 Gets modelId value More...
 
string GetModelVersion ()
 Gets modelVersion value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
int GetPollingDelay ()
 Gets pollingDelay value More...
 
string GetSubscriptionKey ()
 Gets subscriptionKey value More...
 
bool GetSuppressMaxRetriesExceededException ()
 Gets suppressMaxRetriesExceededException 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< AnalyzeCustomModelRead ()
 Get the corresponding JavaMLReader instance. More...
 
AnalyzeCustomModel SetLocation (string value)
 Sets value for location More...
 
AnalyzeCustomModel SetLinkedService (string value)
 Sets value for linkedService More...
 

Static Public Member Functions

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

Detailed Description

AnalyzeCustomModel implements AnalyzeCustomModel

Constructor & Destructor Documentation

◆ AnalyzeCustomModel() [1/2]

Synapse.ML.Cognitive.AnalyzeCustomModel.AnalyzeCustomModel ( )
inline

Creates a AnalyzeCustomModel without any parameters.

◆ AnalyzeCustomModel() [2/2]

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

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

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

Member Function Documentation

◆ GetBackoffs()

int [] Synapse.ML.Cognitive.AnalyzeCustomModel.GetBackoffs ( )

Gets backoffs value

Returns
backoffs: array of backoffs to use in the handler

◆ GetConcurrency()

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

Gets concurrency value

Returns
concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetErrorCol()

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

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetImageBytes()

byte [] Synapse.ML.Cognitive.AnalyzeCustomModel.GetImageBytes ( )

Gets imageBytes value

Returns
imageBytes: bytestream of the image to use

◆ GetImageUrl()

string Synapse.ML.Cognitive.AnalyzeCustomModel.GetImageUrl ( )

Gets imageUrl value

Returns
imageUrl: the url of the image to use

◆ GetIncludeTextDetails()

bool Synapse.ML.Cognitive.AnalyzeCustomModel.GetIncludeTextDetails ( )

Gets includeTextDetails value

Returns
includeTextDetails: Include text lines and element references in the result.

◆ GetInitialPollingDelay()

int Synapse.ML.Cognitive.AnalyzeCustomModel.GetInitialPollingDelay ( )

Gets initialPollingDelay value

Returns
initialPollingDelay: number of milliseconds to wait before first poll for result

◆ GetMaxPollingRetries()

int Synapse.ML.Cognitive.AnalyzeCustomModel.GetMaxPollingRetries ( )

Gets maxPollingRetries value

Returns
maxPollingRetries: number of times to poll

◆ GetModelId()

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

Gets modelId value

Returns
modelId: Model identifier.

◆ GetModelVersion()

string Synapse.ML.Cognitive.AnalyzeCustomModel.GetModelVersion ( )

Gets modelVersion value

Returns
modelVersion: This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

◆ GetOutputCol()

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

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetPollingDelay()

int Synapse.ML.Cognitive.AnalyzeCustomModel.GetPollingDelay ( )

Gets pollingDelay value

Returns
pollingDelay: number of milliseconds to wait between polling

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetSuppressMaxRetriesExceededException()

bool Synapse.ML.Cognitive.AnalyzeCustomModel.GetSuppressMaxRetriesExceededException ( )

Gets suppressMaxRetriesExceededException value

Returns
suppressMaxRetriesExceededException: set true to suppress the maxumimum retries exception and report in the error column

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns
url: Url of the service

◆ Load()

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

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

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

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.AnalyzeCustomModel.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

◆ SetBackoffs()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetBackoffs ( int []  value)

Sets value for backoffs

Parameters
valuearray of backoffs to use in the handler
Returns
New AnalyzeCustomModel object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters
valuemax number of concurrent calls
Returns
New AnalyzeCustomModel object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

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

◆ SetErrorCol()

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

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New AnalyzeCustomModel object

◆ SetImageBytes()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetImageBytes ( byte []  value)

Sets value for imageBytes

Parameters
valuebytestream of the image to use
Returns
New AnalyzeCustomModel object

◆ SetImageBytesCol()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetImageBytesCol ( string  value)

Sets value for imageBytes column

Parameters
valuebytestream of the image to use
Returns
New AnalyzeCustomModel object

◆ SetImageUrl()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetImageUrl ( string  value)

Sets value for imageUrl

Parameters
valuethe url of the image to use
Returns
New AnalyzeCustomModel object

◆ SetImageUrlCol()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetImageUrlCol ( string  value)

Sets value for imageUrl column

Parameters
valuethe url of the image to use
Returns
New AnalyzeCustomModel object

◆ SetIncludeTextDetails()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetIncludeTextDetails ( bool  value)

Sets value for includeTextDetails

Parameters
valueInclude text lines and element references in the result.
Returns
New AnalyzeCustomModel object

◆ SetIncludeTextDetailsCol()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetIncludeTextDetailsCol ( string  value)

Sets value for includeTextDetails column

Parameters
valueInclude text lines and element references in the result.
Returns
New AnalyzeCustomModel object

◆ SetInitialPollingDelay()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetInitialPollingDelay ( int  value)

Sets value for initialPollingDelay

Parameters
valuenumber of milliseconds to wait before first poll for result
Returns
New AnalyzeCustomModel object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New AnalyzeCustomModel object

◆ SetLocation()

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

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New AnalyzeCustomModel object

◆ SetMaxPollingRetries()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetMaxPollingRetries ( int  value)

Sets value for maxPollingRetries

Parameters
valuenumber of times to poll
Returns
New AnalyzeCustomModel object

◆ SetModelId()

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

Sets value for modelId

Parameters
valueModel identifier.
Returns
New AnalyzeCustomModel object

◆ SetModelIdCol()

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

Sets value for modelId column

Parameters
valueModel identifier.
Returns
New AnalyzeCustomModel object

◆ SetModelVersion()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetModelVersion ( string  value)

Sets value for modelVersion

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New AnalyzeCustomModel object

◆ SetModelVersionCol()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetModelVersionCol ( string  value)

Sets value for modelVersion column

Parameters
valueThis value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.
Returns
New AnalyzeCustomModel object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New AnalyzeCustomModel object

◆ SetPollingDelay()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetPollingDelay ( int  value)

Sets value for pollingDelay

Parameters
valuenumber of milliseconds to wait between polling
Returns
New AnalyzeCustomModel object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New AnalyzeCustomModel object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New AnalyzeCustomModel object

◆ SetSuppressMaxRetriesExceededException()

AnalyzeCustomModel Synapse.ML.Cognitive.AnalyzeCustomModel.SetSuppressMaxRetriesExceededException ( bool  value)

Sets value for suppressMaxRetriesExceededException

Parameters
valueset true to suppress the maxumimum retries exception and report in the error column
Returns
New AnalyzeCustomModel object

◆ SetTimeout()

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

Sets value for timeout

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

◆ SetUrl()

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

Sets value for url

Parameters
valueUrl of the service
Returns
New AnalyzeCustomModel object

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