Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@seth-mg
seth-mg committed Nov 22, 2024
1 parent 6ccb219 commit 1134039
Show file tree
Hide file tree
Showing 54 changed files with 1,591 additions and 751 deletions.
24 changes: 12 additions & 12 deletions Api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ <h4 class="name" id="Api"><span class="type-signature"></span>new Api<span class


<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>2016-2018 Basis Technology Corporation.</li></ul></dd>
<dd class="tag-copyright"><ul class="dummy"><li>2016-2024 Basis Technology Corporation.</li></ul></dd>



Expand All @@ -101,7 +101,7 @@ <h4 class="name" id="Api"><span class="type-signature"></span>new Api<span class

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line56">line 56</a>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line58">line 58</a>
</li></ul></dd>


Expand Down Expand Up @@ -162,7 +162,7 @@ <h4 class="name" id="parameters"><span class="type-signature"></span>parameters<


<div class="description">
The Rosette API endpoint parameters
The Analytics API endpoint parameters
</div>


Expand Down Expand Up @@ -210,7 +210,7 @@ <h5>Type:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line67">line 67</a>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line69">line 69</a>
</li></ul></dd>


Expand Down Expand Up @@ -282,7 +282,7 @@ <h5>Type:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line73">line 73</a>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line75">line 75</a>
</li></ul></dd>


Expand All @@ -306,7 +306,7 @@ <h4 class="name" id="userKey"><span class="type-signature"></span>userKey<span c


<div class="description">
The Rosette API key used for authentication
The Analytics API key used for authentication
</div>


Expand Down Expand Up @@ -354,7 +354,7 @@ <h5>Type:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line61">line 61</a>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line63">line 63</a>
</li></ul></dd>


Expand Down Expand Up @@ -390,7 +390,7 @@ <h4 class="name" id="rosette"><span class="type-signature"></span>rosette<span c


<div class="description">
Accepts a Rosette API endpoint name and forwards user parameters to the endpoint
Accepts an Analytics API endpoint name and forwards user parameters to the endpoint
</div>


Expand Down Expand Up @@ -442,7 +442,7 @@ <h5>Parameters:</h5>



<td class="description last">The Rosette API endpoint to be utilized</td>
<td class="description last">The Analytics API endpoint to be utilized</td>
</tr>


Expand Down Expand Up @@ -483,7 +483,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line102">line 102</a>
<a href="Api.js.html">Api.js</a>, <a href="Api.js.html#line104">line 104</a>
</li></ul></dd>


