com.ibm.watson.developer_cloud.visual_recognition.v3

Class VisualRecognition

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.visual_recognition.v3.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.

See Also:

Visual Recognition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_DATE_2016_05_20 Version date.

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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
VisualRecognition(java.lang.String versionDate) Instantiates a new Visual Recognition V3 service.
VisualRecognition(java.lang.String versionDate, java.lang.String apiKey) Instantiates a new Visual Recognition V3 service with a given API key.

Method Summary

Modifier and Type	Method and Description
ServiceCall<java.util.List<CollectionImage>>	addImageToCollection(AddImageToCollectionOptions options) Adds the image to collection.
ServiceCall<VisualClassification>	classify(ClassifyImagesOptions options) Classify.
ServiceCall<VisualClassifier>	createClassifier(ClassifierOptions options) Train a new classifier on the uploaded image data.
ServiceCall<Collection>	createCollection(java.lang.String name) Creates a collection.
ServiceCall<java.lang.Void>	deleteClassifier(java.lang.String classifierId) Deletes a classifier.
ServiceCall<java.lang.Void>	deleteCollection(java.lang.String collectionId) Deletes a collection.
ServiceCall<java.lang.Void>	deleteCollectionImage(java.lang.String collectionId, java.lang.String imageId) Deletes a collection.
ServiceCall<DetectedFaces>	detectFaces(VisualRecognitionOptions options) Detect faces.
ServiceCall<java.util.List<CollectionImage>>	findSimilarImages(FindSimilarImagesOptions options) Find similar images.
ServiceCall<VisualClassifier>	getClassifier(java.lang.String classifierId) Retrieve information about a specific classifier.
ServiceCall<java.util.List<VisualClassifier>>	getClassifiers() Retrieve the user-trained classifiers.
ServiceCall<Collection>	getCollection(java.lang.String collectionId) Gets the collection information.
ServiceCall<CollectionImage>	getCollectionImage(java.lang.String collectionId, java.lang.String imageId) Gets the collection image.
ServiceCall<java.util.List<CollectionImage>>	getCollectionImages(java.lang.String collectionId) Gets the collection images.
ServiceCall<java.util.List<Collection>>	getCollections() Gets the collections.
ServiceCall<RecognizedText>	recognizeText(VisualRecognitionOptions options) Recognize text.
protected void	setAuthentication(okhttp3.Request.Builder builder) Sets the authentication.
void	setUsernameAndPassword(java.lang.String username, java.lang.String password) Deprecated.
ServiceCall<VisualClassifier>	updateClassifier(java.lang.String classifierId, ClassifierOptions options) Update an existing classifier by adding new classes, or by adding new images to existing classes.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_DATE_2016_05_20

public static final java.lang.String VERSION_DATE_2016_05_20

Version date.

See Also:

Constant Field Values

Constructor Detail

VisualRecognition

public VisualRecognition(java.lang.String versionDate)

Instantiates a new Visual Recognition V3 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.

VisualRecognition

public VisualRecognition(java.lang.String versionDate,
                         java.lang.String apiKey)

Instantiates a new Visual Recognition V3 service with a given API key.

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.

apiKey - the api key

Method Detail

setAuthentication

protected void setAuthentication(okhttp3.Request.Builder builder)

Description copied from class: WatsonService

Sets the authentication. Okhttp3 compliant.

Overrides:

setAuthentication in class WatsonService

Parameters:

builder - the new authentication

classify

public ServiceCall<VisualClassification> classify(ClassifyImagesOptions options)

Classify.

Parameters:

options - the classify options

Returns:

the VisualClassification

createClassifier

public ServiceCall<VisualClassifier> createClassifier(ClassifierOptions options)

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.

Parameters:

options - The parameters to create a classifier

Returns:

The created VisualClassifier

See Also:

ClassifierOptions, VisualClassifier

updateClassifier

public ServiceCall<VisualClassifier> updateClassifier(java.lang.String classifierId,
                                                      ClassifierOptions options)

Update an existing classifier by adding new classes, or by adding new images to existing classes. To update the existing classifier, use several compressed (.zip) files, including files containing positive or negative images (.jpg, or .png). You must supply at least one compressed file, with additional positive or negative examples.

Parameters:

classifierId - the classifier id

options - The parameters to create a classifier

Returns:

The created VisualClassifier

See Also:

ClassifierOptions, VisualClassifier

deleteClassifier

public ServiceCall<java.lang.Void> deleteClassifier(java.lang.String classifierId)

Deletes a classifier.

Parameters:

classifierId - the classifier ID to delete

Returns:

the service call

See Also:

VisualClassifier

detectFaces

public ServiceCall<DetectedFaces> detectFaces(VisualRecognitionOptions options)

Detect faces.

Parameters:

options - the recognize text options

Returns:

the VisualClassification

getClassifier

public ServiceCall<VisualClassifier> getClassifier(java.lang.String classifierId)

Retrieve information about a specific classifier. Only user-trained classifiers may be addressed.

Parameters:

classifierId - the classifier ID

Returns:

the classifier

See Also:

VisualClassifier

getClassifiers

public ServiceCall<java.util.List<VisualClassifier>> getClassifiers()

Retrieve the user-trained classifiers.

Returns:

the classifier list

See Also:

VisualClassifier

recognizeText

public ServiceCall<RecognizedText> recognizeText(VisualRecognitionOptions options)

Recognize text.

Parameters:

options - the recognize text options

Returns:

the RecognizedText

setUsernameAndPassword

@Deprecated
public void setUsernameAndPassword(java.lang.String username,
                                               java.lang.String password)

Deprecated.

The Visual Recognition V3 service use an api_key instead of username and password.
Use: WatsonService.setApiKey(String)

Overrides:

setUsernameAndPassword in class WatsonService

Parameters:

username - the username

password - the password

getCollections

public ServiceCall<java.util.List<Collection>> getCollections()

Gets the collections.

Returns:

the collections

getCollection

public ServiceCall<Collection> getCollection(java.lang.String collectionId)

Gets the collection information.

Parameters:

collectionId - the collection id

Returns:

the collection

deleteCollection

public ServiceCall<java.lang.Void> deleteCollection(java.lang.String collectionId)

Deletes a collection.

Parameters:

collectionId - the collection id

Returns:

the service call

deleteCollectionImage

public ServiceCall<java.lang.Void> deleteCollectionImage(java.lang.String collectionId,
                                                         java.lang.String imageId)

Deletes a collection.

Parameters:

collectionId - the collection id

imageId - the image id

Returns:

the service call

addImageToCollection

public ServiceCall<java.util.List<CollectionImage>> addImageToCollection(AddImageToCollectionOptions options)

Adds the image to collection.

Parameters:

options - the options

Returns:

the service call

getCollectionImages

public ServiceCall<java.util.List<CollectionImage>> getCollectionImages(java.lang.String collectionId)

Gets the collection images.

Parameters:

collectionId - the collection id

Returns:

the collection images

getCollectionImage

public ServiceCall<CollectionImage> getCollectionImage(java.lang.String collectionId,
                                                       java.lang.String imageId)

Gets the collection image.

Parameters:

collectionId - the collection id

imageId - the imageId

Returns:

the collection image

findSimilarImages

public ServiceCall<java.util.List<CollectionImage>> findSimilarImages(FindSimilarImagesOptions options)

Find similar images.

Parameters:

options - the options

Returns:

the service call

createCollection

public ServiceCall<Collection> createCollection(java.lang.String name)

Creates a collection.

Parameters:

name - the collection name

Returns:

the service call