com.ibm.watson.natural_language_understanding.v1

Class NaturalLanguageUnderstanding

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.natural_language_understanding.v1.NaturalLanguageUnderstanding

public class NaturalLanguageUnderstanding
extends com.ibm.cloud.sdk.core.service.BaseService

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/natural-language-understanding?topic=natural-language-understanding-customizing) 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.cloud.sdk.core.service.BaseService

JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
NaturalLanguageUnderstanding(java.lang.String versionDate) Constructs a new `NaturalLanguageUnderstanding` client using the DEFAULT_SERVICE_NAME.
NaturalLanguageUnderstanding(java.lang.String versionDate, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `NaturalLanguageUnderstanding` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
NaturalLanguageUnderstanding(java.lang.String versionDate, java.lang.String serviceName) Constructs a new `NaturalLanguageUnderstanding` client with the specified serviceName.
NaturalLanguageUnderstanding(java.lang.String versionDate, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `NaturalLanguageUnderstanding` client with the specified Authenticator and serviceName.

Method Summary

Methods

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<AnalysisResults>	analyze(AnalyzeOptions analyzeOptions) Analyze text.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults>	deleteModel(DeleteModelOptions deleteModelOptions) Delete model.
com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults>	listModels() List models.
com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults>	listModels(ListModelsOptions listModelsOptions) List models.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureHttpClient, configureService, createServiceCall, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, 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)

Constructs a new `NaturalLanguageUnderstanding` client using the DEFAULT_SERVICE_NAME.

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,
                            com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `NaturalLanguageUnderstanding` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.

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.

authenticator - the Authenticator instance to be configured for this service

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(java.lang.String versionDate,
                            java.lang.String serviceName)

Constructs a new `NaturalLanguageUnderstanding` client with the specified serviceName.

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.

serviceName - The name of the service to configure.

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(java.lang.String versionDate,
                            java.lang.String serviceName,
                            com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs a new `NaturalLanguageUnderstanding` client with the specified Authenticator and serviceName.

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.

serviceName - The name of the service to configure.

authenticator - the Authenticator instance to be configured for this service

Method Detail

analyze

public com.ibm.cloud.sdk.core.http.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 - Syntax.

If a language for the input text is not specified with the `language` parameter, the service [automatically detects the language](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-detectable-languages).

Parameters:

analyzeOptions - the AnalyzeOptions containing the options for the call

Returns:

a ServiceCall with a response type of AnalysisResults

listModels

public com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults> listModels(ListModelsOptions listModelsOptions)

List models.

Lists Watson Knowledge Studio [custom entities and relations models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) 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 com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults> listModels()

List models.

Lists Watson Knowledge Studio [custom entities and relations models](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) that are deployed to your Natural Language Understanding service.

Returns:

a ServiceCall with a response type of ListModelsResults

deleteModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults> 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 DeleteModelResults