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](https://cloud.ibm.com/docs/services/natural-language-understanding/customizing .html) with Watson Knowledge Studio 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, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, 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.
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

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, 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 or after receiving a 401 error from the service. 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. Analyzes text, HTML, or a public webpage for the following features: - Categories - Concepts - Emotion - Entities - Keywords - Metadata - Relations - Semantic roles - Sentiment.

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 Watson Knowledge Studio [custom models](https://cloud.ibm .com/docs/services/natural-language-understanding/customizing.html) that are deployed 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 Watson Knowledge Studio [custom models](https://cloud.ibm .com/docs/services/natural-language-understanding/customizing.html) that are deployed to your Natural Language Understanding service.

Returns:

a ServiceCall with a response type of ListModelsResults