Watson Developer Cloud Unity SDK  1.0.0
The Unity SDK uses the Watson Developer Cloud services, a collection of REST APIs and SDKs that use cognitive computing to solve complex problems.
IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier Class Reference

This class wraps the Natural Language Classifier service. Natural Language Classifier Service More...

Inheritance diagram for IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier:
IBM.Watson.DeveloperCloud.Services.IWatsonService

Public Member Functions

delegate void OnGetClassifier (Classifier classifier, string customData)
 Callback used by the GetClassifier() method. More...
 
delegate void OnTrainClassifier (Classifier classifier, string customData)
 Callback used by the TrainClassifier() method. More...
 
delegate void OnFindClassifier (Classifier classifier, string customData)
 Callback used by FindClassifier(). More...
 
delegate void OnGetClassifiers (Classifiers classifiers, string customData)
 The callback used by the GetClassifiers() method. More...
 
delegate void OnClassify (ClassifyResult classify, string customData)
 This callback is used by the Classify() method. More...
 
delegate void OnDeleteClassifier (bool success, string customData)
 This callback is used by the DeleteClassifier() method. More...
 
 NaturalLanguageClassifier (Credentials credentials)
 
bool GetClassifiers (OnGetClassifiers callback)
 Returns an array of all classifiers to the callback function. More...
 
bool GetClassifier (string classifierId, OnGetClassifier callback)
 Returns a specific classifer. More...
 
bool TrainClassifier (string classifierName, string language, string trainingData, OnTrainClassifier callback)
 Train a new classifier. More...
 
bool DeleteClassifer (string classifierId, OnDeleteClassifier callback)
 Deletes the specified classifier. More...
 
bool Classify (string classifierId, string text, OnClassify callback)
 Classifies the given text, invokes the callback with the results. More...
 
string GetServiceID ()
 <exclude> More...
 

Properties

string Url [get, set]
 Gets and sets the endpoint URL for the service. More...
 
Credentials Credentials [get, set]
 Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined. More...
 

Detailed Description

This class wraps the Natural Language Classifier service. Natural Language Classifier Service

Constructor & Destructor Documentation

IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.NaturalLanguageClassifier ( Credentials  credentials)
inline

Member Function Documentation

bool IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.Classify ( string  classifierId,
string  text,
OnClassify  callback 
)
inline

Classifies the given text, invokes the callback with the results.

Parameters
classifierIdThe ID of the classifier to use.
textThe text to classify.
callbackThe callback to invoke with the results.
Returns
Returns false if we failed to submit the request.
bool IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.DeleteClassifer ( string  classifierId,
OnDeleteClassifier  callback 
)
inline

Deletes the specified classifier.

Parameters
classifierIdThe ID of the classifier.
callbackThe callback to invoke with the results.
Returns
Returns false if we failed to submit a request.
bool IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.GetClassifier ( string  classifierId,
OnGetClassifier  callback 
)
inline

Returns a specific classifer.

Parameters
classifierIdThe ID of the classifier to get.
callbackThe callback to invoke with the Classifier object.
Returns
Returns true if the request is submitted.
bool IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.GetClassifiers ( OnGetClassifiers  callback)
inline

Returns an array of all classifiers to the callback function.

Parameters
callbackThe callback to invoke with the Classifiers object.
Returns
Returns true if the request is submitted.
string IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.GetServiceID ( )
inline
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnClassify ( ClassifyResult  classify,
string  customData 
)

This callback is used by the Classify() method.

Parameters
classify
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnDeleteClassifier ( bool  success,
string  customData 
)

This callback is used by the DeleteClassifier() method.

Parameters
success
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnFindClassifier ( Classifier  classifier,
string  customData 
)

Callback used by FindClassifier().

Parameters
classifierThe classifer found by name.
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnGetClassifier ( Classifier  classifier,
string  customData 
)

Callback used by the GetClassifier() method.

Parameters
classifierThe classifier found by ID.
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnGetClassifiers ( Classifiers  classifiers,
string  customData 
)

The callback used by the GetClassifiers() method.

Parameters
classifiers
delegate void IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.OnTrainClassifier ( Classifier  classifier,
string  customData 
)

Callback used by the TrainClassifier() method.

Parameters
classifierThe classifier created.
bool IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.TrainClassifier ( string  classifierName,
string  language,
string  trainingData,
OnTrainClassifier  callback 
)
inline

Train a new classifier.

Parameters
classifierNameA name to give the classifier.
languageLanguage of the classifier.
trainingDataCSV training data.
callbackCallback to invoke with the results.
Returns
Returns true if training data was submitted correctly.

Property Documentation

Credentials IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.Credentials
getset

Gets and sets the credentials of the service. Replace the default endpoint if endpoint is defined.

string IBM.Watson.DeveloperCloud.Services.NaturalLanguageClassifier.v1.NaturalLanguageClassifier.Url
getset

Gets and sets the endpoint URL for the service.


The documentation for this class was generated from the following file: