AnalyzeImage implements AnalyzeImage More...

Inheritance diagram for Synapse.ML.Services.Vision.AnalyzeImage:

[legend]

Collaboration diagram for Synapse.ML.Services.Vision.AnalyzeImage:

[legend]

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

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

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

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

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

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

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

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

AnalyzeImage	SetDescriptionExclude (string[] value)
	Sets value for descriptionExclude More...

AnalyzeImage	SetDescriptionExcludeCol (string value)
	Sets value for descriptionExclude column More...

AnalyzeImage	SetDetails (string[] value)
	Sets value for details More...

AnalyzeImage	SetDetailsCol (string value)
	Sets value for details column More...

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

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

AnalyzeImage	SetImageBytes (byte[] value)
	Sets value for imageBytes More...

AnalyzeImage	SetImageBytesCol (string value)
	Sets value for imageBytes column More...

AnalyzeImage	SetImageUrl (string value)
	Sets value for imageUrl More...

AnalyzeImage	SetImageUrlCol (string value)
	Sets value for imageUrl column More...

AnalyzeImage	SetLanguage (string value)
	Sets value for language More...

AnalyzeImage	SetLanguageCol (string value)
	Sets value for language column More...

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

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

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

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

AnalyzeImage	SetUrl (string value)
	Sets value for url More...

AnalyzeImage	SetVisualFeatures (string[] value)
	Sets value for visualFeatures More...

AnalyzeImage	SetVisualFeaturesCol (string value)
	Sets value for visualFeatures column 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[]	GetDescriptionExclude ()
	Gets descriptionExclude value More...

string[]	GetDetails ()
	Gets details value More...

string	GetErrorCol ()
	Gets errorCol value More...

object	GetHandler ()
	Gets handler value More...

byte[]	GetImageBytes ()
	Gets imageBytes value More...

string	GetImageUrl ()
	Gets imageUrl value More...

string	GetLanguage ()
	Gets language 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...

string[]	GetVisualFeatures ()
	Gets visualFeatures 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< AnalyzeImage >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

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

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

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

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

Detailed Description

AnalyzeImage implements AnalyzeImage

Constructor & Destructor Documentation

◆ AnalyzeImage() [1/2]

Synapse.ML.Services.Vision.AnalyzeImage.AnalyzeImage ( )

inline

Creates a AnalyzeImage without any parameters.

◆ AnalyzeImage() [2/2]

Synapse.ML.Services.Vision.AnalyzeImage.AnalyzeImage ( string uid )

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

string Synapse.ML.Services.Vision.AnalyzeImage.GetAADToken ( )

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

int Synapse.ML.Services.Vision.AnalyzeImage.GetConcurrency ( )

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

double Synapse.ML.Services.Vision.AnalyzeImage.GetConcurrentTimeout ( )

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

string Synapse.ML.Services.Vision.AnalyzeImage.GetCustomAuthHeader ( )

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetDescriptionExclude()

string [] Synapse.ML.Services.Vision.AnalyzeImage.GetDescriptionExclude ( )

Gets descriptionExclude value

Returns: descriptionExclude: Whether to exclude certain parts of the model in the description

◆ GetDetails()

string [] Synapse.ML.Services.Vision.AnalyzeImage.GetDetails ( )

Gets details value

Returns: details: what visual feature types to return

◆ GetErrorCol()

string Synapse.ML.Services.Vision.AnalyzeImage.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

object Synapse.ML.Services.Vision.AnalyzeImage.GetHandler ( )

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetImageBytes()

byte [] Synapse.ML.Services.Vision.AnalyzeImage.GetImageBytes ( )

Gets imageBytes value

Returns: imageBytes: bytestream of the image to use

◆ GetImageUrl()

string Synapse.ML.Services.Vision.AnalyzeImage.GetImageUrl ( )

Gets imageUrl value

Returns: imageUrl: the url of the image to use

◆ GetLanguage()

string Synapse.ML.Services.Vision.AnalyzeImage.GetLanguage ( )

Gets language value

Returns: language: the language of the response (en if none given)

◆ GetOutputCol()

string Synapse.ML.Services.Vision.AnalyzeImage.GetOutputCol ( )

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

string Synapse.ML.Services.Vision.AnalyzeImage.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

double Synapse.ML.Services.Vision.AnalyzeImage.GetTimeout ( )

Gets timeout value

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

◆ GetUrl()

string Synapse.ML.Services.Vision.AnalyzeImage.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ GetVisualFeatures()

string [] Synapse.ML.Services.Vision.AnalyzeImage.GetVisualFeatures ( )

Gets visualFeatures value

Returns: visualFeatures: what visual feature types to return

◆ Load()

static AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.Load ( string path )

static

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

