public class VisualRecognition
extends com.ibm.cloud.sdk.core.service.BaseService
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.
|
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> |
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<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<Collection> |
train(TrainOptions trainOptions)
Train a collection.
|
com.ibm.cloud.sdk.core.http.ServiceCall<Collection> |
updateCollection(UpdateCollectionOptions updateCollectionOptions)
Update a collection.
|
configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString
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, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
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 servicepublic VisualRecognition(java.lang.String versionDate, java.lang.String serviceName)
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.public VisualRecognition(java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
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 servicepublic com.ibm.cloud.sdk.core.http.ServiceCall<AnalyzeResponse> analyze(AnalyzeOptions analyzeOptions)
analyzeOptions
- the AnalyzeOptions
containing the options for the callServiceCall
with a response type of AnalyzeResponse
public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> createCollection(CreateCollectionOptions createCollectionOptions)
createCollectionOptions
- the CreateCollectionOptions
containing the options for the callServiceCall
with a response type of Collection
public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> createCollection()
ServiceCall
with a response type of Collection
public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList> listCollections(ListCollectionsOptions listCollectionsOptions)
listCollectionsOptions
- the ListCollectionsOptions
containing the options for the callServiceCall
with a response type of CollectionsList
public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionsList> listCollections()
ServiceCall
with a response type of CollectionsList
public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> getCollection(GetCollectionOptions getCollectionOptions)
getCollectionOptions
- the GetCollectionOptions
containing the options for the callServiceCall
with a response type of Collection
public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> updateCollection(UpdateCollectionOptions updateCollectionOptions)
updateCollectionOptions
- the UpdateCollectionOptions
containing the options for the callServiceCall
with a response type of Collection
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteCollection(DeleteCollectionOptions deleteCollectionOptions)
deleteCollectionOptions
- the DeleteCollectionOptions
containing the options for the callServiceCall
with a response type of Voidpublic com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetailsList> addImages(AddImagesOptions addImagesOptions)
addImagesOptions
- the AddImagesOptions
containing the options for the callServiceCall
with a response type of ImageDetailsList
public com.ibm.cloud.sdk.core.http.ServiceCall<ImageSummaryList> listImages(ListImagesOptions listImagesOptions)
listImagesOptions
- the ListImagesOptions
containing the options for the callServiceCall
with a response type of ImageSummaryList
public com.ibm.cloud.sdk.core.http.ServiceCall<ImageDetails> getImageDetails(GetImageDetailsOptions getImageDetailsOptions)
getImageDetailsOptions
- the GetImageDetailsOptions
containing the options for the callServiceCall
with a response type of ImageDetails
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteImage(DeleteImageOptions deleteImageOptions)
deleteImageOptions
- the DeleteImageOptions
containing the options for the callServiceCall
with a response type of Voidpublic com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getJpegImage(GetJpegImageOptions getJpegImageOptions)
getJpegImageOptions
- the GetJpegImageOptions
containing the options for the callServiceCall
with a response type of InputStream
public com.ibm.cloud.sdk.core.http.ServiceCall<Collection> train(TrainOptions trainOptions)
trainOptions
- the TrainOptions
containing the options for the callServiceCall
with a response type of Collection
public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingDataObjects> addImageTrainingData(AddImageTrainingDataOptions addImageTrainingDataOptions)
addImageTrainingDataOptions
- the AddImageTrainingDataOptions
containing the options for the callServiceCall
with a response type of TrainingDataObjects
public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents> getTrainingUsage(GetTrainingUsageOptions getTrainingUsageOptions)
getTrainingUsageOptions
- the GetTrainingUsageOptions
containing the options for the callServiceCall
with a response type of TrainingEvents
public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingEvents> getTrainingUsage()
ServiceCall
with a response type of TrainingEvents
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)
deleteUserDataOptions
- the DeleteUserDataOptions
containing the options for the callServiceCall
with a response type of Void