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.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.6.0 or higher

Configs

Configuration

<watson-visual-recognition:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

apiKey

String

Your API key.

x 

versionDate

String

The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is 2016-05-20.

2016-05-20

 

Processors

Classify an Image

<watson-visual-recognition:classify-image>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

ClassifyImageRequest

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

#[payload]

 

Returns

Return Java Type Description

VisualClassification

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

Detect Faces

<watson-visual-recognition:detect-faces>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

ImageRequest

Request object that contains the image to be use.

#[payload]

 

Returns

Return Java Type Description

DetectedFaces

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

Recognize Text

<watson-visual-recognition:recognize-text>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

ImageRequest

Request object that contains the image to be use.

#[payload]

 

Returns

Return Java Type Description

RecognizedText

The text recognized in the image.

Retrieve the List of Classifiers

<watson-visual-recognition:retrieve-list-of-classifiers>

Retrieve a list of user-created classifiers. API Doc

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List

A list of classifiers associated with your API Key.

Retrieve Classifier Details

<watson-visual-recognition:retrieve-classifier-details>

Retrieve information about a specific classifier. API Doc

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

classifierId

String

The ID of the classifier for which you want details.

#[payload]

 

Returns

Return Java Type Description

VisualClassifier

A classifier associated with your API Key.

Delete a Classifier

<watson-visual-recognition:delete-classifier>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

classifierId

String

The ID of the classifier you want to delete.

#[payload]

 

Create a Classifier

<watson-visual-recognition:create-classifier>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

ClassifierRequest

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

#[payload]

 

Returns

Return Java Type Description

VisualClassifier

The classifier that was created.

Update a Classifier

<watson-visual-recognition:update-classifier>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

ClassifierRequest

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

#[payload]

 

Returns

Return Java Type Description

VisualClassifier

The classifier that was updated.