add smart_formating param to STT, default to true in helper methods

Author: nfriedly

dist/watson-speech.js

@@ -35,7 +35,7 @@ var WritableElementStream = require('./writable-element-stream');
  * @param {String} options.token - Auth Token - see https://github.com/watson-developer-cloud/node-sdk#authorization
  * @param {Blob|File} options.data - the raw audio data as a Blob or File instance
  * @param {Boolean} [options.play=false] - If a file is set, play it locally as it's being uploaded
- * @param {Boolena} [options.format=true] - pipe the text through a {FormatStream} which performs light formatting
+ * @param {Boolena} [options.format=true] - pipe the text through a {FormatStream} which performs light formatting. Also controls smart_formatting option unless explicitly set.
  * @param {Boolena} [options.realtime=options.play] - pipe the text through a {TimingStream} which slows the output down to real-time to match the audio playback.
  * @param {String|DOMElement} [options.outputElement] pipe the text to a WriteableElementStream targeting the specified element. Also defaults objectMode to true to enable interim results.
  *
@@ -51,6 +51,13 @@ module.exports = function recognizeFile(options) {
     options.objectMode = true;
   }
 
+  // default format to true (capitals and periods)
+  // default smart_formatting to options.format value (dates, currency, etc.)
+  options.format = (options.format !== false);
+  if (typeof options.smart_formatting === 'undefined') {
+    options.smart_formatting = options.format;
+  }
+
   var realtime = options.realtime || typeof options.realtime === 'undefined' && options.play;
 
   // the timing stream requires timestamps to work, so enable them automatically
@@ -68,7 +75,7 @@ module.exports = function recognizeFile(options) {
   var recognizeStream = new RecognizeStream(rsOpts);
   var stream = new BlobStream(options.data).pipe(recognizeStream);
 
-  if (options.format !== false) {
+  if (options.format) {
     stream = stream.pipe(new FormatStream(options));
   }
   if (realtime) {

speech-to-text/recognize-file.js

@@ -43,7 +43,7 @@ var bitBucket = new Writable({
  *
  * @param {Object} options - Also passed to {RecognizeStream}, and {FormatStream} when applicable
  * @param {String} options.token - Auth Token - see https://github.com/watson-developer-cloud/node-sdk#authorization
- * @param {Boolean} [options.format=true] - pipe the text through a {FormatStream} which performs light formatting
+ * @param {Boolean} [options.format=true] - pipe the text through a {FormatStream} which performs light formatting. Also controls smart_formatting option unless explicitly set.
  * @param {Boolean} [options.keepMicrophone=false] - keeps an internal reference to the microphone stream to reuse in subsequent calls (prevents multiple permissions dialogs in firefox)
  * @param {String|DOMElement} [options.outputElement] pipe the text to a WriteableElementStream targeting the specified element. Also defaults objectMode to true to enable interim results.
  *
@@ -59,6 +59,13 @@ module.exports = function recognizeMicrophone(options) {
     options.objectMode = true;
   }
 
+  // default format to true (capitals and periods)
+  // default smart_formatting to options.format value (dates, currency, etc.)
+  options.format = (options.format !== false);
+  if (typeof options.smart_formatting === 'undefined') {
+    options.smart_formatting = options.format;
+  }
+
   // we don't want the readable stream to have objectMode on the input even if we're setting it for the output
   var rsOpts = assign({}, options);
   rsOpts.readableObjectMode = options.objectMode;
@@ -88,7 +95,7 @@ module.exports = function recognizeMicrophone(options) {
   // set up the output first so that we have a place to emit errors
   // if there's trouble with the input stream
   var stream = recognizeStream;
-  if (options.format !== false) {
+  if (options.format) {
     stream = stream.pipe(new FormatStream(options));
     stream.stop = recognizeStream.stop.bind(recognizeStream);
   }

speech-to-text/recognize-microphone.js

@@ -26,7 +26,7 @@ var defaults = require('defaults');
 var qs = require('../util/querystring.js');
 
 var OPENING_MESSAGE_PARAMS_ALLOWED = ['continuous', 'max_alternatives', 'timestamps', 'word_confidence', 'inactivity_timeout',
-  'content-type', 'interim_results', 'keywords', 'keywords_threshold', 'word_alternatives_threshold', 'profanity_filter'];
+  'content-type', 'interim_results', 'keywords', 'keywords_threshold', 'word_alternatives_threshold', 'profanity_filter', 'smart_formatting'];
 
 var QUERY_PARAMS_ALLOWED = ['model', 'watson-token']; // , 'X-Watson-Learning-Opt-Out' - should be allowed but currently isn't due to a service bug
 
@@ -122,6 +122,7 @@ var QUERY_PARAMS_ALLOWED = ['model', 'watson-token']; // , 'X-Watson-Learning-Op
  * @param {Number} [options.inactivity_timeout=30] - how many seconds of silence before automatically closing the stream (even if continuous is true). use -1 for infinity
  * @param {Boolean} [options.readableObjectMode=false] - emit `result` objects instead of string Buffers for the `data` events. Changes several other defaults.
  * @param {Number} [options.X-WDC-PL-OPT-OUT=0] - set to 1 to opt-out of allowing Watson to use this request to improve it's services
+ * @param {Boolean} [options.smart_formatting=false] - formats numeric values such as dates, times, currency, etc.
  *
  * @constructor
  */