IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition Class Reference

This class wraps the Visual Recognition service. Visual Recognition Service More...

Inheritance diagram for IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition:

Classes
class	ClassifyReq
	The Classify request More...
class	DeleteClassifierReq
class	DetectFacesReq
	The DetectFaces request More...
class	GetClassifierReq
class	GetClassifiersReq
	The GetClassifier request. More...
class	RecognizeTextReq
class	TrainClassifierReq
	The TrainClassifier request. More...

Public Member Functions
delegate void	OnGetClassifiers (GetClassifiersTopLevelBrief classifiers, string data)
	The callback used by the GetClassifiers() method. More...
delegate void	OnGetClassifier (GetClassifiersPerClassifierVerbose classifier, string data)
	Callback used by the GetClassifier() method. More...
delegate void	OnDeleteClassifier (bool success, string data)
	This callback is used by the DeleteClassifier() method. More...
delegate void	OnTrainClassifier (GetClassifiersPerClassifierVerbose classifier, string data)
	Callback used by the TrainClassifier() method. More...
delegate void	OnClassify (ClassifyTopLevelMultiple classify, string data)
	This callback is used by the Classify() method. More...
delegate void	OnDetectFaces (FacesTopLevelMultiple faces, string data)
	This callback is used by the DetectFaces() method. More...
delegate void	OnRecognizeText (TextRecogTopLevelMultiple text, string data)
	This callback is used by the RecognizeText() method. More...
delegate void	OnGetCollections (GetCollections collections, string data)
	This callback is used by the GetCollections() method. More...
delegate void	OnCreateCollection (CreateCollection collection, string data)
	This callback is used by the CreateCollection() method. More...
delegate void	OnDeleteCollection (bool success, string data)
	This callback is used by the DeleteCollection() method. More...
delegate void	OnGetCollection (CreateCollection collection, string data)
	This callback is used y the GetCollection() method. More...
delegate void	OnGetCollectionImages (GetCollectionImages images, string data)
	This callback is used by the GetCollectionImages() method. More...
delegate void	OnAddCollectionImage (CollectionsConfig config, string data)
	This callback is used by the AddCollectionImage() method. More...
delegate void	OnDeleteCollectionImage (bool success, string data)
	This callback is used by the DeleteCollectionImage() method. More...
delegate void	OnGetImageDetails (GetCollectionsBrief image, string data)
	This callback is used by the GetImageDetails() method. More...
delegate void	OnDeleteImageMetadata (bool success, string data)
	This callback is used by the DeleteImageMetadata() method. More...
delegate void	OnGetImageMetadata (object metadata, string data)
	This callback is used by the GetImageMetadata() method. More...
delegate void	OnFindSimilar (SimilarImagesConfig similarImages, string data)
	This callback is used by the FindSimilar() method. More...
delegate byte[]	LoadFileDelegate (string filename)
	The delegate for loading a file, used by TrainClassifier(). More...
	VisualRecognition (Credentials credentials)
bool	Classify (OnClassify callback, string url, string[] owners=default(string[]), string[] classifierIDs=default(string[]), float threshold=default(float), string acceptLanguage="en", string customData=default(string))
	Classifies image specified by URL. More...
bool	Classify (string imagePath, OnClassify callback, string[] owners=default(string[]), string[] classifierIDs=default(string[]), float threshold=default(float), string acceptLanguage="en", string customData=default(string))
	Classifies an image from the file system. More...
bool	Classify (OnClassify callback, byte[] imageData, string[] owners=default(string[]), string[] classifierIDs=default(string[]), float threshold=default(float), string acceptLanguage="en", string customData=default(string))
	Classifies an image using byte data. More...
bool	DetectFaces (OnDetectFaces callback, string url, string customData=default(string))
	Detects faces in a given image URL. More...
bool	DetectFaces (string imagePath, OnDetectFaces callback, string customData=default(string))
	Detects faces in a jpg, gif, png or zip file. More...
