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

The IBM Watson Natural Language Classifier service applies deep learning techniques to make predictions about the best predefined classes for short sentences or phrases. The classes can trigger a corresponding action in an application, such as directing a request to a location or person, or answering a question. After training, the service returns information for texts that it hasn't seen before. The response includes the name of the top classes and confidence values.

Version:

v1

See Also:

Natural Language Classifier

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
NaturalLanguageClassifier() Instantiates a new Natural Language Classifier service.
NaturalLanguageClassifier(String username, String password) Instantiates a new natural language service by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<Classification>	classify(String classifierId, String text) Returns classification information for a classifier on a phrase.
ServiceCall<Classifier>	createClassifier(String name, String language, File trainingData) Sends data to create and train a classifier, and returns information about the new classifier.
ServiceCall<Void>	deleteClassifier(String classifierId) Deletes a classifier.
ServiceCall<Classifier>	getClassifier(String classifierId) Retrieves a classifier.
ServiceCall<Classifiers>	getClassifiers() Retrieves the list of classifiers for the user.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, 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 Natural Language Classifier service.

NaturalLanguageClassifier

public NaturalLanguageClassifier(String username,
                                 String password)

Instantiates a new natural language service by username and password.

Parameters:

username - the username

password - the password

Method Detail

classify

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

Returns classification information for a classifier on a phrase.

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(String name,
                                                String language,
                                                File trainingData)

Sends data to create and train a classifier, and returns information about the new classifier. The status has the value of `Training` when the operation is successful, and might remain at this status for a while.

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

See Also:

Classifier

deleteClassifier

public ServiceCall<Void> deleteClassifier(String classifierId)

Deletes a classifier.

Parameters:

classifierId - the classifier ID

Returns:

the service call

See Also:

Classifier

getClassifier

public ServiceCall<Classifier> getClassifier(String classifierId)

Retrieves a classifier.

Parameters:

classifierId - the classifier ID

Returns:

the classifier list

See Also:

Classifier

getClassifiers

public ServiceCall<Classifiers> getClassifiers()

Retrieves the list of classifiers for the user.

Returns:

the classifier list

See Also:

Classifier