compromise/src/nlp.js

modest natural language processing

import View from './API/View.js'
import tmpWrld from './API/world.js'
import version from './_version.js'
import extend from './API/extend.js'
import { verbose } from './API/_lib.js'
import handleInputs from './API/inputs.js'

let world = Object.assign({}, tmpWrld)

const nlp = function (input, lex) {
  if (lex) {
    nlp.addWords(lex)
  }
  let doc = handleInputs(input, View, world)
  if (input) {
    doc.compute(world.hooks)
  }
  return doc
}
Object.defineProperty(nlp, '_world', {
  value: world,
  writable: true,
})

/** don't run the POS-tagger */
nlp.tokenize = function (input, lex) {
  const { compute } = this._world
  // add user-given words to lexicon
  if (lex) {
    nlp.addWords(lex)
  }
  // run the tokenizer
  let doc = handleInputs(input, View, world)
  // give contractions a shot, at least
  if (compute.contractions) {
    doc.compute(['alias', 'normal', 'machine', 'contractions']) //run it if we've got it
  }
  return doc
}

/** extend compromise functionality */
nlp.plugin = function (plugin) {
  extend(plugin, this._world, View, this)
  return this
}
nlp.extend = nlp.plugin


/** reach-into compromise internals */
nlp.world = function () {
  return this._world
}
nlp.model = function () {
  return this._world.model
}
nlp.methods = function () {
  return this._world.methods
}
nlp.hooks = function () {
  return this._world.hooks
}

/** log the decision-making to console */
nlp.verbose = verbose
/** current library release version */
nlp.version = version

export default nlp