bool	DetectFaces (OnDetectFaces callback, byte[] imageData=default(byte[]), string customData=default(string))
	Detect faces in an image's byteData. More...
bool	RecognizeText (OnRecognizeText callback, string url, string customData=default(string))
	Recognizes text given an image url. More...
bool	RecognizeText (string imagePath, OnRecognizeText callback, string customData=default(string))
	Recognizes text in a given image. More...
bool	RecognizeText (OnRecognizeText callback, byte[] imageData=default(byte[]), string customData=default(string))
	Recognizes text in image bytedata. More...
bool	GetClassifiers (OnGetClassifiers callback, string customData=default(string))
	Gets a list of all classifiers. More...
bool	GetClassifier (OnGetClassifier callback, string classifierId, string customData=default(string))
	Gets a classifier by classifierId. More...
bool	TrainClassifier (OnTrainClassifier callback, string classifierName, Dictionary< string, string > positiveExamples, string negativeExamplesPath=default(string), string mimeType="application/zip", string customData=default(string))
	Trains a classifier. Training requires a total of at least two zip files: Two positive example zips with at least 10 positive examples each or one zip file of 10 positive examples and a zip file of 10 negative examples. The total size of all files must be below 256mb. Additional training can be done by using UpdateClassifier. More...
bool	TrainClassifier (OnTrainClassifier callback, string classifierName, Dictionary< string, byte[]> positiveExamplesData, byte[] negativeExamplesData=null, string mimeType="application/zip", string customData=default(string))
	Trains a classifier More...
bool	UpdateClassifier (OnTrainClassifier callback, string classifierID, string classifierName, Dictionary< string, string > positiveExamples, string negativeExamplesPath=default(string), string mimeType="application/zip", string customData=default(string))
	Updates a trained classifier. The total size of all files must be below 256mb. More...
bool	UpdateClassifier (OnTrainClassifier callback, string classifierID, string classifierName, Dictionary< string, byte[]> positiveExamplesData, byte[] negativeExamplesData=null, string mimeType="application/zip", string customData=default(string))
	Updates a classifier using byte data. More...
bool	DeleteClassifier (OnDeleteClassifier callback, string classifierId, string customData=default(string))
	Deletes the classifier by classifierID. More...
bool	GetCollections (OnGetCollections callback, string customData=default(string))
	Get all collections. More...
bool	CreateCollection (OnCreateCollection callback, string name, string customData=null)
	Create a new collection of images to search. You can create a maximum of 5 collections. More...
bool	DeleteCollection (OnDeleteCollection callback, string collectionID, string customData=null)
	Deletes a collection. More...
bool	GetCollection (OnGetCollection callback, string collectionID, string customData=default(string))
	Retrieve information about a specific collection. Only user-created collections can be specified. More...
bool	GetCollectionImages (OnGetCollectionImages callback, string collectionID, string customData=default(string))
	List 100 images in a collection More...
bool	AddCollectionImage (OnAddCollectionImage callback, string collectionID, string imagePath, Dictionary< string, string > metadata=null, string customData=null)
	Add an image to a collection via image path on file system and metadata as dictionary. More...
bool	AddCollectionImage (OnAddCollectionImage callback, string collectionID, string imagePath, string metadataPath=null, string customData=null)
	Add an image to a collection via image path on file system and metadata path on file system. More...
bool	AddCollectionImage (OnAddCollectionImage callback, string collectionID, byte[] imageData, string filename, string metadata=null, string customData=null)
	Add an image to a collection. More...
bool	DeleteCollectionImage (OnDeleteCollectionImage callback, string collectionID, string imageID, string customData=null)
	Deletes an image from a collection. More...
bool	GetImage (OnGetImageDetails callback, string collectionID, string imageID, string customData=default(string))
	List an image's details. More...
