com.ibm.watson.visual_recognition.v3.model

Class ClassifyOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

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

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ClassifyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The classify options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassifyOptions.AcceptLanguage The desired language of parts of the response.
static class	ClassifyOptions.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	acceptLanguage
protected java.util.List<java.lang.String>	classifierIds
protected java.io.InputStream	imagesFile
protected java.lang.String	imagesFileContentType
protected java.lang.String	imagesFilename
protected java.util.List<java.lang.String>	owners
protected java.lang.Float	threshold
protected java.lang.String	url

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassifyOptions(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.Float	threshold() Gets the threshold.
java.lang.String	url() Gets the url.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

imagesFile

protected java.io.InputStream imagesFile

imagesFilename

protected java.lang.String imagesFilename

imagesFileContentType

protected java.lang.String imagesFileContentType

url

protected java.lang.String url

threshold

protected java.lang.Float threshold

owners

protected java.util.List<java.lang.String> owners

classifierIds

protected java.util.List<java.lang.String> classifierIds

acceptLanguage

protected java.lang.String acceptLanguage

Constructor Detail

ClassifyOptions

protected ClassifyOptions(ClassifyOptions.Builder builder)

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 (.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

public java.lang.String imagesFilename()

Gets the imagesFilename.

The filename for imagesFile.

Returns:

the imagesFilename

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

url

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

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 return all identified classes.

Returns:

the threshold

owners

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

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

acceptLanguage

public java.lang.String acceptLanguage()

Gets the acceptLanguage.

The desired language of parts of the response. See the response for details.

Returns:

the acceptLanguage