Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/nlp-sentencize

Split a string into an array of sentences.
https://github.com/stdlib-js/nlp-sentencize

javascript nlp node node-js nodejs sentence sentences separate split stdlib text-mining tokenizer util utilities utility utils

Last synced: 2 months ago
JSON representation

Split a string into an array of sentences.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# sentencize



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Split a string into an array of sentences.



## Installation



```bash

npm install @stdlib/nlp-sentencize

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var sentencize = require( '@stdlib/nlp-sentencize' );

```



#### sentencize( str )



Splits a string into an array of sentences.



```javascript

var str = 'Hello Mrs. Maple, could you call me back? I need to talk to you about something.';

var out = sentencize( str );

// returns  [ 'Hello Mrs. Maple, could you call me back?', 'I need to talk to you about something.' ]



str = 'As of 2.14.2023, the average price of apples is $1.31 per pound! Inflation has been a strain on the economy.';

out = sentencize( str );

// returns [ 'As of 2.14.2023, the average price of apples is $1.31 per pound!', 'Inflation has been a strain on the economy.' ]

```



## Examples



```javascript

var sentencize = require( '@stdlib/nlp-sentencize' );



var sentences = [

    'Dr. John Smith, Jr. who is a renowned expert in the field of Artificial Intelligence, and who has published numerous papers on the subject, e.g. "Machine Learning for Dummies", "The Future of AI", etc., gave a lecture at the annual AI conference yesterday and stated that AI technology is rapidly advancing, but we must be cautious of its potential consequences such as job displacement, privacy concerns, and ethical dilemmas.',

    'In addition, AI also has many benefits such as improved efficiency and accuracy, and the ability to process large amounts of data.',

    'Dr. Smith emphasized that it is crucial for society to have open and honest discussions about the development and deployment of AI to ensure its responsible and beneficial use for all.',

    'He also stressed the importance of considering the implications and consequences of AI, i.e. it must not be developed or used in a way that is harmful or unethical.',

    'The audience was in agreement, nodding their heads and taking notes throughout the lecture.'

];

var str = sentences.join( ' ' );



var out = sentencize( str );

// returns [...]



var bool = ( out.length === 5 );

// returns true



bool = ( out[ 0 ] === sentences[ 0 ] );

// returns true

```



* * *



## Notice



This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.



For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/nlp-sentencize.svg

[npm-url]: https://npmjs.org/package/@stdlib/nlp-sentencize



[test-image]: https://github.com/stdlib-js/nlp-sentencize/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/nlp-sentencize/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/nlp-sentencize/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/nlp-sentencize?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/nlp-sentencize/tree/deno

[deno-readme]: https://github.com/stdlib-js/nlp-sentencize/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/nlp-sentencize/tree/umd

[umd-readme]: https://github.com/stdlib-js/nlp-sentencize/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/nlp-sentencize/tree/esm

[esm-readme]: https://github.com/stdlib-js/nlp-sentencize/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/nlp-sentencize/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/nlp-sentencize/main/LICENSE