Synapse.ML.Services.Form.AnalyzeCustomModel Class Reference

AnalyzeCustomModel implements AnalyzeCustomModel More...

Inheritance diagram for Synapse.ML.Services.Form.AnalyzeCustomModel:

Collaboration diagram for Synapse.ML.Services.Form.AnalyzeCustomModel:

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	SetAADToken (string value)
	Sets value for AADToken More...
AnalyzeCustomModel	SetAADTokenCol (string value)
	Sets value for AADToken column More...
AnalyzeCustomModel	SetCustomAuthHeader (string value)
	Sets value for CustomAuthHeader More...
AnalyzeCustomModel	SetCustomAuthHeaderCol (string value)
	Sets value for CustomAuthHeader column 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	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	SetSuppressMaxRetriesException (bool value)
	Sets value for suppressMaxRetriesException More...
AnalyzeCustomModel	SetTimeout (double value)
	Sets value for timeout More...
AnalyzeCustomModel	SetUrl (string value)
	Sets value for url More...
string	GetAADToken ()
	Gets AADToken value More...
string	GetCustomAuthHeader ()
	Gets CustomAuthHeader value 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	GetOutputCol ()
	Gets outputCol value More...
int	GetPollingDelay ()
	Gets pollingDelay value More...
string	GetSubscriptionKey ()
	Gets subscriptionKey value More...
bool	GetSuppressMaxRetriesException ()
	Gets suppressMaxRetriesException 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< AnalyzeCustomModel >	Read ()
	Get the corresponding JavaMLReader instance. More...
AnalyzeCustomModel	SetCustomServiceName (string value)
	Sets value for service name More...
AnalyzeCustomModel	SetEndpoint (string value)
	Sets value for endpoint 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.Services.Form.AnalyzeCustomModel.AnalyzeCustomModel ( )

inline

Creates a AnalyzeCustomModel without any parameters.

AnalyzeCustomModel() [2/2]

Synapse.ML.Services.Form.AnalyzeCustomModel.AnalyzeCustomModel ( string  uid )

inline

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

Parameters

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

Member Function Documentation

GetAADToken()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetAADToken

(

)

Gets AADToken value

Returns

AADToken: AAD Token used for authentication

GetBackoffs()

int [] Synapse.ML.Services.Form.AnalyzeCustomModel.GetBackoffs

(

)

Gets backoffs value

Returns

backoffs: array of backoffs to use in the handler

GetConcurrency()

int Synapse.ML.Services.Form.AnalyzeCustomModel.GetConcurrency

(

)

Gets concurrency value

Returns

concurrency: max number of concurrent calls

GetConcurrentTimeout()

double Synapse.ML.Services.Form.AnalyzeCustomModel.GetConcurrentTimeout

(

)

Gets concurrentTimeout value

Returns

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

GetCustomAuthHeader()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetCustomAuthHeader

(

)

Gets CustomAuthHeader value

Returns

CustomAuthHeader: A Custom Value for Authorization Header

GetErrorCol()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetErrorCol

(

)

Gets errorCol value

Returns

errorCol: column to hold http errors

GetImageBytes()

byte [] Synapse.ML.Services.Form.AnalyzeCustomModel.GetImageBytes

(

)

Gets imageBytes value

Returns

imageBytes: bytestream of the image to use

GetImageUrl()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetImageUrl

(

)

Gets imageUrl value

Returns

imageUrl: the url of the image to use

GetIncludeTextDetails()

bool Synapse.ML.Services.Form.AnalyzeCustomModel.GetIncludeTextDetails

(

)

Gets includeTextDetails value

Returns

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

GetInitialPollingDelay()

int Synapse.ML.Services.Form.AnalyzeCustomModel.GetInitialPollingDelay

(

)

Gets initialPollingDelay value

Returns

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

GetMaxPollingRetries()

int Synapse.ML.Services.Form.AnalyzeCustomModel.GetMaxPollingRetries

(

)

Gets maxPollingRetries value

Returns

maxPollingRetries: number of times to poll

GetModelId()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetModelId

(

)

Gets modelId value

Returns

modelId: Model identifier.

GetOutputCol()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetPollingDelay()

int Synapse.ML.Services.Form.AnalyzeCustomModel.GetPollingDelay

(

)

Gets pollingDelay value

Returns

pollingDelay: number of milliseconds to wait between polling

GetSubscriptionKey()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetSubscriptionKey

(

)

Gets subscriptionKey value

Returns

subscriptionKey: the API key to use

GetSuppressMaxRetriesException()

bool Synapse.ML.Services.Form.AnalyzeCustomModel.GetSuppressMaxRetriesException

(

)

Gets suppressMaxRetriesException value

Returns

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

GetTimeout()

double Synapse.ML.Services.Form.AnalyzeCustomModel.GetTimeout

(

)

Gets timeout value

Returns

timeout: number of seconds to wait before closing the connection

GetUrl()

string Synapse.ML.Services.Form.AnalyzeCustomModel.GetUrl

(

)

Gets url value

Returns

url: Url of the service

Load()

static AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.Load ( string  path )

static

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

Parameters

path	The path the previous AnalyzeCustomModel was saved to

Returns

New AnalyzeCustomModel object, loaded from path.

Read()

JavaMLReader<AnalyzeCustomModel> Synapse.ML.Services.Form.AnalyzeCustomModel.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<AnalyzeCustomModel> instance for this ML instance.

Save()

