watson-developer-cloud - npm Package Compare versions

Comparing version 2.22.1 to 2.22.2

package.json

 {
   "name": "watson-developer-cloud",
-  "version": "2.22.1",
+  "version": "2.22.2",
   "description": "Client library to use the IBM Watson Services and AlchemyAPI",
@@ -5,0 +5,0 @@ "main": "./index",

speech-to-text/v1.js

@@ -29,3 +29,3 @@ /**
 const RecognizeStream = require('./recognize_stream');
-const pkg = require('../package.json'); // todo: consider using env properties here instead (to enable webpack support without requiring a plugin)
+const pkg = require('../package.json');
 const util = require('util');
@@ -42,3 +42,3 @@ const BaseService = require('../lib/base_service');
   'model',
-  'content-type',
+  'content-type', // this is accepted in querystring by the service, but methods here all accept content_type and then set a header
   'interim_results',
@@ -133,3 +133,3 @@ 'keywords',
  * @param {object} params - The parameters
- * @param {Audio}  params.audio - Audio to be recognized
+ * @param {Stream}  params.audio - Audio to be recognized
  * @param {string} params.content_type - The Content-type e.g. audio/l16; rate=48000
@@ -140,2 +140,3 @@ * @param {string} params.callback_url - A URL to which callback notifications are to be sent
  * @param {number} [params.results_ttl] - time to alive of the job result
+ * @param {*} [params.*] - all params that .recognize() accepts may also be passed to createRecognitionJob()
  * @param {Function} callback
@@ -163,3 +164,3 @@ * @returns {ReadableStream|undefined}
       },
-      qs: pick(params, ['callback_url', 'event', 'user_token', 'results_ttl']),
+      qs: pick(params, ['callback_url', 'event', 'user_token', 'results_ttl'].concat(PARAMS_ALLOWED)),
       json: true
@@ -183,6 +184,10 @@ },
  *
+ * @param {Object} [params]
  * @param {Function} callback
  * @returns {ReadableStream|undefined}
  */
-SpeechToTextV1.prototype.getRecognitionJobs = function(callback) {
+SpeechToTextV1.prototype.getRecognitionJobs = function(params, callback) {
+  if (!callback && typeof params === 'function') {
+    callback = params;
+  }
   const parameters = {
@@ -260,4 +265,19 @@ options: {
  * @param {Object} params The parameters
- * @param {Audio} [params.audio] - Audio to be recognized
- * @param {String} [params.content_type] - Content-type
+ * @param {Stream} params.audio - Audio to be recognized
+ * @param {String} params.content_type - Content-type
+ * @param {Boolean} [params.continuous],
+ * @param {Number} [params.max_alternatives],
+ * @param {Boolean} [params.timestamps],
+ * @param {Boolean} [params.word_confidence],
+ * @param {Number} [params.inactivity_timeout],
+ * @param {String} [params.model],
+ * @param {Boolean} [params.interim_results],
+ * @param {Boolean} [params.keywords],
+ * @param {Number} [params.keywords_threshold],
+ * @param {Number} [params.word_alternatives_threshold],
+ * @param {Boolean} [params.profanity_filter],
+ * @param {Boolean} [params.smart_formatting],
+ * @param {String} [params.customization_id],
+ * @param {Boolean} [params.speaker_labels]
+ * @param {function} callback
  */
@@ -309,6 +329,8 @@ SpeechToTextV1.prototype.recognize = function(params, callback) {
  *
+ * @deprecated use createRecognizeStream instead
+ *
  * @param {Object} params The parameters
  * @param {String} [params.content_type] - The Content-type e.g. audio/l16; rate=48000
  * @param {String} [params.session_id] - The session id
- * @deprecated use createRecognizeStream instead
+ * @param {function} callback
  */
@@ -371,6 +393,8 @@ SpeechToTextV1.prototype.recognizeLive = function(params, callback) {
  *
+ * @deprecated use createRecognizeStream instead
+ *
  * @param {Object} params The parameters
  * @param {String} [params.session_id] - Session used in the recognition
  * @param {boolean} [params.interim_results] - If true, interim results will be returned. Default: false
- * @deprecated use createRecognizeStream instead
+ * @param {Function} callback
  */
@@ -427,5 +451,7 @@ SpeechToTextV1.prototype.observeResult = function(params, callback) {
  *
+ * @deprecated use createRecognizeStream instead
+ *
  * @param {Object} params The parameters
  * @param {String} [params.session_id] - Session used in the recognition
- * @deprecated use createRecognizeStream instead
+ * @param {Function} callback
  */
@@ -495,2 +521,3 @@ SpeechToTextV1.prototype.getRecognizeStatus = function(params, callback) {
  * @param {string} params.model - The model to use during the session
+ * @param {Function} callback
  */
@@ -534,2 +561,3 @@ SpeechToTextV1.prototype.createSession = function(params, callback) {
  * @param {String} params.session_id - Session id.
+ * @param {Function} callback
  */
@@ -536,0 +564,0 @@ SpeechToTextV1.prototype.deleteSession = function(params, callback) {

No alert changes

Improved metrics

Total package byte prevSize

322964

increased by0.33%

Lines of code

7341

increased by0.38%

No dependency changes