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

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	Either content or contentUri required
contentUri	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	Either content or contentUri required
language	categories, entities, language, morphology, relationships, sentences, sentiment, tokens, name similarity	No
documentFile	categories, entities, language, morphology, relationships, sentences, sentiment, tokens	No
name1	name similarity	Yes
name2	name similarity	Yes
name	name translation	Yes
targetLanguage	name translation	Yes
entityType	name translation	No
sourceLanguageOfOrigin	name translation	No
sourceLanguageOfUse	name translation	No
sourceScript	name translation	No
targetScript	name translation	No
targetScheme	name translation	No
options	relationships	No
accuracyMode	relationships	Yes
linkEntities	entities	No
explain	sentiment	No
morphology	morphology	Yes

Additional Examples

See examples.

Additional Information

See Rosette API site