RD-2427 related terms endpoint (#71)

* RD-2427 related terms endpoint

* RD-2427 relatedTerms -> similarTerms, support both textEmbeddings and semanticVectors

Author: iredpath

examples/text_embedding.js renamed to examples/semantic_vectors.js

@@ -0,0 +1,27 @@
+ "use strict";
+
+ var Api = require("../lib/Api");
+ var ArgumentParser = require("argparse").ArgumentParser;
+
+ var parser = new ArgumentParser({
+   addHelp: true,
+   description: "Get the terms similar to an input in other languages"
+ });
+ 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 = "similarTerms";
+ var data = "spy"
+ var options = {"resultLanguages": ["spa", "deu", "jpn"]}
+
+ api.parameters.content = data;
+ api.parameters.options = options;
+ api.rosette(endpoint, function(err, res){
+    if(err){
+        console.log(err);
+    } else {
+        console.log(JSON.stringify(res, null, 2));
+    }
+ });

examples/similar_terms.js

@@ -29,3 +29,7 @@ module.exports.tokens = require("./lib/tokens");
 module.exports.translatedName = require("./lib/nameTranslation");
 
 module.exports.syntax_dependencies = require("./lib/syntax_dependencies");
+
+module.exports.similarTerms = require("./lib/similarTerms");
+
+module.exports.semanticVectors = require("./lib/semanticVectors");

index.js

@@ -30,8 +30,10 @@ var morphology = require("./morphology");
 var nameDeduplication = require("./nameDeduplication");
 var ping = require("./ping");
 var relationships = require("./relationships");
+var semanticVectors = require("./semanticVectors");
 var sentences = require("./sentences");
 var sentiment = require("./sentiment");
+var similarTerms = require("./similarTerms");
 var syntax_dependencies = require("./syntax_dependencies");
 var textEmbedding = require("./textEmbedding");
 var tokens = require("./tokens");

lib/Api.js

@@ -0,0 +1,58 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2016-2018 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 2016-2018 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function semanticVectors() {
+
+};
+
+/**
+ * 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
+ */
+semanticVectors.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        parameters.loadFile(parameters.loadParams().documentFile, parameters, userKey, protocol, serviceURL, "semantics/vector", callback);
+    } else {
+        // validate parameters
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
+            return callback(new RosetteException("badArgument", "Must supply one of Content or ContentUri", "bad arguments"));
+        } else if (parameters.loadParams().content && parameters.loadParams().contentUri) {
+            return callback(new RosetteException("badArgument", "Cannot supply both Content and ContentUri", "bad arguments"));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "semantics/vector");
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+        }
+    }
+};
+
+module.exports = semanticVectors;

lib/semanticVectors.js

@@ -0,0 +1,58 @@
+/**
+ * Rosette API.
+ *
+ * @copyright 2018 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 2018 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
+function similarTerms() {
+
+};
+
+/**
+ * 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
+ */
+similarTerms.prototype.getResults = function(parameters, userKey, protocol, serviceURL, callback) {
+
+    if (parameters.documentFile != null) {
+        parameters.loadFile(parameters.documentFile, parameters, userKey, protocol, serviceURL, "semantics/similar", callback);
+    } else {
+        // validate parameters
+        if (!parameters.loadParams().content && !parameters.loadParams().contentUri) {
+            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 content and contentUri", "bad arguments"));
+        } else {
+            // configure URL
+            var urlParts = URL.parse(serviceURL + "semantics/similar");
+            var req = new rosetteRequest();
+            req.makeRequest('POST', userKey, protocol, urlParts, parameters, callback);
+        }
+    }
+};
+
+module.exports = similarTerms;

lib/similarTerms.js

@@ -18,6 +18,8 @@ var morphology = require("../lib/morphology");
 var tokens = require("../lib/tokens");
 var topics = require("../lib/topics");
 var sentences = require("../lib/sentences");
+var similarTerms = require("../lib/similarTerms");
+var semanticVectors = require("../lib/semanticVectors");
 var info = require("../lib/info");
 var ping = require("../lib/ping");
 var syntax_dependencies = require("../lib/syntax_dependencies");
@@ -686,12 +688,65 @@ describe("Sentences Endpoint", function() {
     });
 });
 
-describe("Text Embedding Endpoint", function() {
+describe("Similar Terms 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')
+           .post('/rest/v1/semantics/similar')
+           .query({"clientVersion": "1.1"})
+           .reply(200, JSON.parse(mockResponse));
+        done()
+    });
+
+    afterEach(function(done) {
+        nock.cleanAll();
+        done();
+    });
+
+    it("successfully calls the similarTerms endpoint", function(done) {
+        var api = new Api('123456789', 'https://api.rosette.com/rest/v1');
+        api.parameters.content = "Some Content";
+
+        api.rosette("similarTerms", 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("similarTerms", 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("similarTerms", 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("Semantic Vectors Endpoint", function() {
+    beforeEach(function(done) {
+        var mockResponse = JSON.stringify({'name': 'Rosette API', 'versionChecked': true});
+
+        nock('https://api.rosette.com', {"encodedQueryParams": true })
+           .post('/rest/v1/semantics/vector')
            .query({"clientVersion": "1.1"})
            .reply(200, JSON.parse(mockResponse));
         done();
@@ -702,11 +757,11 @@ describe("Text Embedding Endpoint", function() {
         done();
     });
 
-    it("successfully calls the textEmbedding endpoint", function(done) {
+    it("successfully calls the semanticVectors 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) {
+        api.rosette("semanticVectors", function(err, res) {
             chai.expect(err).to.be.null;
             chai.expect(res.name).to.equal('Rosette API');
             done();
@@ -719,7 +774,7 @@ describe("Text Embedding Endpoint", function() {
         api.parameters.content = "Sample Content";
         api.parameters.contentUri = "http://some.url.com";
 
-        api.rosette("textEmbedding", function(err, res) {
+        api.rosette("semanticVectors", function(err, res) {
             chai.expect(err).to.not.be.null;
             chai.expect(err.name).to.equal('RosetteException');
             chai.expect(err.message).to.contain('badArgument');
@@ -730,7 +785,7 @@ describe("Text Embedding Endpoint", function() {
     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) {
+        api.rosette("semanticVectors", function(err, res) {
             chai.expect(err).to.not.be.null;
             chai.expect(err.name).to.equal('RosetteException');
             chai.expect(err.message).to.contain('badArgument');