com.ibm.watson.developer_cloud.visual_recognition.v1

Class VisualRecognition

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.visual_recognition.v1.VisualRecognition

public class VisualRecognition
extends WatsonService

The Visual Recognition service analyzes images, enabling you to understand their content without any accompanying descriptive text.

Version:

v1

See Also:

Visual Recognition

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMG_FILE The Constant IMG_FILE (value is "imgFile")
static String	LABELS_TO_CHECK The Constant LABELS_TO_CHECK (value is "labels_to_check").

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

VERSION

Constructor Summary

Constructors

Constructor and Description
VisualRecognition() Instantiates a new visual recognition.

Method Summary

Modifier and Type	Method and Description
LabelSet	getLabelSet() Gets the labels and label groups.
VisualRecognitionImages	recognize(File image) Classifies the images against all the label groups and labels.
VisualRecognitionImages	recognize(File image, LabelSet labelSet) Classifies the images against the label groups and labels.
VisualRecognitionImages	recognize(String imageName, InputStream image, LabelSet labelSet)

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

IMG_FILE

public static final String IMG_FILE

The Constant IMG_FILE (value is "imgFile")

See Also:

Constant Field Values

LABELS_TO_CHECK

public static final String LABELS_TO_CHECK

The Constant LABELS_TO_CHECK (value is "labels_to_check").

See Also:

Constant Field Values

Constructor Detail

VisualRecognition

public VisualRecognition()

Instantiates a new visual recognition.

Method Detail

getLabelSet

public LabelSet getLabelSet()

Gets the labels and label groups.

Returns:

the labels and label groups

recognize

public VisualRecognitionImages recognize(File image)

Classifies the images against all the label groups and labels. The response includes a score for a label if the score meets the minimum threshold of 0.5. If no score meets the threshold for an image, no labels are returned.

Parameters:

image - the image file

Returns:

the visual recognition images

recognize

public VisualRecognitionImages recognize(File image,
                                         LabelSet labelSet)

Classifies the images against the label groups and labels. The response includes a score for a label if the score meets the minimum threshold of 0.5. If no score meets the threshold for an image, no labels are returned.

Parameters:

image - the file image

labelSet - the labels to classify against

Returns:

the visual recognition images

recognize

public VisualRecognitionImages recognize(String imageName,
                                         InputStream image,
                                         LabelSet labelSet)