com.ibm.watson.visual_recognition.v4

Class VisualRecognition

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.visual_recognition.v4.VisualRecognition

public class VisualRecognition
extends com.ibm.cloud.sdk.core.service.BaseService

Provide images to the IBM Watson™ Visual Recognition service for analysis. The service detects objects based on a set of images with training data.

See Also:

Visual Recognition

Field Summary

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
VisualRecognition(java.lang.String versionDate) Constructs a new `VisualRecognition` client using the DEFAULT_SERVICE_NAME.
VisualRecognition(java.lang.String versionDate, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `VisualRecognition` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
VisualRecognition(java.lang.String versionDate, java.lang.String serviceName) Constructs a new `VisualRecognition` client with the specified serviceName.
VisualRecognition(java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `VisualRecognition` client with the specified Authenticator and serviceName.

Method Summary

Methods

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetailsList>	addImages(AddImagesOptions addImagesOptions) Add images.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingDataObjects>	addImageTrainingData(AddImageTrainingDataOptions addImageTrainingDataOptions) Add training data to an image.
com.ibm.cloud.sdk.core.http.ServiceCall<AnalyzeResponse>	analyze(AnalyzeOptions analyzeOptions) Analyze images.
com.ibm.cloud.sdk.core.http.ServiceCall<Collection>	createCollection() Create a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<Collection>	createCollection(CreateCollectionOptions createCollectionOptions) Create a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteCollection(DeleteCollectionOptions deleteCollectionOptions) Delete a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteImage(DeleteImageOptions deleteImageOptions) Delete an image.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteObject(DeleteObjectOptions deleteObjectOptions) Delete an object.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteUserData(DeleteUserDataOptions deleteUserDataOptions) Delete labeled data.
com.ibm.cloud.sdk.core.http.ServiceCall<Collection>	getCollection(GetCollectionOptions getCollectionOptions) Get collection details.
com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetails>	getImageDetails(GetImageDetailsOptions getImageDetailsOptions) Get image details.
com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream>	getJpegImage(GetJpegImageOptions getJpegImageOptions) Get a JPEG file of an image.
com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream>	getModelFile(GetModelFileOptions getModelFileOptions) Get a model.
com.ibm.cloud.sdk.core.http.ServiceCall<ObjectMetadata>	getObjectMetadata(GetObjectMetadataOptions getObjectMetadataOptions) Get object metadata.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents>	getTrainingUsage() Get training usage.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents>	getTrainingUsage(GetTrainingUsageOptions getTrainingUsageOptions) Get training usage.
com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList>	listCollections() List collections.
com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList>	listCollections(ListCollectionsOptions listCollectionsOptions) List collections.
com.ibm.cloud.sdk.core.http.ServiceCall<ImageSummaryList>	listImages(ListImagesOptions listImagesOptions) List images.
com.ibm.cloud.sdk.core.http.ServiceCall<ObjectMetadataList>	listObjectMetadata(ListObjectMetadataOptions listObjectMetadataOptions) List object metadata.
com.ibm.cloud.sdk.core.http.ServiceCall<Collection>	train(TrainOptions trainOptions) Train a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<Collection>	updateCollection(UpdateCollectionOptions updateCollectionOptions) Update a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<UpdateObjectMetadata>	updateObjectMetadata(UpdateObjectMetadataOptions updateObjectMetadataOptions) Update an object name.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, 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)

Constructs a new `VisualRecognition` client using the DEFAULT_SERVICE_NAME.

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,
                 com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `VisualRecognition` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.

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.

authenticator - the Authenticator instance to be configured for this service

VisualRecognition

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

Constructs a new `VisualRecognition` client with the specified serviceName.

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.

serviceName - The name of the service to configure.

VisualRecognition

public VisualRecognition(java.lang.String versionDate,
                 java.lang.String serviceName,
                 com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `VisualRecognition` client with the specified Authenticator and serviceName.

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.

serviceName - The name of the service to configure.

authenticator - the Authenticator instance to be configured for this service

Method Detail

analyze

public com.ibm.cloud.sdk.core.http.ServiceCall<AnalyzeResponse> analyze(AnalyzeOptions analyzeOptions)

Analyze images.

Analyze images by URL, by file, or both against your own collection. Make sure that **training_status.objects.ready** is `true` for the feature before you use a collection to analyze images.

Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Parameters:

analyzeOptions - the AnalyzeOptions containing the options for the call

Returns:

a ServiceCall with a response type of AnalyzeResponse

createCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> createCollection(CreateCollectionOptions createCollectionOptions)

Create a collection.

Create a collection that can be used to store images.

To create a collection without specifying a name and description, include an empty JSON object in the request body.

Encode the name and description in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Parameters:

createCollectionOptions - the CreateCollectionOptions containing the options for the call

Returns:

a ServiceCall with a response type of Collection

createCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> createCollection()

Create a collection.

Create a collection that can be used to store images.

To create a collection without specifying a name and description, include an empty JSON object in the request body.

Encode the name and description in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Returns:

a ServiceCall with a response type of Collection

listCollections

public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList> listCollections(ListCollectionsOptions listCollectionsOptions)

List collections.

Retrieves a list of collections for the service instance.

Parameters:

listCollectionsOptions - the ListCollectionsOptions containing the options for the call

Returns:

a ServiceCall with a response type of CollectionsList

listCollections

public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList> listCollections()

List collections.

Retrieves a list of collections for the service instance.

Returns:

a ServiceCall with a response type of CollectionsList

getCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> getCollection(GetCollectionOptions getCollectionOptions)

Get collection details.

Get details of one collection.

Parameters:

getCollectionOptions - the GetCollectionOptions containing the options for the call

Returns:

a ServiceCall with a response type of Collection

updateCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> updateCollection(UpdateCollectionOptions updateCollectionOptions)

Update a collection.

Update the name or description of a collection.

Encode the name and description in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Parameters:

updateCollectionOptions - the UpdateCollectionOptions containing the options for the call

Returns:

a ServiceCall with a response type of Collection

deleteCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteCollection(DeleteCollectionOptions deleteCollectionOptions)

Delete a collection.

Delete a collection from the service instance.

Parameters:

deleteCollectionOptions - the DeleteCollectionOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getModelFile

public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getModelFile(GetModelFileOptions getModelFileOptions)

Get a model.

Download a model that you can deploy to detect objects in images. The collection must include a generated model, which is indicated in the response for the collection details as `"rscnn_ready": true`. If the value is `false`, train or retrain the collection to generate the model.

Currently, the model format is specific to Android apps. For more information about how to deploy the model to your app, see the [Watson Visual Recognition on Android](https://github.com/matt-ny/rscnn) project in GitHub.

Parameters:

getModelFileOptions - the GetModelFileOptions containing the options for the call

Returns:

a ServiceCall with a response type of InputStream

addImages

public com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetailsList> addImages(AddImagesOptions addImagesOptions)

Add images.

Add images to a collection by URL, by file, or both.

Encode the image and .zip file names in UTF-8 if they contain non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Parameters:

addImagesOptions - the AddImagesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ImageDetailsList

listImages

public com.ibm.cloud.sdk.core.http.ServiceCall<ImageSummaryList> listImages(ListImagesOptions listImagesOptions)

List images.

Retrieves a list of images in a collection.

Parameters:

listImagesOptions - the ListImagesOptions containing the options for the call

Returns:

a ServiceCall with a response type of ImageSummaryList

getImageDetails

public com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetails> getImageDetails(GetImageDetailsOptions getImageDetailsOptions)

Get image details.

Get the details of an image in a collection.

Parameters:

getImageDetailsOptions - the GetImageDetailsOptions containing the options for the call

Returns:

a ServiceCall with a response type of ImageDetails

deleteImage

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteImage(DeleteImageOptions deleteImageOptions)

Delete an image.

Delete one image from a collection.

Parameters:

deleteImageOptions - the DeleteImageOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

getJpegImage

public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getJpegImage(GetJpegImageOptions getJpegImageOptions)

Get a JPEG file of an image.

Download a JPEG representation of an image.

Parameters:

getJpegImageOptions - the GetJpegImageOptions containing the options for the call

Returns:

a ServiceCall with a response type of InputStream

listObjectMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<ObjectMetadataList> listObjectMetadata(ListObjectMetadataOptions listObjectMetadataOptions)

List object metadata.

Retrieves a list of object names in a collection.

Parameters:

listObjectMetadataOptions - the ListObjectMetadataOptions containing the options for the call

Returns:

a ServiceCall with a response type of ObjectMetadataList

updateObjectMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<UpdateObjectMetadata> updateObjectMetadata(UpdateObjectMetadataOptions updateObjectMetadataOptions)

Update an object name.

Update the name of an object. A successful request updates the training data for all images that use the object.

Parameters:

updateObjectMetadataOptions - the UpdateObjectMetadataOptions containing the options for the call

Returns:

a ServiceCall with a response type of UpdateObjectMetadata

getObjectMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<ObjectMetadata> getObjectMetadata(GetObjectMetadataOptions getObjectMetadataOptions)

Get object metadata.

Get the number of bounding boxes for a single object in a collection.

Parameters:

getObjectMetadataOptions - the GetObjectMetadataOptions containing the options for the call

Returns:

a ServiceCall with a response type of ObjectMetadata

deleteObject

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteObject(DeleteObjectOptions deleteObjectOptions)

Delete an object.

Delete one object from a collection. A successful request deletes the training data from all images that use the object.

Parameters:

deleteObjectOptions - the DeleteObjectOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

train

public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> train(TrainOptions trainOptions)

Train a collection.

Start training on images in a collection. The collection must have enough training data and untrained data (the **training_status.objects.data_changed** is `true`). If training is in progress, the request queues the next training job.

Parameters:

trainOptions - the TrainOptions containing the options for the call

Returns:

a ServiceCall with a response type of Collection

addImageTrainingData

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingDataObjects> addImageTrainingData(AddImageTrainingDataOptions addImageTrainingDataOptions)

Add training data to an image.

Add, update, or delete training data for an image. Encode the object name in UTF-8 if it contains non-ASCII characters. The service assumes UTF-8 encoding if it encounters non-ASCII characters.

Elements in the request replace the existing elements.

- To update the training data, provide both the unchanged and the new or changed values.

- To delete the training data, provide an empty value for the training data.

Parameters:

addImageTrainingDataOptions - the AddImageTrainingDataOptions containing the options for the call

Returns:

a ServiceCall with a response type of TrainingDataObjects

getTrainingUsage

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents> getTrainingUsage(GetTrainingUsageOptions getTrainingUsageOptions)

Get training usage.

Information about the completed training events. You can use this information to determine how close you are to the training limits for the month.

Parameters:

getTrainingUsageOptions - the GetTrainingUsageOptions containing the options for the call

Returns:

a ServiceCall with a response type of TrainingEvents

getTrainingUsage

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents> getTrainingUsage()

Get training usage.

Information about the completed training events. You can use this information to determine how close you are to the training limits for the month.

Returns:

a ServiceCall with a response type of TrainingEvents

deleteUserData

public com.ibm.cloud.sdk.core.http.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/visual-recognition?topic=visual-recognition-information-security).

Parameters:

deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void