Merge pull request #57 from cp2boston/RCB-464_text-embedding

Rcb 464 text embedding

Author: hgaudet

examples/entities.js

@@ -13,13 +13,14 @@ var args = parser.parseArgs();
 
 var api = new Api(args.key, args.url);
 var endpoint = "entities";
+var entities_text_data = "Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS";
 
-api.parameters.content = "Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS";
+api.parameters.content = entities_text_data;
 api.parameters.genre = "social-media";
 api.rosette(endpoint, function(err, res){
 	if(err){
 		console.log(err);
 	} else {
 		console.log(JSON.stringify(res, null, 2));
 	}
-});
+});

examples/entities_linked.js

@@ -12,8 +12,9 @@ parser.addArgument(["--url"], {help: "Rosette API alt-url", required: false});
 var args = parser.parseArgs();
 var api = new Api(args.key, args.url);
 var endpoint  = "entities";
+var entities_linked_text_data = "Last month director Paul Feig announced the movie will have an all-star female cast including Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.";
 
-api.parameters.content = "Last month director Paul Feig announced the movie will have an all-star female cast including Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.";
+api.parameters.content = entities_linked_text_data;
 // this parameter is deprecated
 api.parameters.linked = true;
 api.parameters.genre = "social-media";

examples/language.js

@@ -17,9 +17,9 @@ appHeader[0] = "X-RosetteAPI-App"
 appHeader[1] = "app";
 api.parameters.customHeaders = [appHeader];
 
-var content = "Por favor Señorita, says the man.";
+var language_data = "Por favor Señorita, says the man.";
 
-api.parameters.content = content;
+api.parameters.content = language_data;
 var appHeader = [];
 appHeader[0] = "X-RosetteAPI-App"
 appHeader[1] = "app";

examples/name_similarity.js

@@ -13,16 +13,16 @@ var args = parser.parseArgs();
 var api = new Api(args.key, args.url);
 var endpoint = "nameSimilarity";
 
-var name_similarity_data1 = "Michael Jackson";
-var name_similarity_data2 = "迈克尔·杰克逊";
+var matched_name_data1 = "Michael Jackson";
+var matched_name_data2 = "迈克尔·杰克逊";
 
-api.parameters.name1 = {"text": name_similarity_data1, "language": "eng", "entityType": "PERSON"};
-api.parameters.name2 = {"text": name_similarity_data2, "entityType": "PERSON"};
+api.parameters.name1 = {"text": matched_name_data1, "language": "eng", "entityType": "PERSON"};
+api.parameters.name2 = {"text": matched_name_data2, "entityType": "PERSON"};
 
 api.rosette(endpoint, function(err, res){
 	if(err){
 		console.log(err);
 	} else {
 		console.log(JSON.stringify(res, null, 2));
 	}
-});
+});

examples/name_translation.js

@@ -13,8 +13,8 @@ var args = parser.parseArgs();
 var api = new Api(args.key, args.url);
 var endpoint = "nameTranslation";
 
-var name_translation_data = "معمر محمد أبو منيار القذاف";
-api.parameters.name = name_translation_data;
+var translated_name_data = "معمر محمد أبو منيار القذاف";
+api.parameters.name = translated_name_data;
 api.parameters.entityType = "PERSON";
 api.parameters.targetLanguage = "eng";
 api.parameters.targetScript = "Latn";

examples/text_embedding.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var Api = require("../lib/Api");
+var ArgumentParser = require("argparse").ArgumentParser;
+
+var parser = new ArgumentParser({
+  addHelp: true,
+  description: "Get the text embedding from a piece of text"
+});
+parser.addArgument(["--key"], {help: "Rosette API key", required: true});
+parser.addArgument(["--url"], {help: "Rosette API alt-url", required: false});
+var args = parser.parseArgs();
+
+var api = new Api(args.key, args.url);
+var endpoint = "textEmbedding";
+var embeddings_data = 'Cambridge, Massachusetts'
+
+api.parameters.content = embeddings_data;
+api.rosette(endpoint, function(err, res){
+	if(err){
+		console.log(err);
+	} else {
+		console.log(JSON.stringify(res, null, 2));
+	}
+});

