com.ibm.watson.developer_cloud.visual_recognition.v2_beta

Class VisualRecognition

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.visual_recognition.v2_beta.VisualRecognition

public class VisualRecognition
extends WatsonService

Visual Recognition allows you to derive insights from an image based on its visual content. You can organize image libraries, understand an individual image, and create custom classifiers for specific results that are tailored to your needs.

Version:

v2

See Also:

Visual Recognition

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_DATE_2015_12_02 Version date

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

MESSAGE_CODE, MESSAGE_ERROR, VERSION

Constructor Summary

Constructors

Constructor and Description
VisualRecognition(String versionDate) Instantiates a new Visual Recognition V2 service.

Method Summary

Modifier and Type	Method and Description
ServiceCall<VisualClassification>	classify(File imagesFile) Classifies the image/s against all the classifiers.
ServiceCall<VisualClassification>	classify(File imagesFile, VisualClassifier... classifiers) Classifies the images against the label groups and labels.
ServiceCall<VisualClassification>	classify(String filename, InputStream imagesInputStream, VisualClassifier... classifiers) Classifies the image/s against the Classifiers.
ServiceCall<VisualClassifier>	createClassifier(String name, File positiveImages, File negativeImages) Train a new classifier on the uploaded image data.
ServiceCall<Void>	deleteClassifier(String classifierId) Deletes a classifier.
ServiceCall<VisualClassifier>	getClassifier(String classifierId) Retrieves a classifier.
ServiceCall<List<VisualClassifier>>	getClassifiers() Retrieves the list of classifiers.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_DATE_2015_12_02

public static final String VERSION_DATE_2015_12_02

Version date

See Also:

Constant Field Values

Constructor Detail

VisualRecognition

public VisualRecognition(String versionDate)

Instantiates a new Visual Recognition V2 service.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

Method Detail

classify

public ServiceCall<VisualClassification> classify(File imagesFile)

Classifies the image/s against all the classifiers. The response includes a score for a classifier if the score meets the minimum threshold of 0.5. If no score meets the threshold for an image, no classifiers are returned.

Here is an example of how to classify an image using all the classifiers:

 VisualRecognition service = new VisualRecognition("2015-12-02");
 service.setUsernameAndPassword("<username>", "<password>");
 
 File image = new File("car.png");
 
 VisualClassification result = service.classify(image).execute();
 System.out.println(result);
 

Parameters:

imagesFile - the image/s to classify

Returns:

the visual recognition images

classify

public ServiceCall<VisualClassification> classify(File imagesFile,
                                                  VisualClassifier... classifiers)

Classifies the images against the label groups and labels. The response includes a score for a label if the score meets the minimum threshold of 0.5. If no score meets the threshold for an image, no labels are returned.

Here is an example of how to classify an image using an existing classifier:

 VisualRecognition service = new VisualRecognition("2015-12-02");
 service.setUsernameAndPassword("<username>", "<password>");
 
 File image = new File("car.png");
 VisualClassifier car = new VisualClassifier("Car");
 
 VisualClassification result = service.classify(image, car).execute();
 System.out.println(result);
 

Parameters:

imagesFile - the image/s to classify

classifiers - the classifiers

Returns:

the visual recognition images

classify

public ServiceCall<VisualClassification> classify(String filename,
                                                  InputStream imagesInputStream,
                                                  VisualClassifier... classifiers)

Classifies the image/s against the Classifiers. The response includes a score for a classifier only if the score meets the minimum threshold of 0.5. If no score meets the threshold for an image, no classifiers are returned.

Here is an example of how to classify an InputStream image with an existing classifier:

 VisualRecognition service = new VisualRecognition("2015-12-02");
 service.setUsernameAndPassword("<username>", "<password>");
 
 FileInputStream image = new FileInputStream("car.png");
 VisualClassifier car = new VisualClassifier("Car");
 
 VisualClassification result = service.classify("foo.png", image, car).execute();
 System.out.println(result);
 

Parameters:

filename - The file name

imagesInputStream - the image/s input stream to classify

classifiers - the classifiers

Returns:

the Classification

createClassifier

public ServiceCall<VisualClassifier> createClassifier(String name,
                                                      File positiveImages,
                                                      File negativeImages)

Train a new classifier on the uploaded image data. Upload a compressed (.zip) file of images (.jpg, .png, or .gif) with positive examples that show your classifier and another compressed file with negative examples that are similar to but do NOT show your classifier.

Here is an example of how to create a classifier with positive and negatives images:

 VisualRecognition service = new VisualRecognition("2015-12-02");
 service.setUsernameAndPassword("<username>", "<password>");
 
 File positiveImages = new File("positive.zip"); // zip file with at least 10 images
 File negativeImages = new File("negative.zip");
 
 VisualClassifier foo = service.createClassifier("foo", positiveImages, negativeImages).execute();
 System.out.println(foo);
 

Parameters:

name - the classifier name

positiveImages - A compressed (.zip) file of images which prominently depict the visual subject for a new classifier. Must contain a minimum of 10 images.

negativeImages - A compressed (.zip) file of images which do not depict the subject for a new classifier. Must contain a minimum of 10 images.

Returns:

the created VisualClassifier

See Also:

VisualClassifier

deleteClassifier

public ServiceCall<Void> deleteClassifier(String classifierId)

Deletes a classifier.

Parameters:

classifierId - the classifier ID to delete

Returns:

the service call

See Also:

VisualClassifier

getClassifier

public ServiceCall<VisualClassifier> getClassifier(String classifierId)

Retrieves a classifier.

Parameters:

classifierId - the classifier ID

Returns:

the classifier list

See Also:

VisualClassifier

getClassifiers

public ServiceCall<List<VisualClassifier>> getClassifiers()

Retrieves the list of classifiers.

Returns:

the classifier list

See Also:

VisualClassifier