nlptoolkit-namedentityrecognition 1.0.0

package/README.md

@@ -0,0 +1,100 @@
+Named Entity Recognition Task
+============
+
+In named entity recognition, one tries to find the strings within a text that correspond to proper names (excluding TIME and MONEY) and classify the type of entity denoted by these strings. The problem is difficult partly due to the ambiguity in sentence segmentation; one needs to extract which words belong to a named entity, and which not. Another difficulty occurs when some word may be used as a name of either a person, an organization or a location. For example, Deniz may be used as the name of a person, or - within a compound - it can refer to a location Marmara Denizi 'Marmara Sea', or an organization Deniz Taşımacılık 'Deniz Transportation'.
+
+The standard approach for NER is a word-by-word classification, where the classifier is trained to label the words in the text with tags that indicate the presence of particular kinds of named entities. After giving the class labels (named entity tags) to our training data, the next step is to select a group of features to discriminate different named entities for each input word.
+
+[<sub>ORG</sub> Türk Hava Yolları] bu [<sub>TIME</sub> Pazartesi'den] itibaren [<sub>LOC</sub> İstanbul] [<sub>LOC</sub> Ankara] hattı için indirimli satışlarını [<sub>MONEY</sub> 90 TL'den] başlatacağını açıkladı.
+
+[<sub>ORG</sub> Turkish Airlines] announced that from this [<sub>TIME</sub> Monday] on it will start its discounted fares of [<sub>MONEY</sub> 90TL] for [<sub>LOC</sub> İstanbul] [<sub>LOC</sub> Ankara] route.
+
+See the Table below for typical generic named entity types.
+
+|Tag|Sample Categories|
+|---|---|
+|PERSON|people, characters|
+|ORGANIZATION|companies, teams|
+|LOCATION|regions, mountains, seas|
+|TIME|time expressions|
+|MONEY|monetarial expressions|
+
+For Developers
+============
+
+You can also see [Java](https://github.com/starlangsoftware/TurkishNamedEntityRecognition), [Python](https://github.com/starlangsoftware/TurkishNamedEntityRecognition-Py), [Cython](https://github.com/starlangsoftware/TurkishNamedEntityRecognition-Cy), 
+[Swift](https://github.com/starlangsoftware/TurkishNamedEntityRecognition-Swift), [C++](https://github.com/starlangsoftware/TurkishNamedEntityRecognition-CPP), 
+or [C#](https://github.com/starlangsoftware/TurkishNamedEntityRecognition-CS) repository.
+
+## Requirements
+
+* [Node.js 14 or higher](#Node.js)
+* [Git](#git)
+
+### Node.js 
+
+To check if you have a compatible version of Node.js installed, use the following command:
+
+    node -v
+    
+You can find the latest version of Node.js [here](https://nodejs.org/en/download/).
+
+### Git
+
+Install the [latest version of Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
+
+## Npm Install
+
+	npm install nlptoolkit-namedentityrecognition
+	
+## Download Code
+
+In order to work on code, create a fork from GitHub page. 
+Use Git for cloning the code to your local or below line for Ubuntu:
+
+	git clone <your-fork-git-link>
+
+A directory called util will be created. Or you can use below link for exploring the code:
+
+	git clone https://github.com/starlangsoftware/namedentityrecognition-js.git
+
+## Open project with Webstorm IDE
+
+Steps for opening the cloned project:
+
+* Start IDE
+* Select **File | Open** from main menu
+* Choose `Namedentityrecognition-Js` file
+* Select open as project option
+* Couple of seconds, dependencies will be downloaded. 
+
+Detailed Description
+============
+
++ [Gazetteer](#gazetteer)
+
+## Gazetteer
+
+Bir Gazetter yüklemek için
+
+	Gazetteer(name: string, fileName: string)
+
+Hazır Gazetteerleri kullanmak için
+
+	AutoNER()
+
+Bir Gazetteer'de bir kelime var mı diye kontrol etmek için
+
+	contains(word: string):boolean
+
+# Cite
+
+	@INPROCEEDINGS{8093439,
+  	author={B. {Ertopçu} and A. B. {Kanburoğlu} and O. {Topsakal} and O. {Açıkgöz} and A. T. {Gürkan} and B. {Özenç} and İ. {Çam} and B. {Avar} and G. {Ercan} 	and O. T. {Yıldız}},
+  	booktitle={2017 International Conference on Computer Science and Engineering (UBMK)}, 
+  	title={A new approach for named entity recognition}, 
+  	year={2017},
+  	volume={},
+  	number={},
+  	pages={474-479},
+  	doi={10.1109/UBMK.2017.8093439}}

package/dist/AutoNER.d.ts

@@ -0,0 +1,10 @@
+import { Gazetteer } from "./Gazetteer";
+export declare abstract class AutoNER {
+    protected personGazetteer: Gazetteer;
+    protected organizationGazetteer: Gazetteer;
+    protected locationGazetteer: Gazetteer;
+    /**
+     * Constructor for creating Person, Organization, and Location gazetteers in automatic Named Entity Recognition.
+     */
+    constructor();
+}

package/dist/AutoNER.js

@@ -0,0 +1,26 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./Gazetteer"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.AutoNER = void 0;
+    const Gazetteer_1 = require("./Gazetteer");
+    class AutoNER {
+        /**
+         * Constructor for creating Person, Organization, and Location gazetteers in automatic Named Entity Recognition.
+         */
+        constructor() {
+            this.personGazetteer = new Gazetteer_1.Gazetteer("PERSON", "gazetteer-person.txt");
+            this.organizationGazetteer = new Gazetteer_1.Gazetteer("ORGANIZATION", "gazetteer-organization.txt");
+            this.locationGazetteer = new Gazetteer_1.Gazetteer("LOCATION", "gazetteer-location.txt");
+        }
+    }
+    exports.AutoNER = AutoNER;
+});
+//# sourceMappingURL=AutoNER.js.map

package/dist/AutoNER.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutoNER.js","sourceRoot":"","sources":["../source/AutoNER.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,2CAAsC;IAEtC,MAAsB,OAAO;QAMzB;;WAEG;QACH;YACI,IAAI,CAAC,eAAe,GAAG,IAAI,qBAAS,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YACvE,IAAI,CAAC,qBAAqB,GAAG,IAAI,qBAAS,CAAC,cAAc,EAAE,4BAA4B,CAAC,CAAC;YACzF,IAAI,CAAC,iBAAiB,GAAG,IAAI,qBAAS,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QACjF,CAAC;KACJ;IAdD,0BAcC"}

package/dist/Gazetteer.d.ts

@@ -0,0 +1,23 @@
+export declare class Gazetteer {
+    private data;
+    private name;
+    /**
+     * A constructor for a specific gazetteer. The constructor takes name of the gazetteer and file name of the
+     * gazetteer as input, reads the gazetteer from the input file.
+     * @param name Name of the gazetteer. This name will be used in programming to separate different gazetteers.
+     * @param fileName File name of the gazetteer data.
+     */
+    constructor(name: string, fileName: string);
+    /**
+     * Accessor method for the name of the gazetteer.
+     * @return Name of the gazetteer.
+     */
+    getName(): string;
+    /**
+     * The most important method in {@link Gazetteer} class. Checks if the given word exists in the gazetteer. The check
+     * is done in lowercase form.
+     * @param word Word to be search in Gazetteer.
+     * @return True if the word is in the Gazetteer, False otherwise.
+     */
+    contains(word: string): boolean;
+}

package/dist/Gazetteer.js

@@ -0,0 +1,50 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "fs"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Gazetteer = void 0;
+    const fs = require("fs");
+    class Gazetteer {
+        /**
+         * A constructor for a specific gazetteer. The constructor takes name of the gazetteer and file name of the
+         * gazetteer as input, reads the gazetteer from the input file.
+         * @param name Name of the gazetteer. This name will be used in programming to separate different gazetteers.
+         * @param fileName File name of the gazetteer data.
+         */
+        constructor(name, fileName) {
+            this.data = new Set();
+            this.name = name;
+            let data = fs.readFileSync(fileName, 'utf8');
+            let lines = data.split("\n");
+            for (let line of lines) {
+                this.data.add(line.toLocaleLowerCase("tr"));
+            }
+        }
+        /**
+         * Accessor method for the name of the gazetteer.
+         * @return Name of the gazetteer.
+         */
+        getName() {
+            return this.name;
+        }
+        /**
+         * The most important method in {@link Gazetteer} class. Checks if the given word exists in the gazetteer. The check
+         * is done in lowercase form.
+         * @param word Word to be search in Gazetteer.
+         * @return True if the word is in the Gazetteer, False otherwise.
+         */
+        contains(word) {
+            let lowerCase = word.toLocaleLowerCase("tr");
+            return this.data.has(lowerCase);
+        }
+    }
+    exports.Gazetteer = Gazetteer;
+});
+//# sourceMappingURL=Gazetteer.js.map

package/dist/Gazetteer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gazetteer.js","sourceRoot":"","sources":["../source/Gazetteer.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,yBAAyB;IAEzB,MAAa,SAAS;QAKlB;;;;;WAKG;QACH,YAAY,IAAY,EAAE,QAAgB;YATlC,SAAI,GAAgB,IAAI,GAAG,EAAU,CAAA;YAUzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;YAChB,IAAI,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC5C,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC5B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;aAC9C;QACL,CAAC;QAED;;;WAGG;QACH,OAAO;YACH,OAAO,IAAI,CAAC,IAAI,CAAA;QACpB,CAAC;QAED;;;;;WAKG;QACH,QAAQ,CAAC,IAAY;YACjB,IAAI,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;YAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QACnC,CAAC;KACJ;IAtCD,8BAsCC"}

package/dist/NERCorpus.d.ts

@@ -0,0 +1,16 @@
+import { Corpus } from "nlptoolkit-corpus/dist/Corpus";
+import { Sentence } from "nlptoolkit-corpus/dist/Sentence";
+export declare class NERCorpus extends Corpus {
+    /**
+     * Another constructor of {@link NERCorpus} which takes a fileName of the corpus as an input, reads the
+     * corpus from that file.
+     *
+     * @param fileName Name of the corpus file.
+     */
+    constructor(fileName?: string);
+    /**
+     * addSentence adds a new sentence to the sentences {@link Array}
+     * @param s Sentence to be added.
+     */
+    addSentence(s: Sentence): void;
+}

package/dist/NERCorpus.js

@@ -0,0 +1,43 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "nlptoolkit-corpus/dist/Corpus", "fs", "./NamedEntitySentence"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NERCorpus = void 0;
+    const Corpus_1 = require("nlptoolkit-corpus/dist/Corpus");
+    const fs = require("fs");
+    const NamedEntitySentence_1 = require("./NamedEntitySentence");
+    class NERCorpus extends Corpus_1.Corpus {
+        /**
+         * Another constructor of {@link NERCorpus} which takes a fileName of the corpus as an input, reads the
+         * corpus from that file.
+         *
+         * @param fileName Name of the corpus file.
+         */
+        constructor(fileName) {
+            super();
+            if (fileName != undefined) {
+                let data = fs.readFileSync(fileName, 'utf8');
+                let lines = data.split("\n");
+                for (let line of lines) {
+                    this.addSentence(new NamedEntitySentence_1.NamedEntitySentence(line));
+                }
+            }
+        }
+        /**
+         * addSentence adds a new sentence to the sentences {@link Array}
+         * @param s Sentence to be added.
+         */
+        addSentence(s) {
+            this.sentences.push(s);
+        }
+    }
+    exports.NERCorpus = NERCorpus;
+});
+//# sourceMappingURL=NERCorpus.js.map

package/dist/NERCorpus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NERCorpus.js","sourceRoot":"","sources":["../source/NERCorpus.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,0DAAqD;IACrD,yBAAyB;IACzB,+DAA0D;IAG1D,MAAa,SAAU,SAAQ,eAAM;QAEjC;;;;;WAKG;QACH,YAAY,QAAiB;YACzB,KAAK,EAAE,CAAC;YACR,IAAI,QAAQ,IAAI,SAAS,EAAC;gBACtB,IAAI,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAC5C,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAC5B,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;oBACpB,IAAI,CAAC,WAAW,CAAC,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC,CAAA;iBAClD;aACJ;QACL,CAAC;QAED;;;WAGG;QACH,WAAW,CAAC,CAAW;YACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC1B,CAAC;KACJ;IA1BD,8BA0BC"}

package/dist/NamedEntitySentence.d.ts

@@ -0,0 +1,9 @@
+import { Sentence } from "nlptoolkit-corpus/dist/Sentence";
+export declare class NamedEntitySentence extends Sentence {
+    /**
+     * Another constructor of {@link NamedEntitySentence}. It takes input a named entity annotated sentence in string
+     * form, divides the sentence with respect to space and sets the tagged words with respect to their tags.
+     * @param sentence Named Entity annotated sentence in string form
+     */
+    constructor(sentence?: string);
+}

package/dist/NamedEntitySentence.js

@@ -0,0 +1,73 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "nlptoolkit-corpus/dist/Sentence", "./NamedEntityType", "./NamedEntityTypeStatic", "./NamedEntityWord"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NamedEntitySentence = void 0;
+    const Sentence_1 = require("nlptoolkit-corpus/dist/Sentence");
+    const NamedEntityType_1 = require("./NamedEntityType");
+    const NamedEntityTypeStatic_1 = require("./NamedEntityTypeStatic");
+    const NamedEntityWord_1 = require("./NamedEntityWord");
+    class NamedEntitySentence extends Sentence_1.Sentence {
+        /**
+         * Another constructor of {@link NamedEntitySentence}. It takes input a named entity annotated sentence in string
+         * form, divides the sentence with respect to space and sets the tagged words with respect to their tags.
+         * @param sentence Named Entity annotated sentence in string form
+         */
+        constructor(sentence) {
+            super();
+            if (sentence != undefined) {
+                let type = NamedEntityType_1.NamedEntityType.NONE;
+                let wordArray = sentence.split(" ");
+                for (let word of wordArray) {
+                    if (word != "") {
+                        if (word != "<b_enamex") {
+                            if (word.startsWith("TYPE=\"")) {
+                                let typeIndexEnd = word.indexOf('\"', 6);
+                                if (typeIndexEnd != -1) {
+                                    let entityType = word.substring(6, typeIndexEnd);
+                                    type = NamedEntityTypeStatic_1.NamedEntityTypeStatic.getNamedEntityType(entityType);
+                                }
+                                if (word.endsWith("e_enamex>")) {
+                                    let candidate = word.substring(word.indexOf('>') + 1, word.indexOf('<'));
+                                    if (candidate != "") {
+                                        this.words.push(new NamedEntityWord_1.NamedEntityWord(candidate, type));
+                                    }
+                                    type = NamedEntityType_1.NamedEntityType.NONE;
+                                }
+                                else {
+                                    let candidate = word.substring(word.indexOf('>') + 1);
+                                    if (candidate != "") {
+                                        this.words.push(new NamedEntityWord_1.NamedEntityWord(candidate, type));
+                                    }
+                                }
+                            }
+                            else {
+                                if (word.endsWith("e_enamex>")) {
+                                    let candidate = word.substring(0, word.indexOf('<'));
+                                    if (candidate != "") {
+                                        this.words.push(new NamedEntityWord_1.NamedEntityWord(candidate, type));
+                                    }
+                                    type = NamedEntityType_1.NamedEntityType.NONE;
+                                }
+                                else {
+                                    if (word != "") {
+                                        this.words.push(new NamedEntityWord_1.NamedEntityWord(word, type));
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+    exports.NamedEntitySentence = NamedEntitySentence;
+});
+//# sourceMappingURL=NamedEntitySentence.js.map

package/dist/NamedEntitySentence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamedEntitySentence.js","sourceRoot":"","sources":["../source/NamedEntitySentence.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,8DAAyD;IACzD,uDAAkD;IAElD,mEAA8D;IAC9D,uDAAkD;IAElD,MAAa,mBAAoB,SAAQ,mBAAQ;QAE7C;;;;WAIG;QACH,YAAY,QAAiB;YACzB,KAAK,EAAE,CAAC;YACR,IAAI,QAAQ,IAAI,SAAS,EAAC;gBACtB,IAAI,IAAI,GAAG,iCAAe,CAAC,IAAI,CAAC;gBAChC,IAAI,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACpC,KAAK,IAAI,IAAI,IAAI,SAAS,EAAC;oBACvB,IAAI,IAAI,IAAI,EAAE,EAAC;wBACX,IAAI,IAAI,IAAI,WAAW,EAAC;4BACpB,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAC;gCAC3B,IAAI,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;gCACzC,IAAI,YAAY,IAAI,CAAC,CAAC,EAAC;oCACnB,IAAI,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;oCACjD,IAAI,GAAG,6CAAqB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;iCAC/D;gCACD,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAC;oCAC3B,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oCACzE,IAAI,SAAS,IAAI,EAAE,EAAC;wCAChB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,iCAAe,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;qCACzD;oCACD,IAAI,GAAG,iCAAe,CAAC,IAAI,CAAC;iCAC/B;qCAAM;oCACH,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oCACtD,IAAI,SAAS,IAAI,EAAE,EAAC;wCAChB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,iCAAe,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;qCACzD;iCACJ;6BACJ;iCAAM;gCACH,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAC;oCAC3B,IAAI,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oCACrD,IAAI,SAAS,IAAI,EAAE,EAAC;wCAChB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,iCAAe,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;qCACzD;oCACD,IAAI,GAAG,iCAAe,CAAC,IAAI,CAAC;iCAC/B;qCAAM;oCACH,IAAI,IAAI,IAAI,EAAE,EAAC;wCACX,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,iCAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;qCACpD;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;QACL,CAAC;KACJ;IAnDD,kDAmDC"}

package/dist/NamedEntityType.d.ts

@@ -0,0 +1,8 @@
+export declare enum NamedEntityType {
+    NONE = 0,
+    PERSON = 1,
+    ORGANIZATION = 2,
+    LOCATION = 3,
+    TIME = 4,
+    MONEY = 5
+}

package/dist/NamedEntityType.js

@@ -0,0 +1,23 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NamedEntityType = void 0;
+    var NamedEntityType;
+    (function (NamedEntityType) {
+        NamedEntityType[NamedEntityType["NONE"] = 0] = "NONE";
+        NamedEntityType[NamedEntityType["PERSON"] = 1] = "PERSON";
+        NamedEntityType[NamedEntityType["ORGANIZATION"] = 2] = "ORGANIZATION";
+        NamedEntityType[NamedEntityType["LOCATION"] = 3] = "LOCATION";
+        NamedEntityType[NamedEntityType["TIME"] = 4] = "TIME";
+        NamedEntityType[NamedEntityType["MONEY"] = 5] = "MONEY";
+    })(NamedEntityType = exports.NamedEntityType || (exports.NamedEntityType = {}));
+});
+//# sourceMappingURL=NamedEntityType.js.map

package/dist/NamedEntityType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamedEntityType.js","sourceRoot":"","sources":["../source/NamedEntityType.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,IAAY,eAEX;IAFD,WAAY,eAAe;QACvB,qDAAI,CAAA;QAAE,yDAAM,CAAA;QAAE,qEAAY,CAAA;QAAE,6DAAQ,CAAA;QAAE,qDAAI,CAAA;QAAE,uDAAK,CAAA;IACrD,CAAC,EAFW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAE1B"}

package/dist/NamedEntityTypeStatic.d.ts

@@ -0,0 +1,15 @@
+import { NamedEntityType } from "./NamedEntityType";
+export declare class NamedEntityTypeStatic {
+    /**
+     * Static function to convert a string entity type to {@link NamedEntityType} type.
+     * @param entityType Entity type in string form
+     * @return Entity type in {@link NamedEntityType} form
+     */
+    static getNamedEntityType(entityType: string): NamedEntityType;
+    /**
+     * Static function to convert a {@link NamedEntityType} to string form.
+     * @param entityType Entity type in {@link NamedEntityType} form
+     * @return Entity type in string form
+     */
+    static getNamedEntity(entityType: NamedEntityType): string;
+}

package/dist/NamedEntityTypeStatic.js

@@ -0,0 +1,62 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./NamedEntityType"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NamedEntityTypeStatic = void 0;
+    const NamedEntityType_1 = require("./NamedEntityType");
+    class NamedEntityTypeStatic {
+        /**
+         * Static function to convert a string entity type to {@link NamedEntityType} type.
+         * @param entityType Entity type in string form
+         * @return Entity type in {@link NamedEntityType} form
+         */
+        static getNamedEntityType(entityType) {
+            switch (entityType.toUpperCase()) {
+                case "PERSON":
+                    return NamedEntityType_1.NamedEntityType.PERSON;
+                case "LOCATION":
+                    return NamedEntityType_1.NamedEntityType.LOCATION;
+                case "ORGANIZATION":
+                    return NamedEntityType_1.NamedEntityType.ORGANIZATION;
+                case "TIME":
+                    return NamedEntityType_1.NamedEntityType.TIME;
+                case "MONEY":
+                    return NamedEntityType_1.NamedEntityType.MONEY;
+                default:
+                    return NamedEntityType_1.NamedEntityType.NONE;
+            }
+        }
+        /**
+         * Static function to convert a {@link NamedEntityType} to string form.
+         * @param entityType Entity type in {@link NamedEntityType} form
+         * @return Entity type in string form
+         */
+        static getNamedEntity(entityType) {
+            if (entityType == undefined)
+                return undefined;
+            switch (entityType) {
+                case NamedEntityType_1.NamedEntityType.PERSON:
+                    return "PERSON";
+                case NamedEntityType_1.NamedEntityType.LOCATION:
+                    return "LOCATION";
+                case NamedEntityType_1.NamedEntityType.ORGANIZATION:
+                    return "ORGANIZATION";
+                case NamedEntityType_1.NamedEntityType.TIME:
+                    return "TIME";
+                case NamedEntityType_1.NamedEntityType.MONEY:
+                    return "MONEY";
+                default:
+                    return "NONE";
+            }
+        }
+    }
+    exports.NamedEntityTypeStatic = NamedEntityTypeStatic;
+});
+//# sourceMappingURL=NamedEntityTypeStatic.js.map

package/dist/NamedEntityTypeStatic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamedEntityTypeStatic.js","sourceRoot":"","sources":["../source/NamedEntityTypeStatic.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,uDAAkD;IAElD,MAAa,qBAAqB;QAE9B;;;;WAIG;QACH,MAAM,CAAC,kBAAkB,CAAC,UAAkB;YACxC,QAAQ,UAAU,CAAC,WAAW,EAAE,EAAC;gBAC7B,KAAK,QAAQ;oBACT,OAAO,iCAAe,CAAC,MAAM,CAAC;gBAClC,KAAK,UAAU;oBACX,OAAO,iCAAe,CAAC,QAAQ,CAAC;gBACpC,KAAK,cAAc;oBACf,OAAO,iCAAe,CAAC,YAAY,CAAC;gBACxC,KAAK,MAAM;oBACP,OAAO,iCAAe,CAAC,IAAI,CAAC;gBAChC,KAAK,OAAO;oBACR,OAAO,iCAAe,CAAC,KAAK,CAAC;gBACjC;oBACI,OAAO,iCAAe,CAAC,IAAI,CAAC;aACnC;QACL,CAAC;QAED;;;;WAIG;QACH,MAAM,CAAC,cAAc,CAAC,UAA2B;YAC7C,IAAI,UAAU,IAAI,SAAS;gBACvB,OAAO,SAAS,CAAC;YACrB,QAAQ,UAAU,EAAC;gBACf,KAAK,iCAAe,CAAC,MAAM;oBACvB,OAAO,QAAQ,CAAC;gBACpB,KAAK,iCAAe,CAAC,QAAQ;oBACzB,OAAO,UAAU,CAAC;gBACtB,KAAK,iCAAe,CAAC,YAAY;oBAC7B,OAAO,cAAc,CAAC;gBAC1B,KAAK,iCAAe,CAAC,IAAI;oBACrB,OAAO,MAAM,CAAC;gBAClB,KAAK,iCAAe,CAAC,KAAK;oBACtB,OAAO,OAAO,CAAC;gBACnB;oBACI,OAAO,MAAM,CAAC;aACrB;QACL,CAAC;KACJ;IA/CD,sDA+CC"}

package/dist/NamedEntityWord.d.ts

@@ -0,0 +1,17 @@
+import { Word } from "nlptoolkit-dictionary/dist/Dictionary/Word";
+import { NamedEntityType } from "./NamedEntityType";
+export declare class NamedEntityWord extends Word {
+    private namedEntityType;
+    /**
+     * A constructor of {@link NamedEntityWord} which takes name and nameEntityType as input and sets the corresponding attributes
+     * @param name Name of the word
+     * @param namedEntityType {@link NamedEntityType} of the word
+     */
+    constructor(name: string, namedEntityType: NamedEntityType);
+    /**
+     * Accessor method for namedEntityType attribute.
+     *
+     * @return namedEntityType of the word.
+     */
+    getNamedEntityType(): NamedEntityType;
+}

package/dist/NamedEntityWord.js

@@ -0,0 +1,35 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "nlptoolkit-dictionary/dist/Dictionary/Word"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.NamedEntityWord = void 0;
+    const Word_1 = require("nlptoolkit-dictionary/dist/Dictionary/Word");
+    class NamedEntityWord extends Word_1.Word {
+        /**
+         * A constructor of {@link NamedEntityWord} which takes name and nameEntityType as input and sets the corresponding attributes
+         * @param name Name of the word
+         * @param namedEntityType {@link NamedEntityType} of the word
+         */
+        constructor(name, namedEntityType) {
+            super(name);
+            this.namedEntityType = namedEntityType;
+        }
+        /**
+         * Accessor method for namedEntityType attribute.
+         *
+         * @return namedEntityType of the word.
+         */
+        getNamedEntityType() {
+            return this.namedEntityType;
+        }
+    }
+    exports.NamedEntityWord = NamedEntityWord;
+});
+//# sourceMappingURL=NamedEntityWord.js.map

package/dist/NamedEntityWord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NamedEntityWord.js","sourceRoot":"","sources":["../source/NamedEntityWord.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,qEAAgE;IAGhE,MAAa,eAAgB,SAAQ,WAAI;QAIrC;;;;WAIG;QACH,YAAY,IAAY,EAAE,eAAgC;YACtD,KAAK,CAAC,IAAI,CAAC,CAAC;YACZ,IAAI,CAAC,eAAe,GAAG,eAAe,CAAA;QAC1C,CAAC;QAED;;;;WAIG;QACH,kBAAkB;YACd,OAAO,IAAI,CAAC,eAAe,CAAA;QAC/B,CAAC;KACJ;IAtBD,0CAsBC"}

package/dist/Slot.d.ts

@@ -0,0 +1,9 @@
+import { SlotType } from "./SlotType";
+export declare class Slot {
+    private type;
+    private tag;
+    constructor(typeOrSlot: any, tag?: string);
+    getType(): SlotType;
+    getTag(): string;
+    toString(): string;
+}

package/dist/Slot.js

@@ -0,0 +1,60 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./SlotType"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Slot = void 0;
+    const SlotType_1 = require("./SlotType");
+    class Slot {
+        constructor(typeOrSlot, tag) {
+            if (tag != undefined) {
+                this.type = typeOrSlot;
+                this.tag = tag;
+            }
+            else {
+                if (typeOrSlot == "O") {
+                    this.type = SlotType_1.SlotType.O;
+                    this.tag = undefined;
+                }
+                else {
+                    let type = typeOrSlot.substring(0, typeOrSlot.indexOf("-"));
+                    let tag = typeOrSlot.substring(typeOrSlot.indexOf("-") + 1);
+                    switch (type) {
+                        case "B":
+                            this.type = SlotType_1.SlotType.B;
+                            break;
+                        case "I":
+                            this.type = SlotType_1.SlotType.I;
+                            break;
+                    }
+                    this.tag = tag;
+                }
+            }
+        }
+        getType() {
+            return this.type;
+        }
+        getTag() {
+            return this.tag;
+        }
+        toString() {
+            switch (this.type) {
+                case SlotType_1.SlotType.O:
+                    return "O";
+                case SlotType_1.SlotType.B:
+                    return "B-" + this.tag;
+                case SlotType_1.SlotType.I:
+                    return "I-" + this.tag;
+            }
+            return "";
+        }
+    }
+    exports.Slot = Slot;
+});
+//# sourceMappingURL=Slot.js.map

package/dist/Slot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Slot.js","sourceRoot":"","sources":["../source/Slot.ts"],"names":[],"mappings":";;;;;;;;;;;;IAAA,yCAAoC;IAEpC,MAAa,IAAI;QAKb,YAAY,UAAe,EAAE,GAAY;YACrC,IAAI,GAAG,IAAI,SAAS,EAAC;gBACjB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAA;gBACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;aACjB;iBAAM;gBACH,IAAI,UAAU,IAAI,GAAG,EAAC;oBAClB,IAAI,CAAC,IAAI,GAAG,mBAAQ,CAAC,CAAC,CAAC;oBACvB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;iBACxB;qBAAM;oBACH,IAAI,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC5D,IAAI,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oBAC5D,QAAQ,IAAI,EAAC;wBACT,KAAK,GAAG;4BACJ,IAAI,CAAC,IAAI,GAAG,mBAAQ,CAAC,CAAC,CAAC;4BACvB,MAAM;wBACV,KAAK,GAAG;4BACJ,IAAI,CAAC,IAAI,GAAG,mBAAQ,CAAC,CAAC,CAAC;4BACvB,MAAM;qBACb;oBACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;iBAClB;aACJ;QACL,CAAC;QAED,OAAO;YACH,OAAO,IAAI,CAAC,IAAI,CAAA;QACpB,CAAC;QAED,MAAM;YACF,OAAO,IAAI,CAAC,GAAG,CAAA;QACnB,CAAC;QAED,QAAQ;YACJ,QAAQ,IAAI,CAAC,IAAI,EAAC;gBACd,KAAK,mBAAQ,CAAC,CAAC;oBACX,OAAO,GAAG,CAAC;gBACf,KAAK,mBAAQ,CAAC,CAAC;oBACX,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;gBAC3B,KAAK,mBAAQ,CAAC,CAAC;oBACX,OAAO,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC;aAC9B;YACD,OAAO,EAAE,CAAC;QACd,CAAC;KAEJ;IAjDD,oBAiDC"}

package/dist/SlotType.d.ts

@@ -0,0 +1,5 @@
+export declare enum SlotType {
+    B = 0,
+    I = 1,
+    O = 2
+}