lib/Api.js

@@ -21,18 +21,19 @@ var rosetteConstants = require("./rosetteConstants");
 var RosetteException = require("./rosetteExceptions");
 var paramObj = require("./parameters");
 
-var relationships = require("./relationships");
-var matchedName = require("./nameSimilarity");
-var translatedName = require("./nameTranslation");
-var sentiment = require("./sentiment");
 var categories = require("./categories");
 var entities = require("./entities");
-var morphology = require("./morphology");
-var tokens = require("./tokens");
-var sentences = require("./sentences");
+var info = require("./info");
 var language = require("./language");
+var matchedName = require("./nameSimilarity");
+var morphology = require("./morphology");
 var ping = require("./ping");
-var info = require("./info");
+var relationships = require("./relationships");
+var sentences = require("./sentences");
+var sentiment = require("./sentiment");
+var textEmbedding = require("./textEmbedding");
+var translatedName = require("./nameTranslation");
+var tokens = require("./tokens");
 
 /**
  * @class

lib/textEmbedding.js

@@ -0,0 +1,60 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and limitations under the License.
+ **/
+"use strict";
+
+var URL = require("url");
+
+var rosetteConstants = require("./rosetteConstants");
+var RosetteException = require("./rosetteExceptions");
+var rosetteRequest = require("./rosetteRequest");
+
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function textEmbedding() {
+
+};
+
+/**
+ * Makes an HTTP request to the specified Rosette API endpoint and returns the result
+ * @param {string} parameters - The Rosette API endpoint parameters
+ * @param {string} userKey - The Rosette API user access key
+ * @param {string} serviceURL - The base service URL to be used to access the Rosette API
+ * @param {function} callback - Callback function to be exectuted after the function to which it is passed is complete
+ */
+textEmbedding.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, protocol, serviceURL, "text-embedding", callback);
+    } else {
+
+    // validate parameters
+        if (parameters.loadParams().content == null && parameters.loadParams().contentUri == null) {
+            return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
+        } else if (parameters.loadParams().content != null && parameters.loadParams().contentUri != null) {
+            return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "text-embedding");
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+        }
+    }
+
+};
+
+module.exports = textEmbedding;

tests/unittests.js

@@ -615,6 +615,60 @@ describe("Sentences Endpoint", function() {
 
 });
 
+describe("Text Embedding Endpoint", function() {
+    beforeEach(function(done) {
+        var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});
+
+        nock('https://api.rosette.com', {"encodedQueryParams": true })
+           .post('/rest/v1/text-embedding')
+           .query({"clientVersion": "1.1"})
+           .reply(200, JSON.parse(mockResponse));
+        done();
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+    
+    it("successfully calls the textEmbedding endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Some Content";
+
+        api.rosette("textEmbedding", function(err, res) {
+            chai.expect(err).to.be.null;
+            chai.expect(res.name).to.equal('Rosette API');
+            done();
+        });
+
+    });
+
+    it("detects content and contentUri are defined", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Sample Content";
+        api.parameters.contentUri = "http://some.url.com";
+
+        api.rosette("textEmbedding", function(err, res) {
+            chai.expect(err).to.not.be.null;
+            chai.expect(err.name).to.equal('RosetteException');
+            chai.expect(err.message).to.contain('badArgument');
+            done();
+        });
+    });
+
+    it("detects neither content nor contentUri are defined", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+
+        api.rosette("textEmbedding", function(err, res) {
+            chai.expect(err).to.not.be.null;
+            chai.expect(err.name).to.equal('RosetteException');
+            chai.expect(err.message).to.contain('badArgument');
+            done();
+        });
+    });
+
+});
+
 describe("Info Endpoint", function() {
     beforeEach(function(done) {
         var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});