bravey
Version:
A simple JavaScript NLP-like library to help you creating your own bot.
149 lines (121 loc) • 7.32 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: entityrecognizers/RegexEntityRecognizer.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: entityrecognizers/RegexEntityRecognizer.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* Can recognize stacked regular expressions in a sentence. Cleans up the input text first.
* @constructor
* @param {string} entityName - The name of produced entities.
*/
Bravey.RegexEntityRecognizer = function(entityName) {
function sortEntities(ent) {
ent.sort(function(a, b) {
if (a.position < b.position) return -1;
if (a.position > b.position) return 1;
if (a.string.length > b.string.length) return -1;
if (a.string.length < b.string.length) return 1;
if (a.priority > b.priority) return -1;
if (a.priority < b.priority) return 1;
return 0;
});
}
var regexs = [];
/**
* Add a new regular expression to the set.
* @param {RegExp} regex - The regular expression to be matched.
* @param {regexEntityRecognizerCallback} callback - The data processor to be called when the regular expression is matched.
* @param {number} [priority=0] - The priority of produced entities.
*/
this.addMatch = function(regex, callback, priority) {
regexs.push({
regex: regex,
callback: callback,
priority: priority || 0
});
}
/**
* Returns the recognizer entity name.
* @returns {string} The entity name.
*/
this.getName = function() {
return entityName;
}
/**
* Returns all found entities in a sentence. Returned entities value are defined by the specific callbacks.
* @param {string} string - The sentence to be checked.
* @param {Entity[]} [out=[]] - The array in which the found entities will be added.
* @returns {Entity[]} The set of found entities.
*/
this.getEntities = function(string, out) {
string = Bravey.Text.clean(string);
var found, piece, match, entitiesFound = [],
pos = -1;
if (!out) out = [];
var s = string;
for (var i = 0; i < regexs.length; i++) {
while ((match = regexs[i].regex.exec(s)) != null) {
piece = string.substr(match.index, match[0].length);
found = regexs[i].callback(match);
if (found !== undefined)
entitiesFound.push(Bravey.Text.entityTrim({
value: found,
entity: entityName,
position: match.index,
string: piece,
priority: regexs[i].priority
}));
}
}
sortEntities(entitiesFound);
for (var i = 0; i < entitiesFound.length; i++)
if (entitiesFound[i].position >= pos) {
out.push(entitiesFound[i]);
pos = entitiesFound[i].position + entitiesFound[i].string.length;
}
return out;
}
this.bindTo = function(obj) {
var self = this;
obj.getName = function() {
return self.getName();
}
obj.getEntities = function(string, out) {
return self.getEntities(string, out);
}
}
}
/**
* Called when RegexEntityRecognizer matches a regular expression.
* @callback regexEntityRecognizerCallback
* @param {string[]} match - The matched values.
* @returns {Entity} The processed entity.
* @returns {undefined} When the match found is not a valid entity.
*/</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Bravey.ApiAiAdapter.html">ApiAiAdapter</a></li><li><a href="Bravey.ContextManager.html">ContextManager</a></li><li><a href="Bravey.DocumentClassifier.html">DocumentClassifier</a></li><li><a href="Bravey.EMailEntityRecognizer.html">EMailEntityRecognizer</a></li><li><a href="Bravey.Filter.BasicFilter.html">BasicFilter</a></li><li><a href="Bravey.FreeTextEntityRecognizer.html">FreeTextEntityRecognizer</a></li><li><a href="Bravey.Language.EN.DateEntityRecognizer.html">DateEntityRecognizer</a></li><li><a href="Bravey.Language.EN.FreeTextEntityRecognizer.html">FreeTextEntityRecognizer</a></li><li><a href="Bravey.Language.EN.NumberEntityRecognizer.html">NumberEntityRecognizer</a></li><li><a href="Bravey.Language.EN.Stemmer.html">Stemmer</a></li><li><a href="Bravey.Language.EN.TimeEntityRecognizer.html">TimeEntityRecognizer</a></li><li><a href="Bravey.Language.EN.TimePeriodEntityRecognizer.html">TimePeriodEntityRecognizer</a></li><li><a href="Bravey.Language.IT.DateEntityRecognizer.html">DateEntityRecognizer</a></li><li><a href="Bravey.Language.IT.FreeTextEntityRecognizer.html">FreeTextEntityRecognizer</a></li><li><a href="Bravey.Language.IT.NumberEntityRecognizer.html">NumberEntityRecognizer</a></li><li><a href="Bravey.Language.IT.Stemmer.html">Stemmer</a></li><li><a href="Bravey.Language.IT.TimeEntityRecognizer.html">TimeEntityRecognizer</a></li><li><a href="Bravey.Language.IT.TimePeriodEntityRecognizer.html">TimePeriodEntityRecognizer</a></li><li><a href="Bravey.Language.PT.DateEntityRecognizer.html">DateEntityRecognizer</a></li><li><a href="Bravey.Language.PT.FreeTextEntityRecognizer.html">FreeTextEntityRecognizer</a></li><li><a href="Bravey.Language.PT.NumberEntityRecognizer.html">NumberEntityRecognizer</a></li><li><a href="Bravey.Language.PT.Stemmer.html">Stemmer</a></li><li><a href="Bravey.Language.PT.TimeEntityRecognizer.html">TimeEntityRecognizer</a></li><li><a href="Bravey.Language.PT.TimePeriodEntityRecognizer.html">TimePeriodEntityRecognizer</a></li><li><a href="Bravey.Nlp.Fuzzy.html">Fuzzy</a></li><li><a href="Bravey.Nlp.Sequential.html">Sequential</a></li><li><a href="Bravey.NumberEntityRecognizer.html">NumberEntityRecognizer</a></li><li><a href="Bravey.RegexEntityRecognizer.html">RegexEntityRecognizer</a></li><li><a href="Bravey.SessionManager.InMemorySessionManager.html">InMemorySessionManager</a></li><li><a href="Bravey.StringEntityRecognizer.html">StringEntityRecognizer</a></li><li><a href="Bravey.Text.RegexMap.html">RegexMap</a></li></ul><h3>Namespaces</h3><ul><li><a href="Bravey.html">Bravey</a></li><li><a href="Bravey.Data.html">Data</a></li><li><a href="Bravey.Date.html">Date</a></li><li><a href="Bravey.File.html">File</a></li><li><a href="Bravey.Filter.html">Filter</a></li><li><a href="Bravey.Language.html">Language</a></li><li><a href="Bravey.Language.EN.html">EN</a></li><li><a href="Bravey.Language.IT.html">IT</a></li><li><a href="Bravey.Language.PT.html">PT</a></li><li><a href="Bravey.Nlp.html">Nlp</a></li><li><a href="Bravey.SessionManager.html">SessionManager</a></li><li><a href="Bravey.Text.html">Text</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>