com.ibm.watson.developer_cloud.visual_insights.v1_experimental

Class VisualInsights

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.visual_insights.v1_experimental.VisualInsights

public class VisualInsights
extends WatsonService

The IBM Watson Visual Insights gives insight into the themes present in a collection of images based on their visual appearance / content.

Version:

v1

See Also:

Visual Insights

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_NAME The Constant FILTER_NAME.

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

MESSAGE_CODE, MESSAGE_ERROR, VERSION

Constructor Summary

Constructors

Constructor and Description
VisualInsights() Instantiates a new visual insights service.

Method Summary

Modifier and Type	Method and Description
ServiceCall<Classifiers>	getClassifiers() Returns a summary of the collection's visual classifiers.
ServiceCall<Classifiers>	getClassifiers(String name) Returns a summary of the collection's visual classifiers, filtered by name.
ServiceCall<Summary>	getSummary(File imagesFile) Upload a set of images as a ZIP file for visual insight extraction.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, 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

FILTER_NAME

public static final String FILTER_NAME

The Constant FILTER_NAME.

See Also:

Constant Field Values

Constructor Detail

VisualInsights

public VisualInsights()

Instantiates a new visual insights service.

Method Detail

getClassifiers

public ServiceCall<Classifiers> getClassifiers()

Returns a summary of the collection's visual classifiers.

Returns:

the Summary

getClassifiers

public ServiceCall<Classifiers> getClassifiers(String name)

Returns a summary of the collection's visual classifiers, filtered by name.

Parameters:

name - the filter name

Returns:

the Classifiers that match the given filter name

getSummary

public ServiceCall<Summary> getSummary(File imagesFile)

Upload a set of images as a ZIP file for visual insight extraction.
Here is the code to get the Summary of a collection of images:

 VisualInsights service = new VisualInsights();
 service.setUsernameAndPassword("<username>", "<password>");
 
 File images = new File("images.zip");
 Summary summary = service.getSummary(images).execute();
 
 System.out.println(summary);
 

Parameters:

imagesFile - the images File

Returns:

the Summary of the collection's visual attributes