/compromise

natural language processing, in javascript

Primary LanguageJavaScriptMIT LicenseMIT

natural language processing, in javascript
by Spencer Kelly and many contributors

var nlp = require('compromise')

nlp('Wee-ooh, I look just like buddy holly.').sentences().toPastTense()
// 'Wee-ooh, I looked just like buddy holly.'

nlp('..then consider me Miles Davis!').people().out('freq')
// [{ text:'Miles Davis', count:1 }]
210kb
        one javascript file        
86%
    on the Penn treebank    
🙏
    npm install compromise    
IE9+
      caniuse, youbetcha      
a least-fancy way to handle text,

Text in → data out.

without training, jargon or config

Demos       Usage       API       WTF

⚡️ on the Client-side

<script src="https://unpkg.com/compromise@latest/builds/compromise.min.js"></script>
<script>
  var doc = nlp('dinosaur')

  var str = doc.nouns().toPlural().out('text')
  console.log(str)
  // 'dinosaurs'
</script>

🌋 Server-side!

var nlp = require('compromise')

var doc = nlp('London is calling')
doc.sentences().toNegative()
// 'London is not calling'
nouns! verbs! adjectives!
people, places, organizations
seven hundred and fifty == 750
like a regex for a sentence
all your base are belong
contractions, style, mood..

pop right in:
var doc= nlp(myNovel) //whoosh
doc.match('the #Superlative of times').length
API is bearable:
doc.contractions().expand()
doc.people().lastNames()
loosely-held opinions..
var ayeRight= require('nlp-scottish-slang')
nlp.plugin(ayeRight)
nlp('Taps aff, high doh!')

no foolin,
6 years, 150 PRs, 60 devs
in production in the United Nations🎈

Throw in text,

even if it's just one word:

var doc = nlp('Ludwig van Beethoven')
doc.match('#TitleCase van #LastName').out()
// 'Ludwig van Beethoven'

doc.people().out('list')
// ['ludwig van beethoven']

    Move stuff around:

doc = nlp('a bottle of beer on the wall.')
doc.nouns().first().toPlural()
doc.out('text')
//'The bottles of beer on the wall.'
doc = nlp('ninety five thousand and fifty two')
doc.values().toNumber().out('text')
// '95052'

doc = nlp('the 23rd of December')
doc.values().add(2).toText()
doc.out('text')
// 'the twenty fifth of December'
doc = nlp("the guest-singer's björk   at seven thirty.").normalize().out('text')
// 'The guest singer is Bjork at 7:30.'
  • Tense: - switch between conjugations of any verb
let doc = nlp('she sells seashells by the seashore.')
doc.sentences().toFutureTense().out('text')
//'she will sell seashells...'

doc.verbs().conjugate()
// [{ PastTense: 'sold',
//    Infinitive: 'sell',
//    Gerund: 'selling', ...
// }]
doc = nlp("we're not gonna take it, no we ain't gonna take it.")
doc.has('going') // true
doc.match('are not').length // == 2
doc.contractions().expand().out()
//'we are not going to take it, no we are not going to take it'
doc = nlp('that opera about richard nixon visiting china')
doc.topics().data()
// [
//   { text: 'richard nixon' },
//   { text: 'china' }
// ]
var lexicon={
  'boston': 'MusicalGroup'
}
doc = nlp('i heard Boston\'s set in Chicago', lexicon)

//alternatively, fix it all 'in-post':
doc.match('heard #Possessive set').terms(1).tag('MusicalGroup')
doc = nlp('We like Roy! We like Roy!').sentences().out('array')
// ['We like Roy!', 'We like Roy!']

doc = nlp('Tony Hawk').out('html')
/*
<span>
  <span class="nl-Person nl-FirstName">Tony</span>
  <span>&nbsp;</span>
  <span class="nl-Person nl-LastName">Hawk</span>
</span>
*/

of course, there's a lot more stuff.

Join in - we're fun, using semver, and moving fast:

        Twitter        
      Slack group      
      Mailing-list      
        Projects        
      Pull-requests      

    ☂️ Isn't javascript too...

      yeah!
      it wasn't built to compete with the stanford tagger, and may not fit every project.
      string stuff is synchronous too, and parallelizing is weird.
      See here for information about speed & performance, and here> for project motivations

    💃 Can it run on my arduino-watch?

      Only if it's water-proof!
      Read quickStart for all sorts of funny environments.

    🌎 Other Languages?

      okay! we've got work-in-progress forks for German and French, in the same philosophy.
      Get involved!

    ✨ Partial builds?

      compromise can't really be tree-shaken, because it's one function.
      .. and the tagging methods are competitive, so it's not recommended to pull things out.
      It's best to load the library fully, given it's smaller than this gif.
      A plug-in scheme is in the works.


Don't forget about:

For the former promise-library, see jnewman/compromise (Thanks Joshua!)

(also don't forget 🙇 NLTK, GATE, Stanford, and Illinois toolkit )