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

The IBM Watson™ Visual Recognition service uses deep learning algorithms to identify scenes, objects, and faces in images you upload to the service. You can create and train a custom classifier to identify subjects that suit your needs.

See Also:

Visual Recognition

Field Summary

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

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
VisualRecognition(java.lang.String versionDate) Instantiates a new `VisualRecognition`.
VisualRecognition(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `VisualRecognition` with IAM.
VisualRecognition(java.lang.String versionDate, java.lang.String apiKey) Deprecated. This form of authentication is deprecated and will be removed in the next major release. Please authenticate using IAM credentials, using either the (String, IamOptions) constructor or with the setIamCredentials() method.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<ClassifiedImages>	classify() Classify images.
ServiceCall<ClassifiedImages>	classify(ClassifyOptions classifyOptions) Classify images.
ServiceCall<Classifier>	createClassifier(CreateClassifierOptions createClassifierOptions) Create a classifier.
ServiceCall<java.lang.Void>	deleteClassifier(DeleteClassifierOptions deleteClassifierOptions) Delete a classifier.
ServiceCall<java.lang.Void>	deleteUserData(DeleteUserDataOptions deleteUserDataOptions) Delete labeled data.
ServiceCall<DetectedFaces>	detectFaces() Detect faces in images.
ServiceCall<DetectedFaces>	detectFaces(DetectFacesOptions detectFacesOptions) Detect faces in images.
ServiceCall<Classifier>	getClassifier(GetClassifierOptions getClassifierOptions) Retrieve classifier details.
ServiceCall<java.io.InputStream>	getCoreMlModel(GetCoreMlModelOptions getCoreMlModelOptions) Retrieve a Core ML model of a classifier.
ServiceCall<Classifiers>	listClassifiers() Retrieve a list of classifiers.
ServiceCall<Classifiers>	listClassifiers(ListClassifiersOptions listClassifiersOptions) Retrieve a list of classifiers.
protected void	setAuthentication(okhttp3.Request.Builder builder) Sets the authentication.
ServiceCall<Classifier>	updateClassifier(UpdateClassifierOptions updateClassifierOptions) Update a classifier.

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

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualRecognition

public VisualRecognition(java.lang.String versionDate)

Instantiates a new `VisualRecognition`.

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)

Deprecated. This form of authentication is deprecated and will be removed in the next major release. Please authenticate using IAM credentials, using either the (String, IamOptions) constructor or with the setIamCredentials() method.

Instantiates a new `VisualRecognition` with 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

VisualRecognition

public VisualRecognition(java.lang.String versionDate,
                 IamOptions iamOptions)

Instantiates a new `VisualRecognition` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

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.

iamOptions - the options for authenticating through IAM

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<ClassifiedImages> classify(ClassifyOptions classifyOptions)

Classify images. Classify images with built-in or custom classifiers.

Parameters:

classifyOptions - the ClassifyOptions containing the options for the call

Returns:

a ServiceCall with a response type of ClassifiedImages

classify

public ServiceCall<ClassifiedImages> classify()

Classify images. Classify images with built-in or custom classifiers.

Returns:

a ServiceCall with a response type of ClassifiedImages

detectFaces

public ServiceCall<DetectedFaces> detectFaces(DetectFacesOptions detectFacesOptions)

Detect faces in images. **Important:** On April 2, 2018, the identity information in the response to calls to the Face model was removed. The identity information refers to the `name` of the person, `score`, and `type_hierarchy` knowledge graph. For details about the enhanced Face model, see the [Release notes](https://cloud.ibm.com/docs/services/visual-recognition/release-notes.html#2april2018). Analyze and get data about faces in images. Responses can include estimated age and gender. This feature uses a built-in model, so no training is necessary. The Detect faces method does not support general biometric facial recognition. Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size is 10 MB. The minimum recommended pixel density is 32X32 pixels per inch.

Parameters:

detectFacesOptions - the DetectFacesOptions containing the options for the call

Returns:

a ServiceCall with a response type of DetectedFaces

detectFaces

public ServiceCall<DetectedFaces> detectFaces()

Detect faces in images. **Important:** On April 2, 2018, the identity information in the response to calls to the Face model was removed. The identity information refers to the `name` of the person, `score`, and `type_hierarchy` knowledge graph. For details about the enhanced Face model, see the [Release notes](https://cloud.ibm.com/docs/services/visual-recognition/release-notes.html#2april2018). Analyze and get data about faces in images. Responses can include estimated age and gender. This feature uses a built-in model, so no training is necessary. The Detect faces method does not support general biometric facial recognition. Supported image formats include .gif, .jpg, .png, and .tif. The maximum image size is 10 MB. The minimum recommended pixel density is 32X32 pixels per inch.

Returns:

a ServiceCall with a response type of DetectedFaces

createClassifier

public ServiceCall<Classifier> createClassifier(CreateClassifierOptions createClassifierOptions)

Create a classifier. Train a new multi-faceted classifier on the uploaded image data. Create your custom classifier with positive or negative examples. Include at least two sets of examples, either two positive example files or one positive and one negative file. You can upload a maximum of 256 MB per call. Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class names). The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Parameters:

createClassifierOptions - the CreateClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifier

deleteClassifier

public ServiceCall<java.lang.Void> deleteClassifier(DeleteClassifierOptions deleteClassifierOptions)

Delete a classifier.

Parameters:

deleteClassifierOptions - the DeleteClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getClassifier

public ServiceCall<Classifier> getClassifier(GetClassifierOptions getClassifierOptions)

Retrieve classifier details. Retrieve information about a custom classifier.

Parameters:

getClassifierOptions - the GetClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifier

listClassifiers

public ServiceCall<Classifiers> listClassifiers(ListClassifiersOptions listClassifiersOptions)

Retrieve a list of classifiers.

Parameters:

listClassifiersOptions - the ListClassifiersOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifiers

listClassifiers

public ServiceCall<Classifiers> listClassifiers()

Retrieve a list of classifiers.

Returns:

a ServiceCall with a response type of Classifiers

updateClassifier

public ServiceCall<Classifier> updateClassifier(UpdateClassifierOptions updateClassifierOptions)

Update a classifier. Update a custom classifier by adding new positive or negative classes (examples) or by adding new images to existing classes. You must supply at least one set of positive or negative examples. For details, see [Updating custom classifiers](https://cloud.ibm.com/docs/services/visual-recognition/customizing.html#updating-custom-classifiers). Encode all names in UTF-8 if they contain non-ASCII characters (.zip and image file names, and classifier and class names). The service assumes UTF-8 encoding if it encounters non-ASCII characters. **Tip:** Don't make retraining calls on a classifier until the status is ready. When you submit retraining requests in parallel, the last request overwrites the previous requests. The retrained property shows the last time the classifier retraining finished.

Parameters:

updateClassifierOptions - the UpdateClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifier

getCoreMlModel

public ServiceCall<java.io.InputStream> getCoreMlModel(GetCoreMlModelOptions getCoreMlModelOptions)

Retrieve a Core ML model of a classifier. Download a Core ML model file (.mlmodel) of a custom classifier that returns \"core_ml_enabled\": true in the classifier details.

Parameters:

getCoreMlModelOptions - the GetCoreMlModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of InputStream

deleteUserData

public ServiceCall<java.lang.Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)

Delete labeled data. Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID. You associate a customer ID with data by passing the `X-Watson-Metadata` header with a request that passes data. For more information about personal data and customer IDs, see [Information security](https://cloud.ibm.com/docs/services/visual-recognition/information-security.html).

Parameters:

deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void