com.ibm.watson.developer_cloud.natural_language_understanding.v1

Class NaturalLanguageUnderstanding

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.natural_language_understanding.v1.NaturalLanguageUnderstanding

public class NaturalLanguageUnderstanding
extends WatsonService

Analyze various features of text content at scale. Provide text, raw HTML, or a public URL, and IBM Watson Natural Language Understanding will give you results for the features you request. The service cleans HTML content before analysis by default, so the results can ignore most advertisements and other unwanted content. You can create custom models with Watson Knowledge Studio that can be used to detect custom entities and relations in Natural Language Understanding.

See Also:

Natural Language Understanding

Field Summary

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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
NaturalLanguageUnderstanding(java.lang.String versionDate) Instantiates a new `NaturalLanguageUnderstanding`.
NaturalLanguageUnderstanding(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `NaturalLanguageUnderstanding` with IAM.
NaturalLanguageUnderstanding(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `NaturalLanguageUnderstanding` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<AnalysisResults>	analyze(AnalyzeOptions analyzeOptions) Analyze text, HTML, or a public webpage.
ServiceCall<java.lang.Void>	deleteModel(DeleteModelOptions deleteModelOptions) Delete model.
ServiceCall<ListModelsResults>	listModels() List models.
ServiceCall<ListModelsResults>	listModels(ListModelsOptions listModelsOptions) List models.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(java.lang.String versionDate)

Instantiates a new `NaturalLanguageUnderstanding`.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(java.lang.String versionDate,
                            java.lang.String username,
                            java.lang.String password)

Instantiates a new `NaturalLanguageUnderstanding` with username and password.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

username - the username

password - the password

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(java.lang.String versionDate,
                            IamOptions iamOptions)

Instantiates a new `NaturalLanguageUnderstanding` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires. Failing to do so will result in authentication errors after this token expires.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

iamOptions - the options for authenticating through IAM

Method Detail

analyze

public ServiceCall<AnalysisResults> analyze(AnalyzeOptions analyzeOptions)

Analyze text, HTML, or a public webpage. Analyzes text, HTML, or a public webpage with one or more text analysis features. ### Concepts Identify general concepts that are referenced or alluded to in your content. Concepts that are detected typically have an associated link to a DBpedia resource. ### Emotion Detect anger, disgust, fear, joy, or sadness that is conveyed by your content. Emotion information can be returned for detected entities, keywords, or user-specified target phrases found in the text. ### Entities Detect important people, places, geopolitical entities and other types of entities in your content. Entity detection recognizes consecutive coreferences of each entity. For example, analysis of the following text would count \"Barack Obama\" and \"He\" as the same entity: \"Barack Obama was the 44th President of the United States. He took office in January 2009.\" ### Keywords Determine the most important keywords in your content. Keyword phrases are organized by relevance in the results. ### Metadata Get author information, publication date, and the title of your text/HTML content. ### Relations Recognize when two entities are related, and identify the type of relation. For example, you can identify an \"awardedTo\" relation between an award and its recipient. ### Semantic Roles Parse sentences into subject-action-object form, and identify entities and keywords that are subjects or objects of an action. ### Sentiment Determine whether your content conveys postive or negative sentiment. Sentiment information can be returned for detected entities, keywords, or user-specified target phrases found in the text. ### Categories Categorize your content into a hierarchical 5-level taxonomy. For example, \"Leonardo DiCaprio won an Oscar\" returns \"/art and entertainment/movies and tv/movies\" as the most confident classification.

Parameters:

analyzeOptions - the AnalyzeOptions containing the options for the call

Returns:

a ServiceCall with a response type of AnalysisResults

deleteModel

public ServiceCall<java.lang.Void> deleteModel(DeleteModelOptions deleteModelOptions)

Delete model. Deletes a custom model.

Parameters:

deleteModelOptions - the DeleteModelOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void

listModels

public ServiceCall<ListModelsResults> listModels(ListModelsOptions listModelsOptions)

List models. Lists available models for Relations and Entities features, including Watson Knowledge Studio custom models that you have created and linked to your Natural Language Understanding service.

Parameters:

listModelsOptions - the ListModelsOptions containing the options for the call

Returns:

a ServiceCall with a response type of ListModelsResults

listModels

public ServiceCall<ListModelsResults> listModels()

List models. Lists available models for Relations and Entities features, including Watson Knowledge Studio custom models that you have created and linked to your Natural Language Understanding service.

Returns:

a ServiceCall with a response type of ListModelsResults