void Synapse.ML.Services.Form.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

path	The path to save the object to

SetAADToken()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetAADToken

(

string

value

)

Sets value for AADToken

Parameters

value

AAD Token used for authentication

Returns

New AnalyzeCustomModel object

SetAADTokenCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetAADTokenCol

(

string

value

)

Sets value for AADToken column

Parameters

value

AAD Token used for authentication

Returns

New AnalyzeCustomModel object

SetBackoffs()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetBackoffs

(

int[]

value

)

Sets value for backoffs

Parameters

value

array of backoffs to use in the handler

Returns

New AnalyzeCustomModel object

SetConcurrency()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetConcurrency

(

int

value

)

Sets value for concurrency

Parameters

value

max number of concurrent calls

Returns

New AnalyzeCustomModel object

SetConcurrentTimeout()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetConcurrentTimeout

(

double

value

)

Sets value for concurrentTimeout

Parameters

value

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

Returns

New AnalyzeCustomModel object

SetCustomAuthHeader()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetCustomAuthHeader

(

string

value

)

Sets value for CustomAuthHeader

Parameters

value

A Custom Value for Authorization Header

Returns

New AnalyzeCustomModel object

SetCustomAuthHeaderCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetCustomAuthHeaderCol

(

string

value

)

Sets value for CustomAuthHeader column

Parameters

value

A Custom Value for Authorization Header

Returns

New AnalyzeCustomModel object

SetCustomServiceName()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetCustomServiceName

(

string

value

)

Sets value for service name

Parameters

value

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

Returns

New AnalyzeCustomModel object

SetEndpoint()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetEndpoint

(

string

value

)

Sets value for endpoint

Parameters

value

Endpoint of the cognitive service

Returns

New AnalyzeCustomModel object

SetErrorCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetErrorCol

(

string

value

)

Sets value for errorCol

Parameters

value

column to hold http errors

Returns

New AnalyzeCustomModel object

SetImageBytes()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetImageBytes

(

byte[]

value

)

Sets value for imageBytes

Parameters

value

bytestream of the image to use

Returns

New AnalyzeCustomModel object

SetImageBytesCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetImageBytesCol

(

string

value

)

Sets value for imageBytes column

Parameters

value

bytestream of the image to use

Returns

New AnalyzeCustomModel object

SetImageUrl()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetImageUrl

(

string

value

)

Sets value for imageUrl

Parameters

value

the url of the image to use

Returns

New AnalyzeCustomModel object

SetImageUrlCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetImageUrlCol

(

string

value

)

Sets value for imageUrl column

Parameters

value

the url of the image to use

Returns

New AnalyzeCustomModel object

SetIncludeTextDetails()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetIncludeTextDetails

(

bool

value

)

Sets value for includeTextDetails

Parameters

value

Include text lines and element references in the result.

Returns

New AnalyzeCustomModel object

SetIncludeTextDetailsCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetIncludeTextDetailsCol

(

string

value

)

Sets value for includeTextDetails column

Parameters

value

Include text lines and element references in the result.

Returns

New AnalyzeCustomModel object

SetInitialPollingDelay()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetInitialPollingDelay

(

int

value

)

Sets value for initialPollingDelay

Parameters

value

number of milliseconds to wait before first poll for result

Returns

New AnalyzeCustomModel object

SetLinkedService()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetLinkedService

(

string

value

)

Sets value for linkedService

Parameters

value

linkedService name

Returns

New AnalyzeCustomModel object

SetLocation()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetLocation

(

string

value

)

Sets value for location

Parameters

value

Location of the cognitive service

Returns

New AnalyzeCustomModel object

SetMaxPollingRetries()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetMaxPollingRetries

(

int

value

)

Sets value for maxPollingRetries

Parameters

value

number of times to poll

Returns

New AnalyzeCustomModel object

SetModelId()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetModelId

(

string

value

)

Sets value for modelId

Parameters

value

Model identifier.

Returns

New AnalyzeCustomModel object

SetModelIdCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetModelIdCol

(

string

value

)

Sets value for modelId column

Parameters

value

Model identifier.

Returns

New AnalyzeCustomModel object

SetOutputCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New AnalyzeCustomModel object

SetPollingDelay()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetPollingDelay

(

int

value

)

Sets value for pollingDelay

Parameters

value

number of milliseconds to wait between polling

Returns

New AnalyzeCustomModel object

SetSubscriptionKey()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetSubscriptionKey

(

string

value

)

Sets value for subscriptionKey

Parameters

value

the API key to use

Returns

New AnalyzeCustomModel object

SetSubscriptionKeyCol()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetSubscriptionKeyCol

(

string

value

)

Sets value for subscriptionKey column

Parameters

value

the API key to use

Returns

New AnalyzeCustomModel object

SetSuppressMaxRetriesException()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetSuppressMaxRetriesException

(

bool

value

)

Sets value for suppressMaxRetriesException

Parameters

value

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

Returns

New AnalyzeCustomModel object

SetTimeout()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetTimeout

(

double

value

)

Sets value for timeout

Parameters

value

number of seconds to wait before closing the connection

Returns

New AnalyzeCustomModel object

SetUrl()

AnalyzeCustomModel Synapse.ML.Services.Form.AnalyzeCustomModel.SetUrl

(

string

value

)

Sets value for url

Parameters

value

Url of the service

Returns

New AnalyzeCustomModel object

---

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

• synapse/ml/services/form/AnalyzeCustomModel.cs