Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

verbose-utterance

Truemedia21ISC1.1.0

Interprete/compile *.utter files for creating a verbose library of utterances

verbose, utterance, nlp, language, sentence, file, format

readme

Verbose Utterance

Interprete/compile files with the .utter extension for creating a verbose library of utterances.

See samples folder for example files that can be used.

Installation

NPM

    npm i --save verbose-utterance

Yarn

    yarn add verbose-utterance

Usage

Node

    const verboseUtterance = require('verbose-utterance');
    verboseUtterance('filename.utter').then( (utterances) => {
        console.log('results', utterances);
    });

ES6+

    import verboseUtterance from 'verbose-utterance';
    verboseUtterance('filename.utter').then( (utterances) => {
        console.log('results', utterances);
    });

Current features

Future features (not yet implemented)

Coverage strategy (Synset)

Using wordnet which has words group by synonyms with a key called a synset, it is possible to target words using a synset in an expression rather than a word.

Expanding all the possible words with the same meaning eliminates the possibility of a user using a phrase they would expect to be a valid utterance and being disappointed by it not being supported.

Verbose strategy (Word emition)

By using a stopword synonym prefixed with a pipe, the compiled utterances will contains extracts with and without stopwords which will increase the chances of matching someone who speaks in a verbose manner.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.1.0] - 2018-10-21

Added

  • This changelog
  • Lexicon support