-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
Knowledgebases.java
209 lines (174 loc) · 8.1 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
/**
* 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.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.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.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'.
* @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);
/**
* Download the knowledgebase.
*
* @param kbId Knowledgebase id.
* @param environment Specifies whether environment is Test or Prod. Possible values include: 'Prod', 'Test'.
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the QnADocumentsDTO object
*/
Observable<QnADocumentsDTO> downloadAsync(String kbId, EnvironmentType environment);
}