Class ClassifyOptions
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class ClassifyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ClassifyOptions.AcceptLanguage
The desired language of parts of the response.static class
ClassifyOptions.Builder
Builder. -
Method Summary
Modifier and Type Method Description String
acceptLanguage()
Gets the acceptLanguage.List<String>
classifierIds()
Gets the classifierIds.InputStream
imagesFile()
Gets the imagesFile.String
imagesFileContentType()
Gets the imagesFileContentType.String
imagesFilename()
Gets the imagesFilename.ClassifyOptions.Builder
newBuilder()
New builder.List<String>
owners()
Gets the owners.Float
threshold()
Gets the threshold.String
url()
Gets the url.Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel
equals, hashCode, toString
-
Method Details
-
newBuilder
New builder.- Returns:
- a ClassifyOptions builder
-
imagesFile
Gets the imagesFile.An image file (.gif, .jpg, .png, .tif) or .zip file with images. Maximum image size is 10 MB. Include no more than 20 images and limit the .zip file to 100 MB. 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.
You can also include an image with the **url** parameter.
- Returns:
- the imagesFile
-
imagesFilename
Gets the imagesFilename.The filename for imagesFile.
- Returns:
- the imagesFilename
-
imagesFileContentType
Gets the imagesFileContentType.The content type of imagesFile. Values for this parameter can be obtained from the HttpMediaType class.
- Returns:
- the imagesFileContentType
-
url
Gets the url.The URL of an image (.gif, .jpg, .png, .tif) to analyze. The minimum recommended pixel density is 32X32 pixels, but the service tends to perform better with images that are at least 224 x 224 pixels. The maximum image size is 10 MB.
You can also include images with the **images_file** parameter.
- Returns:
- the url
-
threshold
Gets the threshold.The minimum score a class must have to be displayed in the response. Set the threshold to `0.0` to return all identified classes.
- Returns:
- the threshold
-
owners
Gets the owners.The categories of classifiers to apply. The **classifier_ids** parameter overrides **owners**, so make sure that **classifier_ids** is empty. - Use `IBM` to classify against the `default` general classifier. You get the same result if both **classifier_ids** and **owners** parameters are empty. - Use `me` to classify against all your custom classifiers. However, for better performance use **classifier_ids** to specify the specific custom classifiers to apply. - Use both `IBM` and `me` to analyze the image against both classifier categories.
- Returns:
- the owners
-
classifierIds
Gets the classifierIds.Which classifiers to apply. Overrides the **owners** parameter. You can specify both custom and built-in classifier IDs. The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters are empty.
The following built-in classifier IDs require no training: - `default`: Returns classes from thousands of general tags. - `food`: Enhances specificity and accuracy for images of food items. - `explicit`: Evaluates whether the image might be pornographic.
- Returns:
- the classifierIds
-
acceptLanguage
Gets the acceptLanguage.The desired language of parts of the response. See the response for details.
- Returns:
- the acceptLanguage
-