Skip to content

Latest commit

 

History

History
 
 

README.md

Natural Language Classifier

Use Natural Language Classifier service to create a classifier instance by providing a set of representative strings and a set of one or more correct classes for each as training. Then use the trained classifier to classify your new question for best matching answers or to retrieve next actions for your application.

Usage

Classify intents in natural language.

Instantiating and authenticating the service

Before you can send requests to the service it must be instantiated and credentials must be set.

using IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v2;
using IBM.Watson.DeveloperCloud.Utilities;

void Start()
{
    Credentials credentials = new Credentials(<username>, <password>, <url>);
    NaturalLanguageClassifier _naturalLanguageClassifier = new NaturalLanguageClassifier(credentials);
}

Fail handler

These examples use a common fail handler.

private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
{
    Log.Error("ExampleNaturalLanguageClassifier.OnFail()", "Error received: {0}", error.ToString());
}

Listing Classifiers

Returns an empty array if no classifiers are available.

private void GetClassifiers()
{
  if (!naturalLanguageClassifier.GetClassifiers(OnGetClassifiers, OnFail))
    Log.Debug("ExampleNaturalLanguageClassifier.GetClassifiers()", "Failed to get classifiers!");
}

private void OnGetClassifiers(Classifiers classifiers, Dictionary<string, object> customData)
{
  Log.Debug("ExampleNaturalLanguageClassifier.OnGetClassifiers()", "Natural Language Classifier - GetClassifiers  Response: {0}", customData["json"].ToString());
}

Classifying Text

The status must be Available before you can use the classifier to classify calls. Use GET /classifiers/{classifier_id} to retrieve the status.

private void Classify()
{
  if (!naturalLanguageClassifier.Classify(OnClassify, OnFail, <classifier-id>, <input>))
    Log.Debug("ExampleNaturalLanguageClassifier.Classify()", "Failed to classify!");
}

private void OnClassify(ClassifyResult result, Dictionary<string, object> customData)
{
    Log.Debug("ExampleNaturalLanguageClassifier.OnClassify()", "Natural Language Classifier - Classify Response: {0}", customData["json"].ToString());
}

Training A New Classifier

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

private void TrainClassifier()
{
  if (!naturalLanguageClassifier.TrainClassifier(<classifier-name>, <classifier-language>, <training-data>, OnTrainClassifier))
    Log.Debug("ExampleNaturalLanguageClassifier.TrainClassifier()", "Failed to train clasifier!");
}

private void OnTrainClassifier(Classifier classifier, Dictionary<string, object> customData)
{
    Log.Debug("ExampleNaturalLanguageClassifier.OnTrainClassifier()", "Natural Language Classifier - Train Classifier: {0}", customData["json"].ToString());
}

Getting Information About A Classifier

Returns status and other information about a classifier

private void GetClassifier()
{
  if (!naturalLanguageClassifier.GetClassifier(<classifier-id>, OnGetClassifier))
    Log.Debug("ExampleNaturalLanguageClassifier.GetClassifier()", "Failed to get classifier {0}!", classifierId);
}

private void OnGetClassifier(Classifier classifier, Dictionary<string, object> customData)
{
    Log.Debug("ExampleNaturalLanguageClassifier.OnGetClassifier()", "Natural Language Classifier - Get Classifier {0}: {1}", classifier.classifier_id, data);
}

Deleting A Classifier

Deletes a classifier

private void DeleteClassifier()
{
  if (!naturalLanguageClassifier.DeleteClassifer(<classifier-id>, OnDeleteTrainedClassifier))
    Log.Debug("ExampleNaturalLanguageClassifier.DeleteClassifier()", "Failed to delete clasifier {0}!", <classifier-id>);
}

private void OnDeleteTrainedClassifier(bool success, Dictionary<string, object> customData)
{
    Log.Debug("ExampleNaturalLanguageClassifier.OnDeleteTrainedClassifier()", "Natural Language Classifier - Delete Trained Classifier {0} | success: {1} {2}", <classifier-id>, success, data);
}