-
Notifications
You must be signed in to change notification settings - Fork 124
/
DialogNodeOutputGeneric.cs
230 lines (218 loc) · 10.9 KB
/
DialogNodeOutputGeneric.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/**
* (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 System.Collections.Generic;
using JsonSubTypes;
using Newtonsoft.Json;
namespace IBM.Watson.Assistant.v1.Model
{
/// <summary>
/// DialogNodeOutputGeneric.
/// Classes which extend this class:
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeText
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypePause
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeImage
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeOption
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill
/// </summary>
[JsonConverter(typeof(JsonSubtypes), "response_type")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent), "connect_to_agent")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypeImage), "image")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypeOption), "option")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypePause), "pause")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill), "search_skill")]
[JsonSubtypes.KnownSubType(typeof(DialogNodeOutputGenericDialogNodeOutputResponseTypeText), "text")]
public class DialogNodeOutputGeneric
{
/// This ctor is protected to prevent instantiation of this base class.
/// Instead, users should instantiate one of the subclasses listed below:
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeText
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypePause
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeImage
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeOption
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent
/// - DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill
protected DialogNodeOutputGeneric()
{
}
/// <summary>
/// The type of response returned by the dialog node. The specified response type must be supported by the
/// client application or channel.
/// </summary>
public class ResponseTypeEnumValue
{
/// <summary>
/// Constant TEXT for text
/// </summary>
public const string TEXT = "text";
}
/// <summary>
/// How a response is selected from the list, if more than one response is specified.
/// </summary>
public class SelectionPolicyEnumValue
{
/// <summary>
/// Constant SEQUENTIAL for sequential
/// </summary>
public const string SEQUENTIAL = "sequential";
/// <summary>
/// Constant RANDOM for random
/// </summary>
public const string RANDOM = "random";
/// <summary>
/// Constant MULTILINE for multiline
/// </summary>
public const string MULTILINE = "multiline";
}
/// <summary>
/// The preferred type of control to display, if supported by the channel.
/// </summary>
public class PreferenceEnumValue
{
/// <summary>
/// Constant DROPDOWN for dropdown
/// </summary>
public const string DROPDOWN = "dropdown";
/// <summary>
/// Constant BUTTON for button
/// </summary>
public const string BUTTON = "button";
}
/// <summary>
/// The type of the search query.
/// </summary>
public class QueryTypeEnumValue
{
/// <summary>
/// Constant NATURAL_LANGUAGE for natural_language
/// </summary>
public const string NATURAL_LANGUAGE = "natural_language";
/// <summary>
/// Constant DISCOVERY_QUERY_LANGUAGE for discovery_query_language
/// </summary>
public const string DISCOVERY_QUERY_LANGUAGE = "discovery_query_language";
}
/// <summary>
/// The type of response returned by the dialog node. The specified response type must be supported by the
/// client application or channel.
/// Constants for possible values can be found using DialogNodeOutputGeneric.ResponseTypeEnumValue
/// </summary>
[JsonProperty("response_type", NullValueHandling = NullValueHandling.Ignore)]
public string ResponseType { get; set; }
/// <summary>
/// How a response is selected from the list, if more than one response is specified.
/// Constants for possible values can be found using DialogNodeOutputGeneric.SelectionPolicyEnumValue
/// </summary>
[JsonProperty("selection_policy", NullValueHandling = NullValueHandling.Ignore)]
public string SelectionPolicy { get; set; }
/// <summary>
/// The preferred type of control to display, if supported by the channel.
/// Constants for possible values can be found using DialogNodeOutputGeneric.PreferenceEnumValue
/// </summary>
[JsonProperty("preference", NullValueHandling = NullValueHandling.Ignore)]
public string Preference { get; set; }
/// <summary>
/// The type of the search query.
/// Constants for possible values can be found using DialogNodeOutputGeneric.QueryTypeEnumValue
/// </summary>
[JsonProperty("query_type", NullValueHandling = NullValueHandling.Ignore)]
public string QueryType { get; set; }
/// <summary>
/// A list of one or more objects defining text responses.
/// </summary>
[JsonProperty("values", NullValueHandling = NullValueHandling.Ignore)]
public List<DialogNodeOutputTextValuesElement> Values { get; protected set; }
/// <summary>
/// The delimiter to use as a separator between responses when `selection_policy`=`multiline`.
/// </summary>
[JsonProperty("delimiter", NullValueHandling = NullValueHandling.Ignore)]
public string Delimiter { get; protected set; }
/// <summary>
/// How long to pause, in milliseconds. The valid values are from 0 to 10000.
/// </summary>
[JsonProperty("time", NullValueHandling = NullValueHandling.Ignore)]
public long? Time { get; protected set; }
/// <summary>
/// Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this
/// event.
/// </summary>
[JsonProperty("typing", NullValueHandling = NullValueHandling.Ignore)]
public bool? Typing { get; protected set; }
/// <summary>
/// The URL of the image.
/// </summary>
[JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)]
public string Source { get; protected set; }
/// <summary>
/// An optional title to show before the response.
/// </summary>
[JsonProperty("title", NullValueHandling = NullValueHandling.Ignore)]
public string Title { get; protected set; }
/// <summary>
/// An optional description to show with the response.
/// </summary>
[JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)]
public string Description { get; protected set; }
/// <summary>
/// An array of objects describing the options from which the user can choose. You can include up to 20 options.
/// </summary>
[JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)]
public List<DialogNodeOutputOptionsElement> Options { get; protected set; }
/// <summary>
/// An optional message to be sent to the human agent who will be taking over the conversation.
/// </summary>
[JsonProperty("message_to_human_agent", NullValueHandling = NullValueHandling.Ignore)]
public string MessageToHumanAgent { get; protected set; }
/// <summary>
/// An optional message to be displayed to the user to indicate that the conversation will be transferred to the
/// next available agent.
/// </summary>
[JsonProperty("agent_available", NullValueHandling = NullValueHandling.Ignore)]
public string AgentAvailable { get; protected set; }
/// <summary>
/// An optional message to be displayed to the user to indicate that no online agent is available to take over
/// the conversation.
/// </summary>
[JsonProperty("agent_unavailable", NullValueHandling = NullValueHandling.Ignore)]
public string AgentUnavailable { get; protected set; }
/// <summary>
/// Routing or other contextual information to be used by target service desk systems.
/// </summary>
[JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)]
public DialogNodeOutputConnectToAgentTransferInfo TransferInfo { get; protected set; }
/// <summary>
/// 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/discovery?topic=discovery-query-operators#query-operators).
/// </summary>
[JsonProperty("query", NullValueHandling = NullValueHandling.Ignore)]
public string Query { get; protected 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/discovery?topic=discovery-query-parameters#filter).
/// </summary>
[JsonProperty("filter", NullValueHandling = NullValueHandling.Ignore)]
public string Filter { get; protected set; }
/// <summary>
/// The version of the Discovery service API to use for the query.
/// </summary>
[JsonProperty("discovery_version", NullValueHandling = NullValueHandling.Ignore)]
public string DiscoveryVersion { get; protected set; }
}
}