public class VisualRecognition extends WatsonService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
VERSION_DATE_2016_05_20
Version date.
|
defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION
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.
|
Modifier and Type | Method and Description |
---|---|
ServiceCall<java.lang.Void> |
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.
|
configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setDefaultHeaders, setEndPoint, setSkipAuthentication, toString
public static final java.lang.String VERSION_DATE_2016_05_20
public VisualRecognition(java.lang.String versionDate)
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.public VisualRecognition(java.lang.String versionDate, java.lang.String apiKey)
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 keyprotected void setAuthentication(okhttp3.Request.Builder builder)
WatsonService
setAuthentication
in class WatsonService
builder
- the new authenticationpublic ServiceCall<VisualClassification> classify(ClassifyImagesOptions options)
options
- the classify optionsVisualClassification
public ServiceCall<VisualClassifier> createClassifier(ClassifierOptions options)
options
- The parameters to create a classifierVisualClassifier
ClassifierOptions
,
VisualClassifier
public ServiceCall<VisualClassifier> updateClassifier(java.lang.String classifierId, ClassifierOptions options)
classifierId
- the classifier idoptions
- The parameters to create a classifierVisualClassifier
ClassifierOptions
,
VisualClassifier
public ServiceCall<java.lang.Void> deleteClassifier(java.lang.String classifierId)
classifierId
- the classifier ID to deleteVisualClassifier
public ServiceCall<DetectedFaces> detectFaces(VisualRecognitionOptions options)
options
- the recognize text optionsVisualClassification
public ServiceCall<VisualClassifier> getClassifier(java.lang.String classifierId)
classifierId
- the classifier IDVisualClassifier
public ServiceCall<java.util.List<VisualClassifier>> getClassifiers()
VisualClassifier
public ServiceCall<RecognizedText> recognizeText(VisualRecognitionOptions options)
options
- the recognize text optionsRecognizedText
@Deprecated public void setUsernameAndPassword(java.lang.String username, java.lang.String password)
api_key
instead of username and password. WatsonService.setApiKey(String)
setUsernameAndPassword
in class WatsonService
username
- the usernamepassword
- the passwordpublic ServiceCall<java.util.List<Collection>> getCollections()
public ServiceCall<Collection> getCollection(java.lang.String collectionId)
collectionId
- the collection idpublic ServiceCall<java.lang.Void> deleteCollection(java.lang.String collectionId)
collectionId
- the collection idpublic ServiceCall<java.lang.Void> deleteCollectionImage(java.lang.String collectionId, java.lang.String imageId)
collectionId
- the collection idimageId
- the image idpublic ServiceCall<java.lang.Void> addImageToCollection(AddImageToCollectionOptions options)
options
- the optionspublic ServiceCall<java.util.List<CollectionImage>> getCollectionImages(java.lang.String collectionId)
collectionId
- the collection idpublic ServiceCall<CollectionImage> getCollectionImage(java.lang.String collectionId, java.lang.String imageId)
collectionId
- the collection idimageId
- the imageIdpublic ServiceCall<java.util.List<CollectionImage>> findSimilarImages(FindSimilarImagesOptions options)
options
- the optionspublic ServiceCall<Collection> createCollection(java.lang.String name)
name
- the collection name