bool	DeleteCollectionImageMetadata (OnDeleteImageMetadata callback, string collectionID, string imageID, string customData=null)
	Deletes an image metadata. More...
bool	GetMetadata (OnGetImageMetadata callback, string collectionID, string imageID, string customData=default(string))
	List image metadata.. More...
bool	FindSimilar (OnFindSimilar callback, string collectionID, string imagePath, int limit=10, string customData=null)
	Find Similar Images by image path. More...
bool	FindSimilar (OnFindSimilar callback, string collectionID, byte[] imageData, int limit=10, string customData=null)
	Find Similar Images by byte[]. More...
string	GetServiceID ()
	<exclude> More...

Properties
LoadFileDelegate	LoadFile [get, set]
	Set this property to overload the internal file loading of this class. More...
string	Url [get, set]
	Gets and sets the endpoint URL for the service. More...
string	VersionDate [get, set]
	Gets and sets the versionDate of the service. More...
Credentials	Credentials [get, set]
	Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined. More...

Detailed Description

This class wraps the Visual Recognition service. Visual Recognition Service

Constructor & Destructor Documentation

IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.VisualRecognition ( Credentials  credentials )

inline

Member Function Documentation

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.AddCollectionImage ( OnAddCollectionImage  callback, string  collectionID, string  imagePath, Dictionary< string, string >  metadata = null, string  customData = null  )

inline

Add an image to a collection via image path on file system and metadata as dictionary.

Parameters

callback	The callback.
collectionID	The identifier of the collection to add images to.
imagePath	The path in the filesystem of the image to add.
metadata	Optional Dictionary key value pairs of metadata associated with the specified image.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.AddCollectionImage ( OnAddCollectionImage  callback, string  collectionID, string  imagePath, string  metadataPath = null, string  customData = null  )

inline

Add an image to a collection via image path on file system and metadata path on file system.

Parameters

callback	The callback.
collectionID	The identifier of the collection to add images to.
imagePath	The path in the filesystem of the image to add.
metadataPath	Optional path to metadata json associated with the specified image.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.AddCollectionImage ( OnAddCollectionImage  callback, string  collectionID, byte[]  imageData, string  filename, string  metadata = null, string  customData = null  )

inline

Add an image to a collection.

Parameters

callback	The callback.
collectionID	The identifier of the collection to add images to.
imageData	The byte[] data of the image to add.
metadata	Optional json metadata associated with the specified image.
customData	Optional custom data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.Classify ( OnClassify  callback, string  url, string[]  owners = default(string[]), string[]  classifierIDs = default(string[]), float  threshold = default(float), string  acceptLanguage = "en", string  customData = default(string)  )

inline

Classifies image specified by URL.

Parameters

url	URL.
callback	Callback.
owners	Owners.
classifierIDs	Classifier IDs to be classified against.
threshold	Threshold.
acceptLanguage	Accept language.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.Classify ( string  imagePath, OnClassify  callback, string[]  owners = default(string[]), string[]  classifierIDs = default(string[]), float  threshold = default(float), string  acceptLanguage = "en", string  customData = default(string)  )

inline

Classifies an image from the file system.

Parameters

callback	Callback.
imagePath	Image path.
owners	Owners.
classifierIDs	Classifier I ds.
threshold	Threshold.
acceptLanguage	Accept language.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.Classify ( OnClassify  callback, byte[]  imageData, string[]  owners = default(string[]), string[]  classifierIDs = default(string[]), float  threshold = default(float), string  acceptLanguage = "en", string  customData = default(string)  )

inline

Classifies an image using byte data.

Parameters

callback	Callback.
imageData	Byte array of image data.
owners	Owners.
classifierIDs	An array of classifier identifiers.
threshold	Threshold.
acceptLanguage	Accepted language.
customData	Custom data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.CreateCollection ( OnCreateCollection  callback, string  name, string  customData = null  )

inline

Create a new collection of images to search. You can create a maximum of 5 collections.

Parameters

