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.

IBM is sunsetting Watson Natural Language Understanding Custom Sentiment (BETA). From **June 3, 2023** onward, you will no longer be able to use the Custom Sentiment feature.<br /><br />To ensure we continue providing our clients with robust and powerful text classification capabilities, IBM recently announced the general availability of a new [single-label text classification capability](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-classifications). This new feature includes extended language support and training data customizations suited for building a custom sentiment classifier.<br /><br />If you would like more information or further guidance, please contact IBM Cloud Support.{: deprecated}.

API Version: 1.0 See: https://cloud.ibm.com/docs/natural-language-understanding

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME Default service name used when configuring the `NaturalLanguageUnderstanding` client.
static String	DEFAULT_SERVICE_URL Default service endpoint URL.

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

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
NaturalLanguageUnderstanding(String version) Constructs an instance of the `NaturalLanguageUnderstanding` client.
NaturalLanguageUnderstanding(String version, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `NaturalLanguageUnderstanding` client.
NaturalLanguageUnderstanding(String version, String serviceName) Constructs an instance of the `NaturalLanguageUnderstanding` client.
NaturalLanguageUnderstanding(String version, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `NaturalLanguageUnderstanding` client.

Method Summary

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<CategoriesModel>	createCategoriesModel(CreateCategoriesModelOptions createCategoriesModelOptions) Create categories model.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel>	createClassificationsModel(CreateClassificationsModelOptions createClassificationsModelOptions) Create classifications model.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults>	deleteCategoriesModel(DeleteCategoriesModelOptions deleteCategoriesModelOptions) Delete categories model.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults>	deleteClassificationsModel(DeleteClassificationsModelOptions deleteClassificationsModelOptions) Delete classifications model.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults>	deleteModel(DeleteModelOptions deleteModelOptions) Delete model.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel>	getCategoriesModel(GetCategoriesModelOptions getCategoriesModelOptions) Get categories model details.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel>	getClassificationsModel(GetClassificationsModelOptions getClassificationsModelOptions) Get classifications model details.
String	getVersion() Gets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModelList>	listCategoriesModels() List categories models.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModelList>	listCategoriesModels(ListCategoriesModelsOptions listCategoriesModelsOptions) List categories models.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModelList>	listClassificationsModels() List classifications models.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModelList>	listClassificationsModels(ListClassificationsModelsOptions listClassificationsModelsOptions) List classifications models.
com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults>	listModels() List models.
com.ibm.cloud.sdk.core.http.ServiceCall<ListModelsResults>	listModels(ListModelsOptions listModelsOptions) List models.
void	setVersion(String version) Sets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel>	updateCategoriesModel(UpdateCategoriesModelOptions updateCategoriesModelOptions) Update categories model.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel>	updateClassificationsModel(UpdateClassificationsModelOptions updateClassificationsModelOptions) Update classifications model.

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

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

Default service name used when configuring the `NaturalLanguageUnderstanding` client.

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

Default service endpoint URL.

See Also:

Constant Field Values

Constructor Detail

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(String version)

Constructs an instance of the `NaturalLanguageUnderstanding` client. The default service name is used to configure the client instance.

Parameters:

version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2022-04-07`.

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(String version,
                                    com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `NaturalLanguageUnderstanding` client. The default service name and specified authenticator are used to configure the client instance.

Parameters:

version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2022-04-07`.

authenticator - the Authenticator instance to be configured for this client

NaturalLanguageUnderstanding

public NaturalLanguageUnderstanding(String version,
                                    String serviceName)

Constructs an instance of the `NaturalLanguageUnderstanding` client. The specified service name is used to configure the client instance.

Parameters:

version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2022-04-07`.

serviceName - the service name to be used when configuring the client instance

NaturalLanguageUnderstanding

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

Constructs an instance of the `NaturalLanguageUnderstanding` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

version - Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2022-04-07`.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

getVersion

public String getVersion()

Gets the version.

Release date of the API version you want to use. Specify dates in YYYY-MM-DD format. The current version is `2022-04-07`.

Returns:

the version

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the new version

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 - Classifications - Concepts - Emotion - Entities - Keywords - Metadata - Relations - Semantic roles - Sentiment - Syntax - Summarization (Experimental)

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 result of type 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 result of type 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 result of type 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 result of type DeleteModelResults

createCategoriesModel

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel> createCategoriesModel(CreateCategoriesModelOptions createCategoriesModelOptions)

Create categories model.

(Beta) Creates a custom categories model by uploading training data and associated metadata. The model begins the training and deploying process and is ready to use when the `status` is `available`.

Parameters:

createCategoriesModelOptions - the CreateCategoriesModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModel

listCategoriesModels

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModelList> listCategoriesModels(ListCategoriesModelsOptions listCategoriesModelsOptions)

List categories models.

(Beta) Returns all custom categories models associated with this service instance.

Parameters:

listCategoriesModelsOptions - the ListCategoriesModelsOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModelList

listCategoriesModels

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModelList> listCategoriesModels()

List categories models.

(Beta) Returns all custom categories models associated with this service instance.

Returns:

a ServiceCall with a result of type CategoriesModelList

getCategoriesModel

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel> getCategoriesModel(GetCategoriesModelOptions getCategoriesModelOptions)

Get categories model details.

(Beta) Returns the status of the categories model with the given model ID.

Parameters:

getCategoriesModelOptions - the GetCategoriesModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModel

updateCategoriesModel

public com.ibm.cloud.sdk.core.http.ServiceCall<CategoriesModel> updateCategoriesModel(UpdateCategoriesModelOptions updateCategoriesModelOptions)

Update categories model.

(Beta) Overwrites the training data associated with this custom categories model and retrains the model. The new model replaces the current deployment.

Parameters:

updateCategoriesModelOptions - the UpdateCategoriesModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type CategoriesModel

deleteCategoriesModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults> deleteCategoriesModel(DeleteCategoriesModelOptions deleteCategoriesModelOptions)

Delete categories model.

(Beta) Un-deploys the custom categories model with the given model ID and deletes all associated customer data, including any training data or binary artifacts.

Parameters:

deleteCategoriesModelOptions - the DeleteCategoriesModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteModelResults

createClassificationsModel

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel> createClassificationsModel(CreateClassificationsModelOptions createClassificationsModelOptions)

Create classifications model.

Creates a custom classifications model by uploading training data and associated metadata. The model begins the training and deploying process and is ready to use when the `status` is `available`.

Parameters:

createClassificationsModelOptions - the CreateClassificationsModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type ClassificationsModel

listClassificationsModels

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModelList> listClassificationsModels(ListClassificationsModelsOptions listClassificationsModelsOptions)

List classifications models.

Returns all custom classifications models associated with this service instance.

Parameters:

listClassificationsModelsOptions - the ListClassificationsModelsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ClassificationsModelList

listClassificationsModels

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModelList> listClassificationsModels()

List classifications models.

Returns all custom classifications models associated with this service instance.

Returns:

a ServiceCall with a result of type ClassificationsModelList

getClassificationsModel

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel> getClassificationsModel(GetClassificationsModelOptions getClassificationsModelOptions)

Get classifications model details.

Returns the status of the classifications model with the given model ID.

Parameters:

getClassificationsModelOptions - the GetClassificationsModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type ClassificationsModel

updateClassificationsModel

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationsModel> updateClassificationsModel(UpdateClassificationsModelOptions updateClassificationsModelOptions)

Update classifications model.

Overwrites the training data associated with this custom classifications model and retrains the model. The new model replaces the current deployment.

Parameters:

updateClassificationsModelOptions - the UpdateClassificationsModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type ClassificationsModel

deleteClassificationsModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteModelResults> deleteClassificationsModel(DeleteClassificationsModelOptions deleteClassificationsModelOptions)

Delete classifications model.

Un-deploys the custom classifications model with the given model ID and deletes all associated customer data, including any training data or binary artifacts.

Parameters:

deleteClassificationsModelOptions - the DeleteClassificationsModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteModelResults