-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
Knowledgebases.java
405 lines (351 loc) · 15.4 KB
/
Knowledgebases.java
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
*/
package com.microsoft.azure.cognitiveservices.knowledge.qnamaker;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.DownloadOptionalParameter;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.TrainOptionalParameter;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseUpdateHeaders;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.Operation;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.QnADTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO;
import com.microsoft.azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO;
import java.io.IOException;
import java.util.List;
import rx.Observable;
/**
* An instance of this class provides access to all the operations defined
* in Knowledgebases.
*/
public interface Knowledgebases {
/**
* Gets all knowledgebases for a user.
*
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the KnowledgebasesDTO object if successful.
*/
KnowledgebasesDTO listAll();
/**
* Gets all knowledgebases for a user.
*
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the KnowledgebasesDTO object
*/
Observable<KnowledgebasesDTO> listAllAsync();
/**
* Gets details of a specific knowledgebase.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the KnowledgebaseDTO object if successful.
*/
KnowledgebaseDTO getDetails(String kbId);
/**
* Gets details of a specific knowledgebase.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the KnowledgebaseDTO object
*/
Observable<KnowledgebaseDTO> getDetailsAsync(String kbId);
/**
* Deletes the knowledgebase and all its data.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
*/
void delete(String kbId);
/**
* Deletes the knowledgebase and all its data.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return a representation of the deferred computation of this call if successful.
*/
Observable<Void> deleteAsync(String kbId);
/**
* Publishes all changes in test index of a knowledgebase to its prod index.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
*/
void publish(String kbId);
/**
* Publishes all changes in test index of a knowledgebase to its prod index.
*
* @param kbId Knowledgebase id.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return a representation of the deferred computation of this call if successful.
*/
Observable<Void> publishAsync(String kbId);
/**
* Replace knowledgebase contents.
*
* @param kbId Knowledgebase id.
* @param qnAList List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and
* should be omitted.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
*/
void replace(String kbId, List<QnADTO> qnAList);
/**
* Replace knowledgebase contents.
*
* @param kbId Knowledgebase id.
* @param qnAList List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and
* should be omitted.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return a representation of the deferred computation of this call if successful.
*/
Observable<Void> replaceAsync(String kbId, List<QnADTO> qnAList);
/**
* Asynchronous operation to modify a knowledgebase.
*
* @param kbId Knowledgebase id.
* @param updateKb Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the Operation object if successful.
*/
Operation update(String kbId, UpdateKbOperationDTO updateKb);
/**
* Asynchronous operation to modify a knowledgebase.
*
* @param kbId Knowledgebase id.
* @param updateKb Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the Operation object
*/
Observable<Operation> updateAsync(String kbId, UpdateKbOperationDTO updateKb);
/**
* Asynchronous operation to create a new knowledgebase.
*
* @param createKbPayload Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the Operation object if successful.
*/
Operation create(CreateKbDTO createKbPayload);
/**
* Asynchronous operation to create a new knowledgebase.
*
* @param createKbPayload Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the Operation object
*/
Observable<Operation> createAsync(CreateKbDTO createKbPayload);
/**
* Download the knowledgebase.
*
* @param kbId Knowledgebase id.
* @param environment Specifies whether environment is Test or Prod. Possible values include: 'Prod', 'Test'.
* @param downloadOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the QnADocumentsDTO object if successful.
*/
QnADocumentsDTO download(String kbId, EnvironmentType environment, DownloadOptionalParameter downloadOptionalParameter);
/**
* Download the knowledgebase.
*
* @param kbId Knowledgebase id.
* @param environment Specifies whether environment is Test or Prod. Possible values include: 'Prod', 'Test'.
* @param downloadOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the QnADocumentsDTO object
*/
Observable<QnADocumentsDTO> downloadAsync(String kbId, EnvironmentType environment, DownloadOptionalParameter downloadOptionalParameter);
/**
* Download the knowledgebase.
*
* @return the first stage of the download call
*/
KnowledgebasesDownloadDefinitionStages.WithKbId download();
/**
* Grouping of download definition stages.
*/
interface KnowledgebasesDownloadDefinitionStages {
/**
* The stage of the definition to be specify kbId.
*/
interface WithKbId {
/**
* Knowledgebase id.
*
* @return next definition stage
*/
WithEnvironment withKbId(String kbId);
}
/**
* The stage of the definition to be specify environment.
*/
interface WithEnvironment {
/**
* Specifies whether environment is Test or Prod. Possible values include: 'Prod', 'Test'.
*
* @return next definition stage
*/
KnowledgebasesDownloadDefinitionStages.WithExecute withEnvironment(EnvironmentType environment);
}
/**
* The stage of the definition which allows for any other optional settings to be specified.
*/
interface WithAllOptions {
/**
* The source property filter to apply.
*
* @return next definition stage
*/
KnowledgebasesDownloadDefinitionStages.WithExecute withSource(String source);
/**
* The last changed status property filter to apply.
*
* @return next definition stage
*/
KnowledgebasesDownloadDefinitionStages.WithExecute withChangedSince(String changedSince);
}
/**
* The last stage of the definition which will make the operation call.
*/
interface WithExecute extends KnowledgebasesDownloadDefinitionStages.WithAllOptions {
/**
* Execute the request.
*
* @return the QnADocumentsDTO object if successful.
*/
QnADocumentsDTO execute();
/**
* Execute the request asynchronously.
*
* @return the observable to the QnADocumentsDTO object
*/
Observable<QnADocumentsDTO> executeAsync();
}
}
/**
* The entirety of download definition.
*/
interface KnowledgebasesDownloadDefinition extends
KnowledgebasesDownloadDefinitionStages.WithKbId,
KnowledgebasesDownloadDefinitionStages.WithEnvironment,
KnowledgebasesDownloadDefinitionStages.WithExecute {
}
/**
* GenerateAnswer call to query knowledgebase (QnA Maker Managed).
*
* @param kbId Knowledgebase id.
* @param generateAnswerPayload Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the QnASearchResultList object if successful.
*/
QnASearchResultList generateAnswer(String kbId, QueryDTO generateAnswerPayload);
/**
* GenerateAnswer call to query knowledgebase (QnA Maker Managed).
*
* @param kbId Knowledgebase id.
* @param generateAnswerPayload Post body of the request.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the QnASearchResultList object
*/
Observable<QnASearchResultList> generateAnswerAsync(String kbId, QueryDTO generateAnswerPayload);
/**
* Train call to add suggestions to knowledgebase (QnAMaker Managed).
*
* @param kbId Knowledgebase id.
* @param trainOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
*/
void train(String kbId, TrainOptionalParameter trainOptionalParameter);
/**
* Train call to add suggestions to knowledgebase (QnAMaker Managed).
*
* @param kbId Knowledgebase id.
* @param trainOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return a representation of the deferred computation of this call if successful.
*/
Observable<Void> trainAsync(String kbId, TrainOptionalParameter trainOptionalParameter);
/**
* Train call to add suggestions to knowledgebase (QnAMaker Managed).
*
* @return the first stage of the train call
*/
KnowledgebasesTrainDefinitionStages.WithKbId train();
/**
* Grouping of train definition stages.
*/
interface KnowledgebasesTrainDefinitionStages {
/**
* The stage of the definition to be specify kbId.
*/
interface WithKbId {
/**
* Knowledgebase id.
*
* @return next definition stage
*/
KnowledgebasesTrainDefinitionStages.WithExecute withKbId(String kbId);
}
/**
* The stage of the definition which allows for any other optional settings to be specified.
*/
interface WithAllOptions {
/**
* List of feedback records.
*
* @return next definition stage
*/
KnowledgebasesTrainDefinitionStages.WithExecute withFeedbackRecords(List<FeedbackRecordDTO> feedbackRecords);
}
/**
* The last stage of the definition which will make the operation call.
*/
interface WithExecute extends KnowledgebasesTrainDefinitionStages.WithAllOptions {
/**
* Execute the request.
*
*/
void execute();
/**
* Execute the request asynchronously.
*
* @return a representation of the deferred computation of this call if successful.
*/
Observable<Void> executeAsync();
}
}
/**
* The entirety of train definition.
*/
interface KnowledgebasesTrainDefinition extends
KnowledgebasesTrainDefinitionStages.WithKbId,
KnowledgebasesTrainDefinitionStages.WithExecute {
}
}