callback	The callback.
name	The name of the created collection.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DeleteClassifier ( OnDeleteClassifier  callback, string  classifierId, string  customData = default(string)  )

inline

Deletes the classifier by classifierID.

Returns

true, if classifier was deleted, false otherwise.

Parameters

classifierId	Classifier identifier.
callback	Callback.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DeleteCollection ( OnDeleteCollection  callback, string  collectionID, string  customData = null  )

inline

Deletes a collection.

Parameters

callback	The OnDeleteCollection callback.
collectionID	The collection identifier to delete.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DeleteCollectionImage ( OnDeleteCollectionImage  callback, string  collectionID, string  imageID, string  customData = null  )

inline

Deletes an image from a collection.

Parameters

callback	The OnDeleteCollection callback.
collectionID	The collection identifier holding the image to delete.
imageID	The identifier of the image to delete.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DeleteCollectionImageMetadata ( OnDeleteImageMetadata  callback, string  collectionID, string  imageID, string  customData = null  )

inline

Deletes an image metadata.

Parameters

callback	The Callback.
collectionID	The collection identifier holding the image metadata to delete.
imageID	The identifier of the image metadata to delete.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DetectFaces ( OnDetectFaces  callback, string  url, string  customData = default(string)  )

inline

Detects faces in a given image URL.

Returns

true, if faces was detected, false otherwise.

Parameters

url	URL.
callback	Callback.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DetectFaces ( string  imagePath, OnDetectFaces  callback, string  customData = default(string)  )

inline

Detects faces in a jpg, gif, png or zip file.

Returns

true, if faces was detected, false otherwise.

Parameters

callback	Callback.
imagePath	Image path.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.DetectFaces ( OnDetectFaces  callback, byte[]  imageData = default(byte[]), string  customData = default(string)  )

inline

Detect faces in an image's byteData.

Parameters

callback	Callback.
imageData	ByteArray of image data.
customData	Custom data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.FindSimilar ( OnFindSimilar  callback, string  collectionID, string  imagePath, int  limit = 10, string  customData = null  )

inline

Find Similar Images by image path.

Parameters

callback	The callback.
collectionID	The identifier of the collection to add images to.
imagePath	The path in the filesystem of the image to query.
limit	The number of similar results you want returned. Default limit is 10 results, you can specify a maximum limit of 100 results.
customData	Optional custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.FindSimilar ( OnFindSimilar  callback, string  collectionID, byte[]  imageData, int  limit = 10, string  customData = null  )

inline

Find Similar Images by byte[].

Parameters

callback	The callback.
collectionID	The identifier of the collection to add images to.
imageData	The byte[] data of the image to query.
limit	The number of similar results you want returned. Default limit is 10 results, you can specify a maximum limit of 100 results.
customData	Optional custom data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetClassifier ( OnGetClassifier  callback, string  classifierId, string  customData = default(string)  )

inline

Gets a classifier by classifierId.

Returns

true, if classifier was gotten, false otherwise.

Parameters

classifierId	Classifier identifier.
callback	Callback.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetClassifiers ( OnGetClassifiers  callback, string  customData = default(string)  )

inline

Gets a list of all classifiers.

Returns

true, if classifiers was gotten, false otherwise.

Parameters

callback	Callback.
customData	CustomData.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetCollection ( OnGetCollection  callback, string  collectionID, string  customData = default(string)  )

inline

Retrieve information about a specific collection. Only user-created collections can be specified.

Parameters

callback	The callback.
collectionID	The requested collection identifier.
customData	Custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetCollectionImages ( OnGetCollectionImages  callback, string  collectionID, string  customData = default(string)  )

inline

List 100 images in a collection

Parameters

callback	The callback.
collectionID	The requested collection identifier.
customData	Custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetCollections ( OnGetCollections  callback, string  customData = default(string)  )

inline

Get all collections.

Parameters

