Merge branch 'master' of github.com:watson-developer-cloud/node-sdk into update_dependencies

Author: germanattanasio

CHANGELOG.md

@@ -1,3 +1,18 @@
+# [5.5.0](https://github.com/watson-developer-cloud/node-sdk/compare/v5.4.0...v5.5.0) (2020-04-24)
+
+
+### Bug Fixes
+
+* **discovery-v1:** property `indexed` corrected to `available` for model `EnvironmentDocuments` ([7bc2ccd](https://github.com/watson-developer-cloud/node-sdk/commit/7bc2ccdb303f621068e964bf147672b0c8e0db8e))
+
+
+### Features
+
+* **assistant-v1:** `RuntimeEntityAlternative` model added ([9ad75d7](https://github.com/watson-developer-cloud/node-sdk/commit/9ad75d7cbc94a6f686d72dfe71a7ef6b2188fda9))
+* **assistant-v2:** `MessageContextSkillSystem` model added ([40fd822](https://github.com/watson-developer-cloud/node-sdk/commit/40fd822b668104ab11ba9e6711c7d6c85785c39e))
+* **speech-to-text-v1:** parameters `speechDetectorSensitivity`, `backgroundAudioSuppression`, added to `recognize` ([7c91ea2](https://github.com/watson-developer-cloud/node-sdk/commit/7c91ea2263e9a4c7a1ac47bae9dffefc06082692))
+* **text-to-speech-v1:** new voices and languages added ([dad6e0e](https://github.com/watson-developer-cloud/node-sdk/commit/dad6e0edcd86aeed5815809e7cb685734cb3deb7))
+
 # [5.4.0](https://github.com/watson-developer-cloud/node-sdk/compare/v5.3.1...v5.4.0) (2020-02-13)
 
 
@@ -608,7 +623,7 @@
 * Visual Recognition
   * New method `getCoreMlModel` adds support for CoreML
   * Breaking: `detectFaces` no longer supports identity information in the response.
-    * `name`, `score`, `type_hierarchy` removed from response [Release notes](https://console.bluemix.net/docs/services/visual-recognition/release-notes.html#2april2018)
+    * `name`, `score`, `type_hierarchy` removed from response [Release notes](https://cloud.ibm.com/docs/visual-recognition?topic=visual-recognition-release-notes#2april2018)
 
 * Natural Language Classifier
  * New method 'classifyCollection`

README.md

@@ -165,7 +165,7 @@ Some services use token-based Identity and Access Management (IAM) authenticatio
 
 To use IAM authentication, you must use an `IamAuthenticator` or a `BearerTokenAuthenticator`.
 - Use the `IamAuthenticator` to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
-- Use the `BearerTokenAuthenticator` if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson/getting-started-iam.html). If you want to switch your authenticator, you must override the `authenticator` property directly.
+- Use the `BearerTokenAuthenticator` if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson/getting-started-iam.html). If you want to switch your authenticator, you must override the `authenticator` property directly.
 
 ##### ICP
 
@@ -310,7 +310,7 @@ recognizeStream.getTransactionId().then(
 
 ## Data collection opt-out
 
-By default, [all requests are logged](https://cloud.ibm.com/docs/services/watson/getting-started-logging.html). This can be disabled of by setting the `X-Watson-Learning-Opt-Out` header when creating the service instance:
+By default, [all requests are logged](https://cloud.ibm.com/docs/watson/getting-started-logging.html). This can be disabled of by setting the `X-Watson-Learning-Opt-Out` header when creating the service instance:
 
 ```js
 const myInstance = new watson.WhateverServiceV1({
@@ -411,7 +411,7 @@ The Authorization service can generate auth tokens for situations where providin
 Tokens are valid for 1 hour and may be sent using the `X-Watson-Authorization-Token` header or the `watson-token` query param.
 Note that the token is supplied URL-encoded, and will not be accepted if it is double-encoded in a querystring.
 
-> _NOTE_: Authenticating with the `X-Watson-Authorization-Token` header or the `watson-token` query param is now deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. For details see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson?topic=watson-iam#iam) or the README in the IBM Watson SDK you use.
+> _NOTE_: Authenticating with the `X-Watson-Authorization-Token` header or the `watson-token` query param is now deprecated. The token continues to work with Cloud Foundry services, but is not supported for services that use Identity and Access Management (IAM) authentication. For details see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson?topic=watson-iam#iam) or the README in the IBM Watson SDK you use.
 The Authorization SDK now supports returning IAM Access Tokens when instantiated with an IAM API key.
 
 ```js
@@ -454,7 +454,7 @@ function (err, token) {
 
 Use the [Assistant][assistant] service to determine the intent of a message.
 
-Note: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/services/conversation/index.html#about) for details.
+Note: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-index#about) for details.
 
 ```js
 const AssistantV2 = require('ibm-watson/assistant/v2');
@@ -484,7 +484,7 @@ assistant.message(
 
 Use the [Assistant][assistant] service to determine the intent of a message.
 
-Note: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/services/conversation/index.html#about) for details.
+Note: You must first create a workspace via IBM Cloud. See [the documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-index#about) for details.
 
 ```js
 const AssistantV1 = require('ibm-watson/assistant/v1');
@@ -611,7 +611,7 @@ languageTranslator.identify(
 
 ### Natural Language Classifier
 
-Use [Natural Language Classifier](https://cloud.ibm.com/docs/services/natural-language-classifier/getting-started.html) service to create a classifier instance by providing a set of representative strings and a set of one or more correct classes for each as training. Then use the trained classifier to classify your new question for best matching answers or to retrieve next actions for your application.
+Use [Natural Language Classifier](https://cloud.ibm.com/docs/natural-language-classifier/getting-started.html) service to create a classifier instance by providing a set of representative strings and a set of one or more correct classes for each as training. Then use the trained classifier to classify your new question for best matching answers or to retrieve next actions for your application.
 
 ```js
 const NaturalLanguageClassifierV1 = require('ibm-watson/natural-language-classifier/v1');
@@ -640,8 +640,7 @@ See this [example](https://github.com/watson-developer-cloud/node-sdk/blob/maste
 
 ### Natural Language Understanding
 
-Use Natural Language Understanding is a collection of natural language processing APIs that help you understand sentiment,
- keywords, entities, high-level concepts and more.
+[Natural Language Understanding](https://cloud.ibm.com/docs/services/natural-language-understanding/getting-started.html) is a collection of natural language processing APIs that help you understand sentiment, keywords, entities, high-level concepts and more.
 
 ```js
 const fs = require('fs');

assistant/v1.ts

@@ -1100,7 +1100,7 @@ class AssistantV1 extends BaseService {
    *
    * Add a new user input example to an intent.
    *
-   * If you want to add multiple exaples with a single API call, consider using the **[Update intent](#update-intent)**
+   * If you want to add multiple examples with a single API call, consider using the **[Update intent](#update-intent)**
    * method instead.
    *
    * This operation is limited to 1000 requests per 30 minutes. For more information, see **Rate limiting**.
@@ -3325,7 +3325,7 @@ class AssistantV1 extends BaseService {
    * @param {string} [params.userLabel] - A label that can be displayed externally to describe the purpose of the node
    * to users.
    * @param {boolean} [params.disambiguationOptOut] - Whether the dialog node should be excluded from disambiguation
-   * suggestions.
+   * suggestions. Valid only when **type**=`standard` or `frame`.
    * @param {boolean} [params.includeAudit] - Whether to include the audit properties (`created` and `updated`
    * timestamps) in the response.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -3532,7 +3532,7 @@ class AssistantV1 extends BaseService {
    * @param {string} [params.newUserLabel] - A label that can be displayed externally to describe the purpose of the
    * node to users.
    * @param {boolean} [params.newDisambiguationOptOut] - Whether the dialog node should be excluded from disambiguation
-   * suggestions.
+   * suggestions. Valid only when **type**=`standard` or `frame`.
    * @param {boolean} [params.includeAudit] - Whether to include the audit properties (`created` and `updated`
    * timestamps) in the response.
    * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
@@ -4836,7 +4836,9 @@ namespace AssistantV1 {
     digressOutSlots?: CreateDialogNodeConstants.DigressOutSlots | string;
     /** A label that can be displayed externally to describe the purpose of the node to users. */
     userLabel?: string;
-    /** Whether the dialog node should be excluded from disambiguation suggestions. */
+    /** Whether the dialog node should be excluded from disambiguation suggestions. Valid only when
+     *  **type**=`standard` or `frame`.
+     */
     disambiguationOptOut?: boolean;
     /** Whether to include the audit properties (`created` and `updated` timestamps) in the response. */
     includeAudit?: boolean;
@@ -4949,7 +4951,9 @@ namespace AssistantV1 {
     newDigressOutSlots?: UpdateDialogNodeConstants.DigressOutSlots | string;
     /** A label that can be displayed externally to describe the purpose of the node to users. */
     newUserLabel?: string;
-    /** Whether the dialog node should be excluded from disambiguation suggestions. */
+    /** Whether the dialog node should be excluded from disambiguation suggestions. Valid only when
+     *  **type**=`standard` or `frame`.
+     */
     newDisambiguationOptOut?: boolean;
     /** Whether to include the audit properties (`created` and `updated` timestamps) in the response. */
     includeAudit?: boolean;
@@ -5214,7 +5218,9 @@ namespace AssistantV1 {
     digress_out_slots?: string;
     /** A label that can be displayed externally to describe the purpose of the node to users. */
     user_label?: string;
-    /** Whether the dialog node should be excluded from disambiguation suggestions. */
+    /** Whether the dialog node should be excluded from disambiguation suggestions. Valid only when
+     *  **type**=`standard` or `frame`.
+     */
     disambiguation_opt_out?: boolean;
     /** For internal use only. */
     disabled?: boolean;
@@ -5330,16 +5336,15 @@ namespace AssistantV1 {
     message_to_human_agent?: string;
     /** The text of the search query. This can be either a natural-language query or a query that uses the Discovery
      *  query language syntax, depending on the value of the **query_type** property. For more information, see the
-     *  [Discovery service
-     *  documentation](https://cloud.ibm.com/docs/services/discovery/query-operators.html#query-operators). Required
-     *  when **response_type**=`search_skill`.
+     *  [Discovery service documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-operators#query-operators).
+     *  Required when **response_type**=`search_skill`.
      */
     query?: string;
     /** The type of the search query. Required when **response_type**=`search_skill`. */
     query_type?: string;
     /** An optional filter that narrows the set of documents to be searched. For more information, see the
      *  [Discovery service documentation]([Discovery service
-     *  documentation](https://cloud.ibm.com/docs/services/discovery/query-parameters.html#filter).
+     *  documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-parameters#filter).
      */
     filter?: string;
     /** The version of the Discovery service API to use for the query. */
@@ -5469,12 +5474,10 @@ namespace AssistantV1 {
     options?: DialogNodeOutputOptionsElement[];
     /** A message to be sent to the human agent who will be taking over the conversation. */
     message_to_human_agent?: string;
-    /** A label identifying the topic of the conversation, derived from the **user_label** property of the relevant
-     *  node.
-     */
+    /** A label identifying the topic of the conversation, derived from the **title** property of the relevant node. */
     topic?: string;
     /** The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
-     *  using the value of the dialog node's **user_label** property.
+     *  using the value of the dialog node's **title** property.
      */
     dialog_node?: string;
   }
@@ -5769,13 +5772,28 @@ namespace AssistantV1 {
      *  [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-beta-system-entities).
      */
     interpretation?: RuntimeEntityInterpretation;
+    /** An array of possible alternative values that the user might have intended instead of the value returned in
+     *  the **value** property. This property is returned only for `@sys-time` and `@sys-date` entities when the user's
+     *  input is ambiguous.
+     *
+     *  This property is included only if the new system entities are enabled for the workspace.
+     */
+    alternatives?: RuntimeEntityAlternative[];
     /** An object describing the role played by a system entity that is specifies the beginning or end of a range
      *  recognized in the user input. This property is included only if the new system entities are enabled for the
      *  workspace.
      */
     role?: RuntimeEntityRole;
   }
 
+  /** An alternative value for the recognized entity. */
+  export interface RuntimeEntityAlternative {
+    /** The entity value that was recognized in the user input. */
+    value?: string;
+    /** A decimal percentage that represents Watson's confidence in the recognized entity. */
+    confidence?: number;
+  }
+
   /** RuntimeEntityInterpretation. */
   export interface RuntimeEntityInterpretation {
     /** The calendar used to represent a recognized date (for example, `Gregorian`). */
@@ -5905,12 +5923,10 @@ namespace AssistantV1 {
     options?: DialogNodeOutputOptionsElement[];
     /** A message to be sent to the human agent who will be taking over the conversation. */
     message_to_human_agent?: string;
-    /** A label identifying the topic of the conversation, derived from the **user_label** property of the relevant
-     *  node.
-     */
+    /** A label identifying the topic of the conversation, derived from the **title** property of the relevant node. */
     topic?: string;
     /** The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated
-     *  using the value of the dialog node's **user_label** property.
+     *  using the value of the dialog node's **title** property.
      */
     dialog_node?: string;
     /** An array of objects describing the possible matching dialog nodes from which the user can choose.

assistant/v2.ts

@@ -519,7 +519,7 @@ namespace AssistantV2 {
   export interface MessageContextSkill {
     /** Arbitrary variables that can be read and written by a particular skill. */
     user_defined?: JsonObject;
-    /** For internal use only. */
+    /** System context data used by the skill. */
     system?: JsonObject;
   }
 
@@ -551,8 +551,9 @@ namespace AssistantV2 {
 
   /** Optional properties that control how the assistant responds. */
   export interface MessageInputOptions {
-    /** Whether to return additional diagnostic information. Set to `true` to return additional information under
-     *  the `output.debug` key.
+    /** Whether to return additional diagnostic information. Set to `true` to return additional information in the
+     *  `output.debug` property. If you also specify **return_context**=`true`, the returned skill context includes the
+     *  `system.state` property.
      */
     debug?: boolean;
     /** Whether to restart dialog processing at the root of the dialog, regardless of any previously visited nodes.
@@ -561,10 +562,17 @@ namespace AssistantV2 {
     restart?: boolean;
     /** Whether to return more than one intent. Set to `true` to return all matching intents. */
     alternate_intents?: boolean;
-    /** Whether to return session context with the response. If you specify `true`, the response will include the
-     *  `context` property.
+    /** Whether to return session context with the response. If you specify `true`, the response includes the
+     *  `context` property. If you also specify **debug**=`true`, the returned skill context includes the `system.state`
+     *  property.
      */
     return_context?: boolean;
+    /** Whether to return session context, including full conversation state. If you specify `true`, the response
+     *  includes the `context` property, and the skill context includes the `system.state` property.
+     *
+     *  **Note:** If **export**=`true`, the context is returned regardless of the value of **return_context**.
+     */
+    _export?: boolean;
   }
 
   /** Assistant output to be rendered or processed by the client. */
@@ -607,8 +615,8 @@ namespace AssistantV2 {
   export interface MessageResponse {
     /** Assistant output to be rendered or processed by the client. */
     output: MessageOutput;
-    /** State information for the conversation. The context is stored by the assistant on a per-session basis. You
-     *  can use this property to access context variables.
+    /** Context data for the conversation. The context is stored by the assistant on a per-session basis. You can
+     *  use this property to access context variables.
      *
      *  **Note:** The context is included in message responses only if **return_context**=`true` in the message request.
      */

compare-comply/v1.ts

@@ -735,9 +735,9 @@ class CompareComplyV1 extends BaseService {
    * Run Compare and Comply methods over a collection of input documents.
    *
    * **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
-   * service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
+   * service](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
    * The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch
-   * processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
+   * processing](https://cloud.ibm.com/docs/compare-comply?topic=compare-comply-batching#before-you-batch).
    *
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params._function - The Compare and Comply method to run across the submitted input documents.