org.mule.modules.watsonvisualrecognition

Class WatsonVisualRecognitionConnector

java.lang.Object

org.mule.modules.watsonvisualrecognition.WatsonVisualRecognitionConnector

@RequiresEnterpriseLicense(allowEval=true)
 @ReconnectOn(exceptions=com.ibm.watson.developer_cloud.service.exception.ServiceUnavailableException.class)
 @Connector(name="watson-visual-recognition",
           friendlyName="Watson Visual Recognition",
           minMuleVersion="3.6.0")
public class WatsonVisualRecognitionConnector
extends Object

Visual Recognition allows users to understand the contents of an image or video frame, answering the question: “What is in this image?” Submit an image, and the service returns scores for relevant classifiers representing things such as objects, events and settings.

Author:

Admios

Constructor Summary

Constructors

Constructor and Description
WatsonVisualRecognitionConnector()

Method Summary

Modifier and Type	Method and Description
com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassification	classifyImage(ClassifyImageRequest request) Upload images or URLs to identify built-in classifiers by default.
com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier	createClassifier(ClassifierRequest request) Train a new multi-faceted classifier on the uploaded image data.
void	deleteClassifier(String classifierId) Delete a custom classifier with the specified classifier ID.
com.ibm.watson.developer_cloud.visual_recognition.v3.model.DetectedFaces	detectFaces(ImageRequest request) Analyze faces in images and get data about them, such as estimated age and gender.
Config	getConfig()
com.ibm.watson.developer_cloud.visual_recognition.v3.model.RecognizedText	recognizeText(ImageRequest request) Recognizes text in images.
com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier	retrieveClassifierDetails(String classifierId) Retrieve information about a specific classifier.
List<com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier>	retrieveListOfClassifiers() Retrieve a list of user-created classifiers.
void	setConfig(Config config)
com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier	updateClassifier(ClassifierRequest request) Update an existing classifier by adding new classes, or by adding new images to existing classes API Doc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatsonVisualRecognitionConnector

public WatsonVisualRecognitionConnector()

Method Detail

getConfig

public Config getConfig()

setConfig

public void setConfig(Config config)

classifyImage

@Processor(friendlyName="Classify an Image")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassification classifyImage(@RefOnly @Default(value="#[payload]")
                                                                                                                                                  ClassifyImageRequest request)
                                                                                                                                           throws IOException

Upload images or URLs to identify built-in classifiers by default. To identify custom classifiers, include the classifier_ids parameters. Images must be in .jpeg, or .png format. API Doc

Parameters:

request - Request object that contains the image and the classifier to be use.

Returns:

A object containing the list of detected classes in the image.

Throws:

IOException - When the connector can't process the image input stream.

detectFaces

@Processor(friendlyName="Detect Faces")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.DetectedFaces detectFaces(@RefOnly @Default(value="#[payload]")
                                                                                                                                    ImageRequest request)
                                                                                                                             throws IOException

Analyze faces in images and get data about them, such as estimated age and gender. Images must be in .jpeg, or .png format. API Doc

Parameters:

request - Request object that contains the image to be use.

Returns:

A object containing the list of detected faces, age, gender and position in the image.

Throws:

IOException - When the connector can't process the image input stream.

recognizeText

@Processor(friendlyName="Recognize Text")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.RecognizedText recognizeText(@RefOnly @Default(value="#[payload]")
                                                                                                                                         ImageRequest request)
                                                                                                                                  throws IOException

Recognizes text in images. This is a beta function of the Visual Recognition service that supports only English language text identification. API Doc

Parameters:

request - Request object that contains the image to be use.

Returns:

The text recognized in the image.

Throws:

IOException - When the connector can't process the image input stream.

retrieveListOfClassifiers

@Processor(friendlyName="Retrieve the List of Classifiers")
public List<com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier> retrieveListOfClassifiers()

Retrieve a list of user-created classifiers. API Doc

Returns:

A list of classifiers associated with your API Key.

retrieveClassifierDetails

@Processor(friendlyName="Retrieve Classifier Details")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier retrieveClassifierDetails(@Default(value="#[payload]")
                                                                                                                                                                    String classifierId)

Retrieve information about a specific classifier. API Doc

Parameters:

classifierId - The ID of the classifier for which you want details.

Returns:

A classifier associated with your API Key.

deleteClassifier

@Processor(friendlyName="Delete a Classifier")
public void deleteClassifier(@Default(value="#[payload]")
                                                                            String classifierId)

Delete a custom classifier with the specified classifier ID. API Doc

Parameters:

classifierId - The ID of the classifier you want to delete.

createClassifier

@Processor(friendlyName="Create a Classifier")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier createClassifier(@RefOnly @Default(value="#[payload]")
                                                                                                                                                   ClassifierRequest request)
                                                                                                                                            throws VisualRecognitionException

Train a new multi-faceted classifier on the uploaded image data. A new custom classifier can be trained by several compressed (.zip) files, including files containing positive or negative images (.jpg, or .png). You must supply at least two compressed files, either two positive example files or one positive and one negative example file. API Doc

Parameters:

request - Request object that contains the classifier name, the positive examples and the negative examples to be use during the creation of the classifier.

Returns:

The classifier that was created.

Throws:

VisualRecognitionException - When amount of items inside the zip is less than 10.

updateClassifier

@Processor(friendlyName="Update a Classifier")
public com.ibm.watson.developer_cloud.visual_recognition.v3.model.VisualClassifier updateClassifier(@RefOnly @Default(value="#[payload]")
                                                                                                                                                   ClassifierRequest request)
                                                                                                                                            throws VisualRecognitionException

Update an existing classifier by adding new classes, or by adding new images to existing classes API Doc

Parameters:

request - Request object that contains the classifier id, the positive examples and the negative examples to be use to update the classifier.

Returns:

The classifier that was updated.

Throws:

VisualRecognitionException - When some of the zip files are empty