Expand Down Expand Up @@ -529,13 +529,13 @@ <h5>Parameters:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="events.html">events</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="recordSimilarity.html">recordSimilarity</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Tue Jun 16 2020 19:45:41 GMT+0000 (Coordinated Universal Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 22 2024 22:59:41 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
31 changes: 18 additions & 13 deletions Api.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ <h1 class="page-title">Source: Api.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Rosette API.
* Babel Street Analytics API.
*
* @copyright 2016-2019 Basis Technology Corporation.
* @copyright 2016-2024 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
Expand All @@ -52,18 +52,20 @@ <h1 class="page-title">Source: Api.js</h1>
var addressSimilarity = require("./addressSimilarity")
var categories = require("./categories");
var entities = require("./entities");
var events = require("./events");
var info = require("./info");
var language = require("./language");
var matchedName = require("./nameSimilarity");
var morphology = require("./morphology");
var nameDeduplication = require("./nameDeduplication");
var ping = require("./ping");
var recordSimilarity = require("./recordSimilarity");
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 syntaxDependencies = require("./syntax_dependencies");
var textEmbedding = require("./textEmbedding");
var tokens = require("./tokens");
var topics = require("./topics");
Expand All @@ -78,19 +80,19 @@ <h1 class="page-title">Source: Api.js</h1>
* Api server endpoints.
*
* @example var api = new API(userKey, serviceUrl);
* @copyright 2016-2018 Basis Technology Corporation.
* @copyright 2016-2024 Basis Technology Corporation.
* @license http://www.apache.org/licenses/LICENSE-2.0
*/
function Api(userKey, serviceURL) {
/**
* @type {string}
* @desc The Rosette API key used for authentication
* @desc The Analytics API key used for authentication
*/
this.userKey = userKey;

/**
* @type {object}
* @desc The Rosette API endpoint parameters
* @desc The Analytics API endpoint parameters
*/
this.parameters = new paramObj();

Expand All @@ -106,30 +108,33 @@ <h1 class="page-title">Source: Api.js</h1>
* @default
*/
if (serviceURL) {
if (serviceURL.slice(-1) != '/') {
if (serviceURL.slice(-1) !== '/') {
serviceURL = serviceURL.concat('/')
this.serviceURL = serviceURL;
} else {
this.serviceURL = serviceURL;
}
} else {
this.serviceURL = "https://api.rosette.com/rest/v1/";
this.serviceURL = "https://analytics.babelstreet.com/rest/v1/";
}
var urlParts = URL.parse(this.serviceURL);
if (urlParts.protocol === "http:") {
this.protocol = http;
}

};
}

/**
* @type {string}
* @desc Accepts a Rosette API endpoint name and forwards user parameters to the endpoint
* @param {string} endpoint - The Rosette API endpoint to be utilized
* @desc Accepts an Analytics API endpoint name and forwards user parameters to the endpoint
* @param {string} endpoint - The Analytics API endpoint to be utilized
*/
Api.prototype.rosette = function(endpoint, callback) {

var api = this;
if (typeof(api.parameters.genre) !== 'undefined' &amp;&amp; api.parameters.genre != null) {
console.warn("The genre parameter is deprecated and will be removed in a future release.");
}
endpoint = require("./" + endpoint);
var e = new endpoint();

Expand All @@ -154,13 +159,13 @@ <h1 class="page-title">Source: Api.js</h1>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="events.html">events</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="recordSimilarity.html">recordSimilarity</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Tue Jun 16 2020 19:45:41 GMT+0000 (Coordinated Universal Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 22 2024 22:59:41 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
16 changes: 8 additions & 8 deletions addressSimilarity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h4 class="name" id="addressSimilarity"><span class="type-signature"></span>new


<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>2016-2018 Basis Technology Corporation.</li></ul></dd>
<dd class="tag-copyright"><ul class="dummy"><li>2016-2024 Basis Technology Corporation.</li></ul></dd>



Expand Down Expand Up @@ -159,7 +159,7 @@ <h4 class="name" id="getResults"><span class="type-signature"></span>getResults<


<div class="description">
Makes an HTTP request to the specified Rosette API endpoint and returns the result
Makes an HTTP request to the specified Analytics API endpoint and returns the result
</div>


Expand Down Expand Up @@ -211,7 +211,7 @@ <h5>Parameters:</h5>



<td class="description last">The Rosette API endpoint parameters</td>
<td class="description last">The Analytics API endpoint parameters</td>
</tr>


Expand All @@ -234,7 +234,7 @@ <h5>Parameters:</h5>



<td class="description last">The Rosette API user access key</td>
<td class="description last">The Analytics API user access key</td>
</tr>


Expand All @@ -257,7 +257,7 @@ <h5>Parameters:</h5>



<td class="description last">The base service URL to be used to access the Rosette API</td>
<td class="description last">The base service URL to be used to access the Analytics API</td>
</tr>


Expand All @@ -280,7 +280,7 @@ <h5>Parameters:</h5>



<td class="description last">Callback function to be exectuted after the function to which it is passed is complete</td>
<td class="description last">Callback function to be executed after the function to which it is passed is complete</td>
</tr>


Expand Down Expand Up @@ -367,13 +367,13 @@ <h5>Parameters:</h5>
</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addressSimilarity.html">addressSimilarity</a></li><li><a href="Api.html">Api</a></li><li><a href="categories.html">categories</a></li><li><a href="entities.html">entities</a></li><li><a href="events.html">events</a></li><li><a href="info.html">info</a></li><li><a href="language.html">language</a></li><li><a href="morphology.html">morphology</a></li><li><a href="nameDeduplication.html">nameDeduplication</a></li><li><a href="nameSimilarity.html">nameSimilarity</a></li><li><a href="nameTranslation.html">nameTranslation</a></li><li><a href="parameters.html">parameters</a></li><li><a href="ping.html">ping</a></li><li><a href="recordSimilarity.html">recordSimilarity</a></li><li><a href="relationships.html">relationships</a></li><li><a href="rosetteRequest.html">rosetteRequest</a></li><li><a href="semanticVectors.html">semanticVectors</a></li><li><a href="sentences.html">sentences</a></li><li><a href="sentiment.html">sentiment</a></li><li><a href="similarTerms.html">similarTerms</a></li><li><a href="syntax_dependencies.html">syntax_dependencies</a></li><li><a href="textEmbedding.html">textEmbedding</a></li><li><a href="tokens.html">tokens</a></li><li><a href="topics.html">topics</a></li><li><a href="transliteration.html">transliteration</a></li></ul><h3>Global</h3><ul><li><a href="global.html#BINDING_VERSION">BINDING_VERSION</a></li><li><a href="global.html#dataFormat">dataFormat</a></li><li><a href="global.html#morphologyOutput">morphologyOutput</a></li><li><a href="global.html#RosetteException">RosetteException</a></li></ul>
</nav>

<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Tue Jun 16 2020 19:45:41 GMT+0000 (Coordinated Universal Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Fri Nov 22 2024 22:59:41 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 1134039

Please sign in to comment.