feat(AssistantV1): add support for runtime entity alternatives

Author: mamoonraja

Scripts/Services/Assistant/V1/AssistantService.cs

@@ -1268,7 +1268,7 @@ private void OnListExamplesResponse(RESTConnector.Request req, RESTConnector.Res
         ///
         /// 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
+        /// 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**.
@@ -3720,7 +3720,7 @@ private void OnListDialogNodesResponse(RESTConnector.Request req, RESTConnector.
         /// <param name="userLabel">A label that can be displayed externally to describe the purpose of the node to
         /// users. (optional)</param>
         /// <param name="disambiguationOptOut">Whether the dialog node should be excluded from disambiguation
-        /// suggestions. (optional, default to false)</param>
+        /// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
         /// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
         /// the response. (optional, default to false)</param>
         /// <returns><see cref="DialogNode" />DialogNode</returns>
@@ -3960,7 +3960,7 @@ private void OnGetDialogNodeResponse(RESTConnector.Request req, RESTConnector.Re
         /// <param name="newUserLabel">A label that can be displayed externally to describe the purpose of the node to
         /// users. (optional)</param>
         /// <param name="newDisambiguationOptOut">Whether the dialog node should be excluded from disambiguation
-        /// suggestions. (optional, default to false)</param>
+        /// suggestions. Valid only when **type**=`standard` or `frame`. (optional, default to false)</param>
         /// <param name="includeAudit">Whether to include the audit properties (`created` and `updated` timestamps) in
         /// the response. (optional, default to false)</param>
         /// <returns><see cref="DialogNode" />DialogNode</returns>
@@ -4416,4 +4416,4 @@ private void OnDeleteUserDataResponse(RESTConnector.Request req, RESTConnector.R
                 ((RequestObject<object>)req).Callback(response, resp.Error);
         }
     }
-}
+}

Scripts/Services/Assistant/V1/Model/DialogNode.cs

@@ -263,7 +263,8 @@ public class DigressOutSlotsValue
         [JsonProperty("user_label", NullValueHandling = NullValueHandling.Ignore)]
         public string UserLabel { get; set; }
         /// <summary>
-        /// 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`.
         /// </summary>
         [JsonProperty("disambiguation_opt_out", NullValueHandling = NullValueHandling.Ignore)]
         public bool? DisambiguationOptOut { get; set; }

Scripts/Services/Assistant/V1/Model/DialogNodeOutputGeneric.cs

@@ -1,5 +1,5 @@
 /**
-* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+* (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -198,15 +198,15 @@ public class QueryTypeValue
         /// 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`.
+        /// documentation](https://cloud.ibm.com/docs/discovery/query-operators.html#query-operators). Required when
+        /// **response_type**=`search_skill`.
         /// </summary>
         [JsonProperty("query", NullValueHandling = NullValueHandling.Ignore)]
         public string Query { get; set; }
         /// <summary>
         /// 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/query-parameters.html#filter).
         /// </summary>
         [JsonProperty("filter", NullValueHandling = NullValueHandling.Ignore)]
         public string Filter { get; set; }

Scripts/Services/Assistant/V1/Model/DialogSuggestionResponseGeneric.cs

@@ -1,5 +1,5 @@
 /**
-* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+* (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -136,14 +136,13 @@ public class PreferenceValue
         [JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)]
         public string MessageToHumanAgent { get; set; }
         /// <summary>
-        /// 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.
         /// </summary>
         [JsonProperty("topic", NullValueHandling = NullValueHandling.Ignore)]
         public virtual string Topic { get; private set; }
         /// <summary>
         /// 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.
         /// </summary>
         [JsonProperty("dialog_node", NullValueHandling = NullValueHandling.Ignore)]
         public string DialogNode { get; set; }

Scripts/Services/Assistant/V1/Model/RuntimeEntity.cs

@@ -66,6 +66,15 @@ public class RuntimeEntity
         [JsonProperty("interpretation", NullValueHandling = NullValueHandling.Ignore)]
         public RuntimeEntityInterpretation Interpretation { get; set; }
         /// <summary>
+        /// 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.
+        /// </summary>
+        [JsonProperty("alternatives", NullValueHandling = NullValueHandling.Ignore)]
+        public List<RuntimeEntityAlternative> Alternatives { get; set; }
+        /// <summary>
         /// 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.

Scripts/Services/Assistant/V1/Model/RuntimeEntityAlternative.cs

@@ -0,0 +1,38 @@
+/**
+* (C) Copyright IBM Corp. 2018, 2020.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.Watson.Assistant.V1.Model
+{
+    /// <summary>
+    /// An alternative value for the recognized entity.
+    /// </summary>
+    public class RuntimeEntityAlternative
+    {
+        /// <summary>
+        /// The entity value that was recognized in the user input.
+        /// </summary>
+        [JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
+        public string Value { get; set; }
+        /// <summary>
+        /// A decimal percentage that represents Watson's confidence in the recognized entity.
+        /// </summary>
+        [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)]
+        public float? Confidence { get; set; }
+    }
+}

Scripts/Services/Assistant/V1/Model/RuntimeEntityAlternative.cs.meta

@@ -1,5 +1,5 @@
 /**
-* Copyright 2018, 2019 IBM Corp. All Rights Reserved.
+* (C) Copyright IBM Corp. 2018, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -134,14 +134,13 @@ public class PreferenceValue
         [JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)]
         public string MessageToHumanAgent { get; set; }
         /// <summary>
-        /// 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.
         /// </summary>
         [JsonProperty("topic", NullValueHandling = NullValueHandling.Ignore)]
         public virtual string Topic { get; private set; }
         /// <summary>
         /// 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.
         /// </summary>
         [JsonProperty("dialog_node", NullValueHandling = NullValueHandling.Ignore)]
         public string DialogNode { get; set; }