com.ibm.watson.natural_language_classifier.v1

Class NaturalLanguageClassifier

java.lang.Object

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

com.ibm.watson.natural_language_classifier.v1.NaturalLanguageClassifier

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

IBM Watson™ Natural Language Classifier uses machine learning algorithms to return the top matching predefined classes for short text input. You create and train a classifier to connect predefined classes to example texts so that the service can apply those classes to new inputs.

See Also:

Natural Language Classifier

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
NaturalLanguageClassifier() Constructs a new `NaturalLanguageClassifier` client using the DEFAULT_SERVICE_NAME.
NaturalLanguageClassifier(com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `NaturalLanguageClassifier` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
NaturalLanguageClassifier(java.lang.String serviceName) Constructs a new `NaturalLanguageClassifier` client with the specified serviceName.
NaturalLanguageClassifier(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs a new `NaturalLanguageClassifier` client with the specified Authenticator and serviceName.

Method Summary

Methods

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<Classification>	classify(ClassifyOptions classifyOptions) Classify a phrase.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationCollection>	classifyCollection(ClassifyCollectionOptions classifyCollectionOptions) Classify multiple phrases.
com.ibm.cloud.sdk.core.http.ServiceCall<Classifier>	createClassifier(CreateClassifierOptions createClassifierOptions) Create classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>	deleteClassifier(DeleteClassifierOptions deleteClassifierOptions) Delete classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<Classifier>	getClassifier(GetClassifierOptions getClassifierOptions) Get information about a classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassifierList>	listClassifiers() List classifiers.
com.ibm.cloud.sdk.core.http.ServiceCall<ClassifierList>	listClassifiers(ListClassifiersOptions listClassifiersOptions) List classifiers.

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

NaturalLanguageClassifier

public NaturalLanguageClassifier()

Constructs a new `NaturalLanguageClassifier` client using the DEFAULT_SERVICE_NAME.

NaturalLanguageClassifier

public NaturalLanguageClassifier(com.ibm.cloud.sdk.core.security.Authenticator authenticator)

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

Parameters:

authenticator - the Authenticator instance to be configured for this service

NaturalLanguageClassifier

public NaturalLanguageClassifier(java.lang.String serviceName)

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

Parameters:

serviceName - The name of the service to configure.

NaturalLanguageClassifier

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

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

Parameters:

serviceName - The name of the service to configure.

authenticator - the Authenticator instance to be configured for this service

Method Detail

classify

public com.ibm.cloud.sdk.core.http.ServiceCall<Classification> classify(ClassifyOptions classifyOptions)

Classify a phrase.

Returns label information for the input. The status must be `Available` before you can use the classifier to classify text.

Parameters:

classifyOptions - the ClassifyOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classification

classifyCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassificationCollection> classifyCollection(ClassifyCollectionOptions classifyCollectionOptions)

Classify multiple phrases.

Returns label information for multiple phrases. The status must be `Available` before you can use the classifier to classify text.

Note that classifying Japanese texts is a beta feature.

Parameters:

classifyCollectionOptions - the ClassifyCollectionOptions containing the options for the call

Returns:

a ServiceCall with a response type of ClassificationCollection

createClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<Classifier> createClassifier(CreateClassifierOptions createClassifierOptions)

Create classifier.

Sends data to create and train a classifier and returns information about the new classifier.

Parameters:

createClassifierOptions - the CreateClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifier

listClassifiers

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassifierList> listClassifiers(ListClassifiersOptions listClassifiersOptions)

List classifiers.

Returns an empty array if no classifiers are available.

Parameters:

listClassifiersOptions - the ListClassifiersOptions containing the options for the call

Returns:

a ServiceCall with a response type of ClassifierList

listClassifiers

public com.ibm.cloud.sdk.core.http.ServiceCall<ClassifierList> listClassifiers()

List classifiers.

Returns an empty array if no classifiers are available.

Returns:

a ServiceCall with a response type of ClassifierList

getClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<Classifier> getClassifier(GetClassifierOptions getClassifierOptions)

Get information about a classifier.

Returns status and other information about a classifier.

Parameters:

getClassifierOptions - the GetClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Classifier

deleteClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteClassifier(DeleteClassifierOptions deleteClassifierOptions)

Delete classifier.

Parameters:

deleteClassifierOptions - the DeleteClassifierOptions containing the options for the call

Returns:

a ServiceCall with a response type of Void