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

**Important**: As of September 8, 2017, the beta period for Similarity Search is closed. For more information, see [Visual Recognition API – Similarity Search Update](https://www.ibm.com/blogs/bluemix/2017/08/visual-recognition-api-similarity-search-update). 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. **Tip**: To test calls to the **Custom classifiers** methods with the API explorer, provide your `api_key` from your Bluemix service instance.

See Also:

Visual Recognition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_DATE_2016_05_20 The Constant VERSION_DATE_2016_05_20.

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 `VisualRecognition`.
VisualRecognition(java.lang.String versionDate, java.lang.String apiKey) Instantiates a new `VisualRecognition` with API Key.

Method Summary

Modifier and Type	Method and Description
ServiceCall<ClassifiedImages>	classify(ClassifyOptions classifyOptions) Classify images.
ServiceCall<Classifier>	createClassifier(CreateClassifierOptions createClassifierOptions) Create a classifier.
ServiceCall<java.lang.Void>	deleteClassifier(DeleteClassifierOptions deleteClassifierOptions) Delete a custom classifier.
ServiceCall<DetectedFaces>	detectFaces(DetectFacesOptions detectFacesOptions) Detect faces in an image.
ServiceCall<Classifier>	getClassifier(GetClassifierOptions getClassifierOptions) Retrieve information about a custom classifier.
ServiceCall<Classifiers>	listClassifiers(ListClassifiersOptions listClassifiersOptions) Retrieve a list of custom 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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, 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

The Constant VERSION_DATE_2016_05_20.

See Also:

Constant Field Values

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)

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

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.

Parameters:

classifyOptions - the ClassifyOptions containing the options for the call

Returns:

the ClassifiedImages with the response

detectFaces

public ServiceCall<DetectedFaces> detectFaces(DetectFacesOptions detectFacesOptions)

Detect faces in an image.

Parameters:

detectFacesOptions - the DetectFacesOptions containing the options for the call

Returns:

the DetectedFaces with the response

createClassifier

public ServiceCall<Classifier> createClassifier(CreateClassifierOptions createClassifierOptions)

Create a classifier.

Parameters:

createClassifierOptions - the CreateClassifierOptions containing the options for the call

Returns:

the Classifier with the response

deleteClassifier

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

Delete a custom classifier.

Parameters:

deleteClassifierOptions - the DeleteClassifierOptions containing the options for the call

Returns:

the service call

getClassifier

public ServiceCall<Classifier> getClassifier(GetClassifierOptions getClassifierOptions)

Retrieve information about a custom classifier.

Parameters:

getClassifierOptions - the GetClassifierOptions containing the options for the call

Returns:

the Classifier with the response

listClassifiers

public ServiceCall<Classifiers> listClassifiers(ListClassifiersOptions listClassifiersOptions)

Retrieve a list of custom classifiers.

Parameters:

listClassifiersOptions - the ListClassifiersOptions containing the options for the call

Returns:

the Classifiers with the response

updateClassifier

public ServiceCall<Classifier> updateClassifier(UpdateClassifierOptions updateClassifierOptions)

Update a classifier.

Parameters:

updateClassifierOptions - the UpdateClassifierOptions containing the options for the call

Returns:

the Classifier with the response