com.ibm.watson.developer_cloud.visual_recognition.v3.model

Class ClassifyOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.visual_recognition.v3.model.ClassifyOptions

All Implemented Interfaces:

ObjectModel

public class ClassifyOptions
extends GenericModel

The classify options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassifyOptions.AcceptLanguage The language of the output class names.
static class	ClassifyOptions.Builder Builder.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	acceptLanguage() Gets the acceptLanguage.
java.util.List<java.lang.String>	classifierIds() Gets the classifierIds.
java.io.InputStream	imagesFile() Gets the imagesFile.
java.lang.String	imagesFileContentType() Gets the imagesFileContentType.
java.lang.String	imagesFilename() Gets the imagesFilename.
ClassifyOptions.Builder	newBuilder() New builder.
java.util.List<java.lang.String>	owners() Gets the owners.
java.lang.String	parameters() Deprecated. replaced by the top-level parameters url, threshold, owners, and classifierIds
java.lang.Float	threshold() Gets the threshold.
java.lang.String	url() Gets the url.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public ClassifyOptions.Builder newBuilder()

New builder.

Returns:

a ClassifyOptions builder

imagesFile

public java.io.InputStream imagesFile()

Gets the imagesFile. An image file (.jpg, .png) 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

public java.lang.String imagesFilename()

Gets the imagesFilename. The filename for imagesFile.

Returns:

the imagesFilename

acceptLanguage

public java.lang.String acceptLanguage()

Gets the acceptLanguage. The language of the output class names. The full set of languages is supported for the built-in classifier IDs: `default`, `food`, and `explicit`. The class names of custom classifiers are not translated. The response might not be in the specified language when the requested language is not supported or when there is no translation for the class name.

Returns:

the acceptLanguage

url

public java.lang.String url()

Gets the url. The URL of an image to analyze. Must be in .jpg, or .png format. The minimum recommended pixel density is 32X32 pixels per inch, and the maximum image size is 10 MB. You can also include images with the **images_file** parameter.

Returns:

the url

threshold

public java.lang.Float threshold()

Gets the threshold. The minimum score a class must have to be displayed in the response. Set the threshold to `0.0` to ignore the classification score and return all values.

Returns:

the threshold

owners

public java.util.List<java.lang.String> owners()

Gets the owners. The categories of classifiers to apply. Use `IBM` to classify against the `default` general classifier, and use `me` to classify against your custom classifiers. To analyze the image against both classifier categories, set the value to both `IBM` and `me`. The built-in `default` classifier is used if both **classifier_ids** and **owners** parameters are empty. The **classifier_ids** parameter overrides **owners**, so make sure that **classifier_ids** is empty.

Returns:

the owners

classifierIds

public java.util.List<java.lang.String> 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

imagesFileContentType

public java.lang.String imagesFileContentType()

Gets the imagesFileContentType. The content type of imagesFile. Values for this parameter can be obtained from the HttpMediaType class.

Returns:

the imagesFileContentType

parameters

public java.lang.String parameters()

Deprecated. replaced by the top-level parameters url, threshold, owners, and classifierIds

Gets the parameters.

Returns:

the parameters