Package Exports

rosette-api

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (rosette-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

rosette-api

This is the Rosette API client binding for node.js.

Getting Started

Install the module with: npm install rosette-api

If the version you are using is not the latest from npm (or npm show rosette-api@* version), please check for its compatibilty with api.rosette.com. If you have an on-premise version of Rosette API server, please contact support for binding compatibility with your installation.

To check your installed version:

npm list rosette-api for local installation
npm list -g rosette-api for global installation

https://www.npmjs.com/package/rosette-api

Docker

A Docker image for running the examples against the compiled source library is available on Docker Hub.

Command: docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-nodejs

Additional environment settings: -e ALT_URL=<alternative URL> -e FILENAME=<single filename>

Example using the Rosette API language detection endpoint

var Api = require('rosette-api');

var api = new Api(API_KEY);
var endpoint = "language";
var content = "Por favor Señorita, says the man.";
api.parameters.content = content;

api.rosette(endpoint, function(err, res){
    if(err){
        console.log(err);
    } else {
        console.log(JSON.stringify(res, null, 2));
    }
});

API Parameters

Parameter	Endpoint	Required
content	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, transliteration	Either content or contentUri required, transliteration requires content only
contentUri	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics	Either content or contentUri required
language	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics, name similarity	No
documentFile	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, topics	No
name1	name similarity	Yes
name2	name similarity	Yes
name	name translation	Yes
names	name deduplication	Yes
targetLanguage	name translation, transliteration (No)	Yes
entityType	name translation	No
sourceLanguageOfOrigin	name translation	No
sourceLanguageOfUse	name translation	No
sourceLanguage	transliteration	No
sourceScript	name translation, transliteration	No
targetScript	name translation, transliteration	No
targetScheme	name translation	No
options	relationships	No
accuracyMode	relationships	Yes
explain	sentiment	No
morphology	morphology	Yes

Additional Examples

See examples.

API Documentation

See documentation

Release Notes

See wiki

Additional Information

See Rosette API site