callback	The callback.
customData	Custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetImage ( OnGetImageDetails  callback, string  collectionID, string  imageID, string  customData = default(string)  )

inline

List an image's details.

Parameters

callback	The callback.
collectionID	The requested collection identifier.
customData	Custom data.

Returns

Returns true if succeess, false if failure.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetMetadata ( OnGetImageMetadata  callback, string  collectionID, string  imageID, string  customData = default(string)  )

inline

List image metadata..

Parameters

callback	The callback.
collectionID	The requested collection identifier.
imageID	The requested image identifier.
customData	Custom data.

Returns

Returns true if succeess, false if failure.

string IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.GetServiceID ( )

inline

<exclude>

Implements IBM.Watson.DeveloperCloud.Services.IWatsonService.

delegate byte [] IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.LoadFileDelegate

(

string

filename

)

The delegate for loading a file, used by TrainClassifier().

Parameters

filename

The filename to load.

Returns

Should return a byte array of the file contents or null of failure.

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnAddCollectionImage	(	CollectionsConfig	config,
		string	data
	)

This callback is used by the AddCollectionImage() method.

Parameters

config	The collection config.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnClassify	(	ClassifyTopLevelMultiple	classify,
		string	data
	)

This callback is used by the Classify() method.

Parameters

classify	Returned classification.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnCreateCollection	(	CreateCollection	collection,
		string	data
	)

This callback is used by the CreateCollection() method.

Parameters

collection	The created collection.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnDeleteClassifier	(	bool	success,
		string	data
	)

This callback is used by the DeleteClassifier() method.

Parameters

success	Success or failure of the delete call.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnDeleteCollection	(	bool	success,
		string	data
	)

This callback is used by the DeleteCollection() method.

Parameters

success	Success of the delete call.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnDeleteCollectionImage	(	bool	success,
		string	data
	)

This callback is used by the DeleteCollectionImage() method.

Parameters

success	Success or failure of deleting collection image.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnDeleteImageMetadata	(	bool	success,
		string	data
	)

This callback is used by the DeleteImageMetadata() method.

Parameters

success	Success of the delete call.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnDetectFaces	(	FacesTopLevelMultiple	faces,
		string	data
	)

This callback is used by the DetectFaces() method.

Parameters

faces	Faces Detected.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnFindSimilar	(	SimilarImagesConfig	similarImages,
		string	data
	)

This callback is used by the FindSimilar() method.

Parameters

similarImages
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetClassifier	(	GetClassifiersPerClassifierVerbose	classifier,
		string	data
	)

Callback used by the GetClassifier() method.

Parameters

classifier	The classifier found by ID.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetClassifiers	(	GetClassifiersTopLevelBrief	classifiers,
		string	data
	)

The callback used by the GetClassifiers() method.

Parameters

classifiers	A brief description of classifiers.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetCollection	(	CreateCollection	collection,
		string	data
	)

This callback is used y the GetCollection() method.

Parameters

collection	The collection.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetCollectionImages	(	GetCollectionImages	images,
		string	data
	)

This callback is used by the GetCollectionImages() method.

Parameters

images	Collection images.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetCollections	(	GetCollections	collections,
		string	data
	)

This callback is used by the GetCollections() method.

Parameters

collections	Collections.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetImageDetails	(	GetCollectionsBrief	image,
		string	data
	)

This callback is used by the GetImageDetails() method.

Parameters

image	The image details.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnGetImageMetadata	(	object	metadata,
		string	data
	)

This callback is used by the GetImageMetadata() method.

Parameters

metadata
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnRecognizeText	(	TextRecogTopLevelMultiple	text,
		string	data
	)

This callback is used by the RecognizeText() method.

Parameters

text	Text Recognized.
data	Optional data

delegate void IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.OnTrainClassifier	(	GetClassifiersPerClassifierVerbose	classifier,
		string	data
	)

Callback used by the TrainClassifier() method.

Parameters

