node-nlp
Version:
Library for NLU (Natural Language Understanding) done in Node.js
174 lines (148 loc) • 7.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: ner/enum-named-entity.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: ner/enum-named-entity.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*
* Copyright (c) AXA Shared Services Spain S.A.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
const NamedEntity = require('./named-entity');
/**
* Class for the Enumerated Named Entity.
*/
class EnumNamedEntity extends NamedEntity {
/**
* Constructor of the class.
* @param {Object} settings Settings for the instance.
*/
constructor(settings) {
super(settings);
this.type = 'enum';
}
/**
* Get or create an option inside a locale
* @param {string} language Locale of the language.
* @param {string} optionName Name of the option.
* @param {boolean} create Flag indicating if should create if not exists.
* @returns {Object} Option object.
*/
getOption(language, optionName, create = true) {
const locale = this.getLocale(language, create);
if (!locale) {
return undefined;
}
if (!locale[optionName] && create) {
locale[optionName] = [];
}
return locale[optionName];
}
/**
* Add texts to the given languages of an option.
* @param {String} optionName Name of the option.
* @param {String[]} srcLanguages Language or languages for adding the texts.
* @param {String[]} srcTexts Text or texts to be added.
*/
addText(optionName, srcLanguages, srcTexts) {
const languages = Array.isArray(srcLanguages)
? srcLanguages
: [srcLanguages];
const texts = Array.isArray(srcTexts) ? srcTexts : [srcTexts];
languages.forEach(language => {
const option = this.getOption(language, optionName);
texts.forEach(text => {
option.push(text);
});
});
}
/**
* Remove texts for the given languages of the option.
* @param {String} optionName Name of the option.
* @param {String[]} srcLanguages Languages affected.
* @param {String[]} srcTexts Texts to be removed.
*/
removeText(optionName, srcLanguages, srcTexts) {
const languages = Array.isArray(srcLanguages)
? srcLanguages
: [srcLanguages];
const texts = Array.isArray(srcTexts) ? srcTexts : [srcTexts];
languages.forEach(language => {
const option = this.getOption(language, optionName, false);
if (option) {
texts.forEach(text => {
const index = option.indexOf(text);
if (index !== -1) {
option.splice(index, 1);
}
});
}
});
}
/**
* Given an utterance and language, extract the different occurances of this
* named entity in the utterance.
* @param {String} utterance Source utterance to extract information.
* @param {String} language Locale of the language.
* @param {Object} similar Instance of SimilarSearch.
* @param {Object[]} wordPositions Optional array of word positions.
* @param {number} threshold Threshold of accuracy.
* @return {Object[]} Edges found.
*/
extract(utterance, language, similar, wordPositions, threshold) {
return similar.getEdgesFromEntity(
utterance,
this,
language,
this.name,
threshold,
wordPositions
);
}
}
module.exports = EnumNamedEntity;
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryNeuralNetworkClassifier.html">BinaryNeuralNetworkClassifier</a></li><li><a href="Classifier.html">Classifier</a></li><li><a href="ConversationContext.html">ConversationContext</a></li><li><a href="DutchStemmer.html">DutchStemmer</a></li><li><a href="EnglishStemmer.html">EnglishStemmer</a></li><li><a href="EnumNamedEntity.html">EnumNamedEntity</a></li><li><a href="Evaluator.html">Evaluator</a></li><li><a href="HungarianStemmer.html">HungarianStemmer</a></li><li><a href="ItalianStemmer.html">ItalianStemmer</a></li><li><a href="Language.html">Language</a></li><li><a href="LogisticRegressionClassifier.html">LogisticRegressionClassifier</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MemoryConversationContext.html">MemoryConversationContext</a></li><li><a href="NamedEntity.html">NamedEntity</a></li><li><a href="NerManager.html">NerManager</a></li><li><a href="NlgManager.html">NlgManager</a></li><li><a href="NlpClassifier.html">NlpClassifier</a></li><li><a href="NlpManager.html">NlpManager</a></li><li><a href="NorwegianStemmer.html">NorwegianStemmer</a></li><li><a href="PortugueseStemmer.html">PortugueseStemmer</a></li><li><a href="Recognizer.html">Recognizer</a></li><li><a href="RegexNamedEntity.html">RegexNamedEntity</a></li><li><a href="RomanianStemmer.html">RomanianStemmer</a></li><li><a href="RussianStemmer.html">RussianStemmer</a></li><li><a href="SentimentAnalyzer.html">SentimentAnalyzer</a></li><li><a href="SentimentManager.html">SentimentManager</a></li><li><a href="SimilarSearch.html">SimilarSearch</a></li><li><a href="SlotManager.html">SlotManager</a></li><li><a href="StemmerJa.html">StemmerJa</a></li><li><a href="SwedishStemmer.html">SwedishStemmer</a></li><li><a href="Tokenizer.html">Tokenizer</a></li><li><a href="TrimNamedEntity.html">TrimNamedEntity</a></li><li><a href="TurkishStemmer.html">TurkishStemmer</a></li><li><a href="Vector.html">Vector</a></li><li><a href="XTable.html">XTable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#endsinArr">endsinArr</a></li><li><a href="global.html#prelude">prelude</a></li><li><a href="global.html#regions">regions</a></li><li><a href="global.html#stem">stem</a></li><li><a href="global.html#stopwords">stopwords</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Oct 13 2018 19:14:51 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>