dca::TextClassificationResult Class Reference

#include <text_classification_result.h>

Detailed Description

Single result of a text classification.

Encapsulates a single result of a text classification

See also

TextClassification, HtmlTextClassifier, TextClassificationResults, HtmlText, CategoriesInfo

// assume we have a valid DcaInstance (myDca) and License (myLicense)
 
// initialize the Text Classification module
dca::TextClassification myTextClassification = 
        dca::TextClassification::create( myDca, myLicense );
 
// create an HTML Text Classifier
dca::HtmlTextClassifier myHtmlTextClassifier = 
        myTextClassification.createHtmlClassifier();
 
// create an HTML text object
// assume we have the contents of a valid HTML page in std::string 
// myHtmlTextContents
dca::HtmlText myHtmlText = 
        dca::HtmlText::create( myDca, myHtmlTextContents );
 
// declare the classification results
dca::TextClassificationResults myTextClassificationResults;
 
// run the classification
dca::FunctionResult myResult = 
        myHtmlTextClassifier.classify( myHtmlText, myTextClassificationResults );
 
// if myResult returns false an error occured
if( !myResult ) {
        cout << "Received error from Text Classification (Error code: " <<
                myResult.getReturnCode() << ", Description: " <<
                myResult.getDescription() << ")." << endl;
        return;
}
 
if( !myTextClassificationResults.isCategorized() ) {
        cout << "No categories found for given HTML data." << endl;
        return;
}
 
// we received results and simply want to print them out
const DCA_SIZE_TYPE count = myTextClassificationResults.size();
 
// iterate through all matched categories
for( DCA_INDEX_TYPE i = 0; i < count; ++i ) {
        const dca::TextClassificationResult myTCResult = 
                myTextClassificationResults[ i ];
                
        cout << "Got result #" << (i+1) << " category id:" <<
                myTCResult.id() << ", Score:" <<
                myTCResult.score() << endl;
}

Definition at line 27 of file text_classification_result.h.

Public Member Functions
double	score () const
	Returns the score of the classification (if any), range is from 0.0 to 1.0.
DCA_CATEGORY_ID_TYPE	id () const
	Returns the category id of the classification (if any).

---

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

• text_classification_result.h