DescribeImage implements DescribeImage More...

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

[legend]

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

[legend]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DescribeImage	SetMaxCandidates (int value)
	Sets value for maxCandidates More...

DescribeImage	SetMaxCandidatesCol (string value)
	Sets value for maxCandidates column More...

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

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

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

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

DescribeImage	SetUrl (string value)
	Sets value for url 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	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...

int	GetMaxCandidates ()
	Gets maxCandidates 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< DescribeImage >	Read ()
	Get the corresponding JavaMLReader instance. More...

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

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

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

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

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

Detailed Description

DescribeImage implements DescribeImage

Constructor & Destructor Documentation

◆ DescribeImage() [1/2]

Synapse.ML.Services.Vision.DescribeImage.DescribeImage ( )

inline

Creates a DescribeImage without any parameters.

◆ DescribeImage() [2/2]

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

inline

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

Parameters

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

Member Function Documentation

◆ GetAADToken()

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

Gets AADToken value

Returns: AADToken: AAD Token used for authentication

◆ GetConcurrency()

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

Gets concurrency value

Returns: concurrency: max number of concurrent calls

◆ GetConcurrentTimeout()

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

Gets concurrentTimeout value

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

◆ GetCustomAuthHeader()

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

Gets CustomAuthHeader value

Returns: CustomAuthHeader: A Custom Value for Authorization Header

◆ GetErrorCol()

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

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetHandler()

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

Gets handler value

Returns: handler: Which strategy to use when handling requests

◆ GetImageBytes()

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

Gets imageBytes value

Returns: imageBytes: bytestream of the image to use

◆ GetImageUrl()

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

Gets imageUrl value

Returns: imageUrl: the url of the image to use

◆ GetLanguage()

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

Gets language value

Returns: language: Language of image description

◆ GetMaxCandidates()

int Synapse.ML.Services.Vision.DescribeImage.GetMaxCandidates ( )

Gets maxCandidates value

Returns: maxCandidates: Maximum candidate descriptions to return

◆ GetOutputCol()

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

Gets outputCol value

Returns: outputCol: The name of the output column

◆ GetSubscriptionKey()

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

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetTimeout()

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

Gets timeout value

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

◆ GetUrl()

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

Gets url value

Returns: url: Url of the service

◆ Load()

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

static

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

Parameters

path	The path the previous DescribeImage was saved to

Returns: New DescribeImage object, loaded from path.

◆ Read()

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

Get the corresponding JavaMLReader instance.

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

◆ Save()

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

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

Sets value for AADToken

Parameters

value AAD Token used for authentication

Returns: New DescribeImage object

◆ SetAADTokenCol()

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

Sets value for AADToken column

Parameters

value AAD Token used for authentication

Returns: New DescribeImage object

◆ SetConcurrency()

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

Sets value for concurrency

Parameters

value max number of concurrent calls

Returns: New DescribeImage object

◆ SetConcurrentTimeout()

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

Sets value for concurrentTimeout

Parameters

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

Returns: New DescribeImage object

◆ SetCustomAuthHeader()

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

Sets value for CustomAuthHeader

Parameters

value A Custom Value for Authorization Header

Returns: New DescribeImage object

◆ SetCustomAuthHeaderCol()

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

Sets value for CustomAuthHeader column

Parameters

value A Custom Value for Authorization Header

Returns: New DescribeImage object

◆ SetCustomServiceName()

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

Sets value for service name

Parameters

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

Returns: New DescribeImage object

◆ SetEndpoint()

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

Sets value for endpoint

Parameters

value Endpoint of the cognitive service

Returns: New DescribeImage object

◆ SetErrorCol()

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

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New DescribeImage object

◆ SetHandler()

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

Sets value for handler

Parameters

value Which strategy to use when handling requests

Returns: New DescribeImage object

◆ SetImageBytes()

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

Sets value for imageBytes

Parameters

value bytestream of the image to use

Returns: New DescribeImage object

◆ SetImageBytesCol()

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

Sets value for imageBytes column

Parameters

value bytestream of the image to use

Returns: New DescribeImage object

◆ SetImageUrl()

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

Sets value for imageUrl

Parameters

value the url of the image to use

Returns: New DescribeImage object

◆ SetImageUrlCol()

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

Sets value for imageUrl column

Parameters

value the url of the image to use

Returns: New DescribeImage object

◆ SetLanguage()

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

Sets value for language

Parameters

value Language of image description

Returns: New DescribeImage object

◆ SetLanguageCol()

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

Sets value for language column

Parameters

value Language of image description

Returns: New DescribeImage object

◆ SetLinkedService()

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

Sets value for linkedService

Parameters

value linkedService name

Returns: New DescribeImage object

◆ SetLocation()

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

Sets value for location

Parameters

value Location of the cognitive service

Returns: New DescribeImage object

◆ SetMaxCandidates()

DescribeImage Synapse.ML.Services.Vision.DescribeImage.SetMaxCandidates ( int value )

Sets value for maxCandidates

Parameters

value Maximum candidate descriptions to return

Returns: New DescribeImage object

◆ SetMaxCandidatesCol()

DescribeImage Synapse.ML.Services.Vision.DescribeImage.SetMaxCandidatesCol ( string value )

Sets value for maxCandidates column

Parameters

value Maximum candidate descriptions to return

Returns: New DescribeImage object

◆ SetOutputCol()

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

Sets value for outputCol

Parameters

value The name of the output column

Returns: New DescribeImage object

◆ SetSubscriptionKey()

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

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New DescribeImage object

◆ SetSubscriptionKeyCol()

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

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New DescribeImage object

◆ SetTimeout()

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

Sets value for timeout

Parameters

value number of seconds to wait before closing the connection

Returns: New DescribeImage object

◆ SetUrl()

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

Sets value for url

Parameters

value Url of the service

Returns: New DescribeImage object

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

synapse/ml/services/vision/DescribeImage.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DescribeImage() [1/2]

◆ DescribeImage() [2/2]

Member Function Documentation

◆ GetAADToken()

◆ GetConcurrency()

◆ GetConcurrentTimeout()

◆ GetCustomAuthHeader()

◆ GetErrorCol()

◆ GetHandler()

◆ GetImageBytes()

◆ GetImageUrl()

◆ GetLanguage()

◆ GetMaxCandidates()

◆ GetOutputCol()

◆ GetSubscriptionKey()

◆ GetTimeout()

◆ GetUrl()

◆ Load()

◆ Read()

◆ Save()

◆ SetAADToken()

◆ SetAADTokenCol()

◆ SetConcurrency()

◆ SetConcurrentTimeout()

◆ SetCustomAuthHeader()

◆ SetCustomAuthHeaderCol()

◆ SetCustomServiceName()

◆ SetEndpoint()

◆ SetErrorCol()

◆ SetHandler()

◆ SetImageBytes()

◆ SetImageBytesCol()

◆ SetImageUrl()

◆ SetImageUrlCol()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocation()

◆ SetMaxCandidates()

◆ SetMaxCandidatesCol()

◆ SetOutputCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetTimeout()

◆ SetUrl()