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

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

See Also:

Natural Language Classifier

Constructor Summary

Constructors

Constructor and Description
NaturalLanguageClassifier() Instantiates a new Natural Language Classifier service.

Method Summary

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

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

execute, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getGson, getHttpClient, getThreadSafeClient, setApiKey, setEndPoint, setUsernameAndPassword

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.

Method Detail

createClassifier

public Classifier createClassifier(String language,
                                   List<TrainingData> 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:

language - IETF primary language for the classifier

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

classify

public 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

getClassifiers

public List<Classifier> getClassifiers()

Retrieves the list of classifiers for the user.

Returns:

the classifier list

See Also:

Classifier

deleteClassifier

public void deleteClassifier(String classifierId)

Deletes a classifier.

Parameters:

classifierId - the classifier ID

See Also:

Classifier

getClassifier

public Classifier getClassifier(String classifierId)

Retrieves a classifier.

Parameters:

classifierId - the classifier ID

Returns:

the classifier list

See Also:

Classifier

toString

public String toString()

Overrides:

toString in class WatsonService