|
| 1 | +/** |
| 2 | +* (C) Copyright IBM Corp. 2018, 2019. |
| 3 | +* |
| 4 | +* Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +* you may not use this file except in compliance with the License. |
| 6 | +* You may obtain a copy of the License at |
| 7 | +* |
| 8 | +* http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +* |
| 10 | +* Unless required by applicable law or agreed to in writing, software |
| 11 | +* distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +* See the License for the specific language governing permissions and |
| 14 | +* limitations under the License. |
| 15 | +* |
| 16 | +*/ |
| 17 | + |
| 18 | +using System.Collections.Generic; |
| 19 | +using Newtonsoft.Json; |
| 20 | + |
| 21 | +namespace IBM.Watson.Assistant.v2.Model |
| 22 | +{ |
| 23 | + /// <summary> |
| 24 | + /// RuntimeResponseGeneric. |
| 25 | + /// </summary> |
| 26 | + public class RuntimeResponseGeneric |
| 27 | + { |
| 28 | + /// <summary> |
| 29 | + /// The type of response returned by the dialog node. The specified response type must be supported by the |
| 30 | + /// client application or channel. |
| 31 | + /// |
| 32 | + /// **Note:** The **suggestion** response type is part of the disambiguation feature, which is only available |
| 33 | + /// for Premium users. |
| 34 | + /// </summary> |
| 35 | + public class ResponseTypeEnumValue |
| 36 | + { |
| 37 | + /// <summary> |
| 38 | + /// Constant TEXT for text |
| 39 | + /// </summary> |
| 40 | + public const string TEXT = "text"; |
| 41 | + /// <summary> |
| 42 | + /// Constant PAUSE for pause |
| 43 | + /// </summary> |
| 44 | + public const string PAUSE = "pause"; |
| 45 | + /// <summary> |
| 46 | + /// Constant IMAGE for image |
| 47 | + /// </summary> |
| 48 | + public const string IMAGE = "image"; |
| 49 | + /// <summary> |
| 50 | + /// Constant OPTION for option |
| 51 | + /// </summary> |
| 52 | + public const string OPTION = "option"; |
| 53 | + /// <summary> |
| 54 | + /// Constant CONNECT_TO_AGENT for connect_to_agent |
| 55 | + /// </summary> |
| 56 | + public const string CONNECT_TO_AGENT = "connect_to_agent"; |
| 57 | + /// <summary> |
| 58 | + /// Constant SUGGESTION for suggestion |
| 59 | + /// </summary> |
| 60 | + public const string SUGGESTION = "suggestion"; |
| 61 | + /// <summary> |
| 62 | + /// Constant SEARCH for search |
| 63 | + /// </summary> |
| 64 | + public const string SEARCH = "search"; |
| 65 | + |
| 66 | + } |
| 67 | + |
| 68 | + /// <summary> |
| 69 | + /// The preferred type of control to display. |
| 70 | + /// </summary> |
| 71 | + public class PreferenceEnumValue |
| 72 | + { |
| 73 | + /// <summary> |
| 74 | + /// Constant DROPDOWN for dropdown |
| 75 | + /// </summary> |
| 76 | + public const string DROPDOWN = "dropdown"; |
| 77 | + /// <summary> |
| 78 | + /// Constant BUTTON for button |
| 79 | + /// </summary> |
| 80 | + public const string BUTTON = "button"; |
| 81 | + |
| 82 | + } |
| 83 | + |
| 84 | + /// <summary> |
| 85 | + /// The type of response returned by the dialog node. The specified response type must be supported by the |
| 86 | + /// client application or channel. |
| 87 | + /// |
| 88 | + /// **Note:** The **suggestion** response type is part of the disambiguation feature, which is only available |
| 89 | + /// for Premium users. |
| 90 | + /// Constants for possible values can be found using RuntimeResponseGeneric.ResponseTypeEnumValue |
| 91 | + /// </summary> |
| 92 | + [JsonProperty("response_type", NullValueHandling = NullValueHandling.Ignore)] |
| 93 | + public string ResponseType { get; set; } |
| 94 | + /// <summary> |
| 95 | + /// The preferred type of control to display. |
| 96 | + /// Constants for possible values can be found using RuntimeResponseGeneric.PreferenceEnumValue |
| 97 | + /// </summary> |
| 98 | + [JsonProperty("preference", NullValueHandling = NullValueHandling.Ignore)] |
| 99 | + public string Preference { get; set; } |
| 100 | + /// <summary> |
| 101 | + /// The text of the response. |
| 102 | + /// </summary> |
| 103 | + [JsonProperty("text", NullValueHandling = NullValueHandling.Ignore)] |
| 104 | + public string Text { get; set; } |
| 105 | + /// <summary> |
| 106 | + /// How long to pause, in milliseconds. |
| 107 | + /// </summary> |
| 108 | + [JsonProperty("time", NullValueHandling = NullValueHandling.Ignore)] |
| 109 | + public long? Time { get; set; } |
| 110 | + /// <summary> |
| 111 | + /// Whether to send a "user is typing" event during the pause. |
| 112 | + /// </summary> |
| 113 | + [JsonProperty("typing", NullValueHandling = NullValueHandling.Ignore)] |
| 114 | + public bool? Typing { get; set; } |
| 115 | + /// <summary> |
| 116 | + /// The URL of the image. |
| 117 | + /// </summary> |
| 118 | + [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] |
| 119 | + public string Source { get; set; } |
| 120 | + /// <summary> |
| 121 | + /// The title or introductory text to show before the response. |
| 122 | + /// </summary> |
| 123 | + [JsonProperty("title", NullValueHandling = NullValueHandling.Ignore)] |
| 124 | + public string Title { get; set; } |
| 125 | + /// <summary> |
| 126 | + /// The description to show with the the response. |
| 127 | + /// </summary> |
| 128 | + [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] |
| 129 | + public string Description { get; set; } |
| 130 | + /// <summary> |
| 131 | + /// An array of objects describing the options from which the user can choose. |
| 132 | + /// </summary> |
| 133 | + [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] |
| 134 | + public List<DialogNodeOutputOptionsElement> Options { get; set; } |
| 135 | + /// <summary> |
| 136 | + /// A message to be sent to the human agent who will be taking over the conversation. |
| 137 | + /// </summary> |
| 138 | + [JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)] |
| 139 | + public string MessageToHumanAgent { get; set; } |
| 140 | + /// <summary> |
| 141 | + /// A label identifying the topic of the conversation, derived from the **user_label** property of the relevant |
| 142 | + /// node. |
| 143 | + /// </summary> |
| 144 | + [JsonProperty("topic", NullValueHandling = NullValueHandling.Ignore)] |
| 145 | + public virtual string Topic { get; private set; } |
| 146 | + /// <summary> |
| 147 | + /// An array of objects describing the possible matching dialog nodes from which the user can choose. |
| 148 | + /// |
| 149 | + /// **Note:** The **suggestions** property is part of the disambiguation feature, which is only available for |
| 150 | + /// Premium users. |
| 151 | + /// </summary> |
| 152 | + [JsonProperty("suggestions", NullValueHandling = NullValueHandling.Ignore)] |
| 153 | + public List<DialogSuggestion> Suggestions { get; set; } |
| 154 | + /// <summary> |
| 155 | + /// The title or introductory text to show before the response. This text is defined in the search skill |
| 156 | + /// configuration. |
| 157 | + /// </summary> |
| 158 | + [JsonProperty("header", NullValueHandling = NullValueHandling.Ignore)] |
| 159 | + public string Header { get; set; } |
| 160 | + /// <summary> |
| 161 | + /// An array of objects containing search results. |
| 162 | + /// </summary> |
| 163 | + [JsonProperty("results", NullValueHandling = NullValueHandling.Ignore)] |
| 164 | + public List<SearchResult> Results { get; set; } |
| 165 | + } |
| 166 | + |
| 167 | +} |
0 commit comments