Parameters

path	The path the previous AnalyzeImage was saved to

Returns: New AnalyzeImage object, loaded from path.

◆ Read()

JavaMLReader<AnalyzeImage> Synapse.ML.Services.Vision.AnalyzeImage.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Services.Vision.AnalyzeImage.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()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetAADToken ( string value )

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New AnalyzeImage object

◆ SetAADTokenCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetAADTokenCol ( string value )

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New AnalyzeImage object

◆ SetConcurrency()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetConcurrency ( int value )

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New AnalyzeImage object

◆ SetConcurrentTimeout()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetConcurrentTimeout ( double value )

Sets value for concurrentTimeout

Parameters

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

Returns: New AnalyzeImage object

◆ SetCustomAuthHeader()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetCustomAuthHeader ( string value )

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeImage object

◆ SetCustomAuthHeaderCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetCustomAuthHeaderCol ( string value )

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New AnalyzeImage object

◆ SetCustomServiceName()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetCustomServiceName ( string value )

Sets value for service name

Parameters

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

Returns: New AnalyzeImage object

◆ SetDescriptionExclude()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetDescriptionExclude ( string[] value )

Sets value for descriptionExclude

Parameters

value Whether to exclude certain parts of the model in the description

Returns: New AnalyzeImage object

◆ SetDescriptionExcludeCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetDescriptionExcludeCol ( string value )

Sets value for descriptionExclude column

Parameters

value Whether to exclude certain parts of the model in the description

Returns: New AnalyzeImage object

◆ SetDetails()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetDetails ( string[] value )

Sets value for details

Parameters

value what visual feature types to return

Returns: New AnalyzeImage object

◆ SetDetailsCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetDetailsCol ( string value )

Sets value for details column

Parameters

value what visual feature types to return

Returns: New AnalyzeImage object

◆ SetEndpoint()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetEndpoint ( string value )

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New AnalyzeImage object

◆ SetErrorCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New AnalyzeImage object

◆ SetHandler()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetHandler ( object value )

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New AnalyzeImage object

◆ SetImageBytes()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetImageBytes ( byte[] value )

Sets value for imageBytes

Parameters

value bytestream of the image to use

Returns: New AnalyzeImage object

◆ SetImageBytesCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetImageBytesCol ( string value )

Sets value for imageBytes column

Parameters

value bytestream of the image to use

Returns: New AnalyzeImage object

◆ SetImageUrl()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetImageUrl ( string value )

Sets value for imageUrl

Parameters

value the url of the image to use

Returns: New AnalyzeImage object

◆ SetImageUrlCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetImageUrlCol ( string value )

Sets value for imageUrl column

Parameters

value the url of the image to use

Returns: New AnalyzeImage object

◆ SetLanguage()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetLanguage ( string value )

Sets value for language

Parameters

value the language of the response (en if none given)

Returns: New AnalyzeImage object

◆ SetLanguageCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetLanguageCol ( string value )

Sets value for language column

Parameters

value the language of the response (en if none given)

Returns: New AnalyzeImage object

◆ SetLinkedService()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New AnalyzeImage object

◆ SetLocation()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New AnalyzeImage object

◆ SetOutputCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetOutputCol ( string value )

Sets value for outputCol

Parameters

value The name of the output column

Returns: New AnalyzeImage object

◆ SetSubscriptionKey()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New AnalyzeImage object

◆ SetSubscriptionKeyCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New AnalyzeImage object

◆ SetTimeout()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetTimeout ( double value )

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New AnalyzeImage object

◆ SetUrl()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New AnalyzeImage object

◆ SetVisualFeatures()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetVisualFeatures ( string[] value )

Sets value for visualFeatures

Parameters

value what visual feature types to return

Returns: New AnalyzeImage object

◆ SetVisualFeaturesCol()

AnalyzeImage Synapse.ML.Services.Vision.AnalyzeImage.SetVisualFeaturesCol ( string value )

Sets value for visualFeatures column

Parameters

value what visual feature types to return

Returns: New AnalyzeImage object

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

synapse/ml/services/vision/AnalyzeImage.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AnalyzeImage() [1/2]

◆ AnalyzeImage() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetDescriptionExclude()

◆ GetDetails()

◆ GetErrorCol()

◆ GetHandler()

◆ GetImageBytes()

◆ GetImageUrl()

◆ GetLanguage()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ GetVisualFeatures()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetDescriptionExclude()

◆ SetDescriptionExcludeCol()

◆ SetDetails()

◆ SetDetailsCol()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetImageBytes()

◆ SetImageBytesCol()

◆ SetImageUrl()

◆ SetImageUrlCol()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()

◆ SetVisualFeatures()

◆ SetVisualFeaturesCol()