carrot2

node-carrot2 - Carrot2 DCS implementation for Node.js

This library requires the Carrot2 Document Clustering Server. Carrot2 is an open source clustering engine available at http://project.carrot2.org/index.html. Installation instructions and configuration can be found at http://project.carrot2.org/documentation.html.

Install the package:

npm install carrot2

General Use

For a more comprehensive example, refer to examples/test.js.

Include the package:

var carrot2 = require('carrot2');

Create an instance of the DCS interface:

var dcs = new carrot2.DocumentClusteringServer();

Create a search result object and populate it with documents (containing a title, url, and snippet):

var sr = new carrot2.SearchResult();
sr.addDocument("Title", "http://www.site.com/", "This is a snippet.");

To cluster a search result, pass that object:

dcs.cluster(sr, {algorithm:'lingo'}, [ 
        {key:"LingoClusteringAlgorithm.desiredClusterCountBase", value:10},
        {key:"LingoClusteringAlgorithm.phraseLabelBoost", value:1.0}
], function(err, sr) {
    if (err) console.log(err);
    var cluster = sr.clusters;
});

Alternatively, you can call roll:

dcs.externalCall('my query', {algorithm:'stc'}, [ 
        {key:"LingoClusteringAlgorithm.desiredClusterCountBase", value:10},
        {key:"LingoClusteringAlgorithm.phraseLabelBoost", value:1.0}
], function(err, sr) {
    if (err) console.log(err);
	var cluster = sr.clusters;
});

Configuration

Talk about the configuration with

code examples

License

See the file