com.ibm.watson.developer_cloud.alchemy.v1

Class AlchemyVision

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.service.AlchemyService

com.ibm.watson.developer_cloud.alchemy.v1.AlchemyVision

public class AlchemyVision
extends AlchemyService

The Alchemy Vision service uses deep learning innovations to understand a picture’s content and context. It sees complex visual scenes in their entirety —without needing any textual clues— leveraging a holistic approach to understanding the multiple objects and surroundings.

Version:

v1

See Also:

Alchemy Vision

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORCE_SHOW_ALL The Constant FORCE_SHOW_ALL.
static String	HTML The Constant HTML.
static String	IMAGE The Constant IMAGE.
static String	IMAGE_POST_MODE The Constant IMAGE_POST_MODE.
static String	KNOWLEDGE_GRAPH The Constant KNOWLEDGE_GRAPH.
static String	NOT_RAW The Constant NOT_RAW.
static String	RAW The Constant RAW.
static String	URL The Constant URL.

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

ENDPOINT, JSONP, OUTPUT_MODE

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

VERSION

Constructor Summary

Constructors

Constructor and Description
AlchemyVision()

Method Summary

Modifier and Type	Method and Description
ImageKeywords	getImageKeywords(File image, Boolean forceShowAll, Boolean knowledgeGraph) Extracts keywords from an image
ImageKeywords	getImageKeywords(URL url, Boolean forceShowAll, Boolean knowledgeGraph) Extracts keywords from a URL.
ImageLink	getImageLink(String html) Extracts the main image link from a HTML page.
ImageLink	getImageLink(URL url) Extracts main image link from a URL.
ImageFaces	recognizeFaces(File image, Boolean knowledgeGraph) Recognizes faces from an image. For each face detected returns: Bounding box Gender Approximate age Name (if celebrity is detected) Here is an example of how to recognize faces in an image:
ImageFaces	recognizeFaces(URL url, Boolean knowledgeGraph) Recognizes faces from a URL. For each face detected returns: Bounding box Gender Approximate age Name (if celebrity is detected) Here is an example of how to recognize faces in an image:

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

execute, executeRequest, getInputFormat, setAuthentication

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

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

Methods inherited from class java.lang.Object

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

Field Detail

FORCE_SHOW_ALL

public static final String FORCE_SHOW_ALL

The Constant FORCE_SHOW_ALL. (value is "forceShowAll")

See Also:

Constant Field Values

HTML

public static final String HTML

The Constant HTML. (value is "html")

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

The Constant IMAGE. (value is "image")

See Also:

Constant Field Values

IMAGE_POST_MODE

public static final String IMAGE_POST_MODE

The Constant IMAGE_POST_MODE. (value is "imagePostMode")

See Also:

Constant Field Values

KNOWLEDGE_GRAPH

public static final String KNOWLEDGE_GRAPH

The Constant KNOWLEDGE_GRAPH. (value is "knowledgeGraph")

See Also:

Constant Field Values

NOT_RAW

public static final String NOT_RAW

The Constant NOT_RAW. (value is "not-raw")

See Also:

Constant Field Values

RAW

public static final String RAW

The Constant RAW. (value is "raw")

See Also:

Constant Field Values

URL

public static final String URL

The Constant URL. (value is "url")

See Also:

Constant Field Values

Constructor Detail

AlchemyVision

public AlchemyVision()

Method Detail

getImageKeywords

public ImageKeywords getImageKeywords(File image,
                                      Boolean forceShowAll,
                                      Boolean knowledgeGraph)

Extracts keywords from an image

Parameters:

image - the image file

forceShowAll - Includes lower confidence tags

knowledgeGraph - Include knowledge graph information in the the results.

Returns:

ImageKeywords

getImageKeywords

public ImageKeywords getImageKeywords(URL url,
                                      Boolean forceShowAll,
                                      Boolean knowledgeGraph)

Extracts keywords from a URL.

Parameters:

url - the image URL

forceShowAll - Includes lower confidence tags

knowledgeGraph - Include knowledge graph information in the the results.

Returns:

ImageKeywords

getImageLink

public ImageLink getImageLink(URL url)

Extracts main image link from a URL.

Parameters:

url - the image URL

Returns:

ImageLink

getImageLink

public ImageLink getImageLink(String html)

Extracts the main image link from a HTML page.

Parameters:

html - the HTML

Returns:

ImageLink

recognizeFaces

public ImageFaces recognizeFaces(File image,
                                 Boolean knowledgeGraph)

Recognizes faces from an image.
For each face detected returns:

• Bounding box
• Gender
• Approximate age
• Name (if celebrity is detected)

Here is an example of how to recognize faces in an image:

 AlchemyVision service = new AlchemyVision();
 service.setApiKey("<api_key>");
 
 File image = new File("obama.jpg");
 ImageFaces faces = service.recognizeFaces(image, true);
 
 System.out.println(faces);
 

Parameters:

image - the image

knowledgeGraph - provide extra metadata for detected celebrities

Returns:

ImageFaces

recognizeFaces

public ImageFaces recognizeFaces(URL url,
                                 Boolean knowledgeGraph)

Recognizes faces from a URL.
For each face detected returns:

• Bounding box
• Gender
• Approximate age
• Name (if celebrity is detected)

Here is an example of how to recognize faces in an image:

 AlchemyVision service = new AlchemyVision();
 service.setApiKey("<api_key>");
 
 URL image = new URL("http://foo.com/the-image.png");
 ImageFaces faces = service.recognizeFaces(image, true);
 
 System.out.println(faces);
 

Parameters:

url - the image URL

knowledgeGraph - provide extra metadata for detected celebrities

Returns:

ImageFaces