Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parmentf/node-sentence-tokenizer
Tokenize paragraphs into sentences, and smaller tokens.
https://github.com/parmentf/node-sentence-tokenizer
Last synced: 3 months ago
JSON representation
Tokenize paragraphs into sentences, and smaller tokens.
- Host: GitHub
- URL: https://github.com/parmentf/node-sentence-tokenizer
- Owner: parmentf
- Created: 2012-12-27T18:25:04.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2023-07-02T18:43:36.000Z (over 1 year ago)
- Last Synced: 2024-08-19T06:25:40.321Z (3 months ago)
- Language: JavaScript
- Size: 159 KB
- Stars: 47
- Watchers: 5
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sentence Tokenizer [](http://travis-ci.org/parmentf/node-sentence-tokenizer) [](http://badge.fury.io/js/sentence-tokenizer)
Tokenize paragraphs into sentences, and smaller tokens.
## Installation
Use [npm](http://npmjs.org):
```bash
npm install sentence-tokenizer
```
## How to
Require the module:
```js
var Tokenizer = require('sentence-tokenizer');
```
Instanciate a tokenizer, with the name of the utterer:
```js
var tokenizer = new Tokenizer('Chuck');
```
Set the entry to work on:
```js
tokenizer.setEntry("This is an entry. Possibly composed of several sentences.");
```
Get the sentences:
```js
console.log(tokenizer.getSentences());
```
Which should produce:
```js
[ 'This is an entry.',
'Possibly composed of several sentences.' ]
```
If you want word-level tokens, use:
```js
console.log(tokenizer.getTokens());
```
Yielding:
```js
[ 'This',
'is',
'an',
'entry.' ]
```
To get the second sentence, use:
```js
console.log(tokenizer.getTokens(1));
```
## Warning
As this package is made for a [conversational bot](https://github.com/parmentf/node-ector), the Tokenizer class get two parameters (`username` and `botname`), which have default values (`Guy`, and `ECTOR`).
When these are present in the entry, they are replaced with `{botname}` and `{yourname}` respectively.
If you don't want to use this functionality, pass two unlikely parameters (`kjsdfgiurbybuq`, for example).
## Also
* [https://github.com/chrisumbel/natural](https://github.com/chrisumbel/natural)
* [https://github.com/Floby/node-tokenizer](https://github.com/Floby/node-tokenizer)
## License
(The MIT License)
Copyright 2012 François Parmentier. All rights reserved.
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.