classifier	The classifier created.
data	Optional data

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.RecognizeText ( OnRecognizeText  callback, string  url, string  customData = default(string)  )

inline

Recognizes text given an image url.

Returns

true, if text was recognized, false otherwise.

Parameters

url	URL.
callback	Callback.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.RecognizeText ( string  imagePath, OnRecognizeText  callback, string  customData = default(string)  )

inline

Recognizes text in a given image.

Returns

true, if text was recognized, false otherwise.

Parameters

callback	Callback.
imagePath	Image path.
customData	Custom data.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.RecognizeText ( OnRecognizeText  callback, byte[]  imageData = default(byte[]), string  customData = default(string)  )

inline

Recognizes text in image bytedata.

Parameters

callback	Callback.
imageData	Image's byte array data.
customData	Custom data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.TrainClassifier ( OnTrainClassifier  callback, string  classifierName, Dictionary< string, string >  positiveExamples, string  negativeExamplesPath = default(string), string  mimeType = "application/zip", string  customData = default(string)  )

inline

Trains a classifier. Training requires a total of at least two zip files: Two positive example zips with at least 10 positive examples each or one zip file of 10 positive examples and a zip file of 10 negative examples. The total size of all files must be below 256mb. Additional training can be done by using UpdateClassifier.

Returns

true, if classifier was trained, false otherwise.

Parameters

callback	Callback.
classifierName	Classifier name.
positiveExamples	Dictionary of class name and positive example paths.
negativeExamplesPath	Negative example file path.
mimeType	Mime type of the positive examples and negative examples data. Use GetMimeType to get Mimetype from filename.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.TrainClassifier ( OnTrainClassifier  callback, string  classifierName, Dictionary< string, byte[]>  positiveExamplesData, byte[]  negativeExamplesData = null, string  mimeType = "application/zip", string  customData = default(string)  )

inline

Trains a classifier

Parameters

callback	Callback.
classifierName	Classifier name.
positiveExamplesData	Dictionary of class name and class training zip or image byte data.
negativeExamplesData	Negative examples zip or image byte data.
mimeType	Mime type of the positive examples and negative examples data.

Returns

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.UpdateClassifier ( OnTrainClassifier  callback, string  classifierID, string  classifierName, Dictionary< string, string >  positiveExamples, string  negativeExamplesPath = default(string), string  mimeType = "application/zip", string  customData = default(string)  )

inline

Updates a trained classifier. The total size of all files must be below 256mb.

Returns

true, if classifier was updated, false otherwise.

Parameters

callback	Callback.
classifierID	Classifier identifier.
classifierName	Classifier name.
positiveExamples	Dictionary of class name and positive example paths.
negativeExamplesPath	Negative example file path.
mimeType	Mimetype of the file. Use GetMimeType to get Mimetype from filename.

bool IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.UpdateClassifier ( OnTrainClassifier  callback, string  classifierID, string  classifierName, Dictionary< string, byte[]>  positiveExamplesData, byte[]  negativeExamplesData = null, string  mimeType = "application/zip", string  customData = default(string)  )

inline

Updates a classifier using byte data.

Parameters

callback	Callback.
classifierID	Classifier identifier.
classifierName	Classifier name.
positiveExamplesData	Dictionary of class name and class training zip or image byte data.
negativeExamplesData	Negative examples zip or image byte data.
mimeType	Mimetype of the file. Use GetMimeType to get Mimetype from filename.

Returns

Property Documentation

Credentials IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.Credentials

getset

Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined.

LoadFileDelegate IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.LoadFile

getset

Set this property to overload the internal file loading of this class.

string IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.Url

getset

Gets and sets the endpoint URL for the service.

string IBM.Watson.DeveloperCloud.Services.VisualRecognition.v3.VisualRecognition.VersionDate

getset

Gets and sets the versionDate of the service.

---

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

• Scripts/Services/VisualRecognition/v3/VisualRecognition.cs