com.ibm.watson.visual_recognition.v4.model

Class AnalyzeOptions

java.lang.Object

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

com.ibm.watson.visual_recognition.v4.model.AnalyzeOptions

All Implemented Interfaces:

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

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

The analyze options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyzeOptions.Builder Builder.
static interface	AnalyzeOptions.Features

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	collectionIds
protected java.util.List<java.lang.String>	features
protected java.util.List<com.ibm.cloud.sdk.core.service.model.FileWithMetadata>	imagesFile
protected java.util.List<java.lang.String>	imageUrl
protected java.lang.Float	threshold

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyzeOptions(AnalyzeOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	collectionIds() Gets the collectionIds.
java.util.List<java.lang.String>	features() Gets the features.
java.util.List<com.ibm.cloud.sdk.core.service.model.FileWithMetadata>	imagesFile() Gets the imagesFile.
java.util.List<java.lang.String>	imageUrl() Gets the imageUrl.
AnalyzeOptions.Builder	newBuilder() New builder.
java.lang.Float	threshold() Gets the threshold.

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

collectionIds

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

features

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

imagesFile

protected java.util.List<com.ibm.cloud.sdk.core.service.model.FileWithMetadata> imagesFile

imageUrl

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

threshold

protected java.lang.Float threshold

Constructor Detail

AnalyzeOptions

protected AnalyzeOptions(AnalyzeOptions.Builder builder)

Method Detail

newBuilder

public AnalyzeOptions.Builder newBuilder()

New builder.

Returns:

a AnalyzeOptions builder

collectionIds

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

Gets the collectionIds.

The IDs of the collections to analyze.

Returns:

the collectionIds

features

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

Gets the features.

The features to analyze.

Returns:

the features

imagesFile

public java.util.List<com.ibm.cloud.sdk.core.service.model.FileWithMetadata> imagesFile()

Gets the imagesFile.

An array of image files (.jpg or .png) or .zip files with images. - Include a maximum of 20 images in a request. - Limit the .zip file to 100 MB. - Limit each image file to 10 MB.

You can also include an image with the **image_url** parameter.

Returns:

the imagesFile

imageUrl

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

Gets the imageUrl.

An array of URLs of image files (.jpg or .png). - Include a maximum of 20 images in a request. - Limit each image file to 10 MB. - Minimum width and height is 30 pixels, but the service tends to perform better with images that are at least 300 x 300 pixels. Maximum is 5400 pixels for either height or width.

You can also include images with the **images_file** parameter.

Returns:

the imageUrl

threshold

public java.lang.Float threshold()

Gets the threshold.

The minimum score a feature must have to be returned.

Returns:

the threshold