com.ibm.watson.developer_cloud.natural_language_classifier.v1

Class NaturalLanguageClassifier

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.natural_language_classifier.v1.NaturalLanguageClassifier

public class NaturalLanguageClassifier
extends WatsonService

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.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
NaturalLanguageClassifier() Instantiates a new `NaturalLanguageClassifier`.
NaturalLanguageClassifier(IamOptions iamOptions) Instantiates a new `NaturalLanguageClassifier` with IAM.
NaturalLanguageClassifier(java.lang.String username, java.lang.String password) Instantiates a new `NaturalLanguageClassifier` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<Classification>	classify(ClassifyOptions classifyOptions) Classify a phrase.
ServiceCall<Classification>	classify(java.lang.String classifierId, java.lang.String text) Classify.
ServiceCall<ClassificationCollection>	classifyCollection(ClassifyCollectionOptions classifyCollectionOptions) Classify multiple phrases.
ServiceCall<Classifier>	createClassifier(CreateClassifierOptions createClassifierOptions) Create classifier.
ServiceCall<Classifier>	createClassifier(java.lang.String name, java.lang.String language, java.io.File trainingData) Create classifier.
ServiceCall<java.lang.Void>	deleteClassifier(DeleteClassifierOptions deleteClassifierOptions) Delete classifier.
ServiceCall<java.lang.Void>	deleteClassifier(java.lang.String classifierId) Delete classifier.
ServiceCall<Classifier>	getClassifier(GetClassifierOptions getClassifierOptions) Get information about a classifier.
ServiceCall<Classifier>	getClassifier(java.lang.String classifierId) Get information about a classifier.
ServiceCall<ClassifierList>	getClassifiers() List classifiers.
ServiceCall<ClassifierList>	listClassifiers() List classifiers.
ServiceCall<ClassifierList>	listClassifiers(ListClassifiersOptions listClassifiersOptions) List classifiers.

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

NaturalLanguageClassifier

public NaturalLanguageClassifier()

Instantiates a new `NaturalLanguageClassifier`.

NaturalLanguageClassifier

public NaturalLanguageClassifier(java.lang.String username,
                         java.lang.String password)

Instantiates a new `NaturalLanguageClassifier` with username and password.

Parameters:

username - the username

password - the password

NaturalLanguageClassifier

public NaturalLanguageClassifier(IamOptions iamOptions)

Instantiates a new `NaturalLanguageClassifier` 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:

iamOptions - the options for authenticating through IAM

Method Detail

classify

public 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 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 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

deleteClassifier

public 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

getClassifier

public 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

listClassifiers

public 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 ServiceCall<ClassifierList> listClassifiers()

List classifiers. Returns an empty array if no classifiers are available.

Returns:

a ServiceCall with a response type of ClassifierList

classify

public ServiceCall<Classification> classify(java.lang.String classifierId,
                                   java.lang.String text)

Classify. This method is here for backwards-compatibility with the other version of classify.

Parameters:

classifierId - the classifier ID

text - the submitted phrase to classify

Returns:

the classification of a phrase with a given classifier

createClassifier

public ServiceCall<Classifier> createClassifier(java.lang.String name,
                                       java.lang.String language,
                                       java.io.File trainingData)
                                         throws java.io.FileNotFoundException

Create classifier. This method is here for backwards-compatibility with the old version of createClassifier.

Parameters:

name - the classifier name

language - IETF primary language for the classifier. for example: 'en'

trainingData - the set of questions and their "keys" used to adapt a system to a domain (the ground truth)

Returns:

the classifier

Throws:

java.io.FileNotFoundException - if the file could not be found

deleteClassifier

public ServiceCall<java.lang.Void> deleteClassifier(java.lang.String classifierId)

Delete classifier. This method is here for backwards-compatibility with the old version of deleteClassifier.

Parameters:

classifierId - the classifier ID

Returns:

the service call

getClassifier

public ServiceCall<Classifier> getClassifier(java.lang.String classifierId)

Get information about a classifier. This method is here for backwards-compatibility with the old version of getClassifier.

Parameters:

classifierId - the classifier ID

Returns:

the classifier

getClassifiers

public ServiceCall<ClassifierList> getClassifiers()

List classifiers. This method is here for backwards-compatibility with the old version of getClassifiers, which has been renamed to listClassifiers.

Returns:

the classifier list