@aws-sdk/client-wisdom 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/dist-types/Wisdom.d.ts +34 -2
  2. package/dist-types/WisdomClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAssistantCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateContentCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateSessionCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteAssistantCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteContentCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +16 -0
  12. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +16 -0
  13. package/dist-types/commands/GetAssistantCommand.d.ts +16 -0
  14. package/dist-types/commands/GetContentCommand.d.ts +16 -0
  15. package/dist-types/commands/GetContentSummaryCommand.d.ts +16 -0
  16. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +16 -0
  17. package/dist-types/commands/GetRecommendationsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetSessionCommand.d.ts +16 -0
  19. package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListAssistantsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListContentsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +16 -0
  25. package/dist-types/commands/QueryAssistantCommand.d.ts +16 -0
  26. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +16 -0
  27. package/dist-types/commands/SearchContentCommand.d.ts +16 -0
  28. package/dist-types/commands/SearchSessionsCommand.d.ts +16 -0
  29. package/dist-types/commands/StartContentUploadCommand.d.ts +16 -0
  30. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateContentCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +18 -2
  34. package/dist-types/models/WisdomServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +271 -1
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/dist-types/pagination/ListAssistantAssociationsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListAssistantsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListContentsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/QueryAssistantPaginator.d.ts +3 -0
  42. package/dist-types/pagination/SearchContentPaginator.d.ts +3 -0
  43. package/dist-types/pagination/SearchSessionsPaginator.d.ts +3 -0
  44. package/package.json +29 -29
@@ -32,6 +32,7 @@ import { UpdateContentCommandInput, UpdateContentCommandOutput } from "./command
32
32
  import { UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput } from "./commands/UpdateKnowledgeBaseTemplateUriCommand";
33
33
  import { WisdomClient } from "./WisdomClient";
34
34
  /**
35
+ * @public
35
36
  * <p>Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're
36
37
  * actively speaking with customers. Agents can search across connected repositories from within
37
38
  * their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a
@@ -39,12 +40,14 @@ import { WisdomClient } from "./WisdomClient";
39
40
  */
40
41
  export declare class Wisdom extends WisdomClient {
41
42
  /**
43
+ * @public
42
44
  * <p>Creates an Amazon Connect Wisdom assistant.</p>
43
45
  */
44
46
  createAssistant(args: CreateAssistantCommandInput, options?: __HttpHandlerOptions): Promise<CreateAssistantCommandOutput>;
45
47
  createAssistant(args: CreateAssistantCommandInput, cb: (err: any, data?: CreateAssistantCommandOutput) => void): void;
46
48
  createAssistant(args: CreateAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssistantCommandOutput) => void): void;
47
49
  /**
50
+ * @public
48
51
  * <p>Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the
49
52
  * only supported association is with a knowledge base. An assistant can have only a single
50
53
  * association.</p>
@@ -53,6 +56,7 @@ export declare class Wisdom extends WisdomClient {
53
56
  createAssistantAssociation(args: CreateAssistantAssociationCommandInput, cb: (err: any, data?: CreateAssistantAssociationCommandOutput) => void): void;
54
57
  createAssistantAssociation(args: CreateAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssistantAssociationCommandOutput) => void): void;
55
58
  /**
59
+ * @public
56
60
  * <p>Creates Wisdom content. Before to calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to
57
61
  * upload an asset.</p>
58
62
  */
@@ -60,6 +64,7 @@ export declare class Wisdom extends WisdomClient {
60
64
  createContent(args: CreateContentCommandInput, cb: (err: any, data?: CreateContentCommandOutput) => void): void;
61
65
  createContent(args: CreateContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateContentCommandOutput) => void): void;
62
66
  /**
67
+ * @public
63
68
  * <p>Creates a knowledge base.</p>
64
69
  * <note>
65
70
  * <p>When using this API, you cannot reuse <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a>
@@ -89,6 +94,7 @@ export declare class Wisdom extends WisdomClient {
89
94
  createKnowledgeBase(args: CreateKnowledgeBaseCommandInput, cb: (err: any, data?: CreateKnowledgeBaseCommandOutput) => void): void;
90
95
  createKnowledgeBase(args: CreateKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKnowledgeBaseCommandOutput) => void): void;
91
96
  /**
97
+ * @public
92
98
  * <p>Creates a session. A session is a contextual container used for generating
93
99
  * recommendations. Amazon Connect creates a new Wisdom session for each contact on which
94
100
  * Wisdom is enabled.</p>
@@ -97,24 +103,28 @@ export declare class Wisdom extends WisdomClient {
97
103
  createSession(args: CreateSessionCommandInput, cb: (err: any, data?: CreateSessionCommandOutput) => void): void;
98
104
  createSession(args: CreateSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateSessionCommandOutput) => void): void;
99
105
  /**
106
+ * @public
100
107
  * <p>Deletes an assistant.</p>
101
108
  */
102
109
  deleteAssistant(args: DeleteAssistantCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssistantCommandOutput>;
103
110
  deleteAssistant(args: DeleteAssistantCommandInput, cb: (err: any, data?: DeleteAssistantCommandOutput) => void): void;
104
111
  deleteAssistant(args: DeleteAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssistantCommandOutput) => void): void;
105
112
  /**
113
+ * @public
106
114
  * <p>Deletes an assistant association.</p>
107
115
  */
108
116
  deleteAssistantAssociation(args: DeleteAssistantAssociationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssistantAssociationCommandOutput>;
109
117
  deleteAssistantAssociation(args: DeleteAssistantAssociationCommandInput, cb: (err: any, data?: DeleteAssistantAssociationCommandOutput) => void): void;
110
118
  deleteAssistantAssociation(args: DeleteAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssistantAssociationCommandOutput) => void): void;
111
119
  /**
120
+ * @public
112
121
  * <p>Deletes the content.</p>
113
122
  */
114
123
  deleteContent(args: DeleteContentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteContentCommandOutput>;
115
124
  deleteContent(args: DeleteContentCommandInput, cb: (err: any, data?: DeleteContentCommandOutput) => void): void;
116
125
  deleteContent(args: DeleteContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteContentCommandOutput) => void): void;
117
126
  /**
127
+ * @public
118
128
  * <p>Deletes the knowledge base.</p>
119
129
  * <note>
120
130
  * <p>When you use this API to delete an external knowledge base such as Salesforce or
@@ -129,36 +139,42 @@ export declare class Wisdom extends WisdomClient {
129
139
  deleteKnowledgeBase(args: DeleteKnowledgeBaseCommandInput, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void): void;
130
140
  deleteKnowledgeBase(args: DeleteKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void): void;
131
141
  /**
142
+ * @public
132
143
  * <p>Retrieves information about an assistant.</p>
133
144
  */
134
145
  getAssistant(args: GetAssistantCommandInput, options?: __HttpHandlerOptions): Promise<GetAssistantCommandOutput>;
135
146
  getAssistant(args: GetAssistantCommandInput, cb: (err: any, data?: GetAssistantCommandOutput) => void): void;
136
147
  getAssistant(args: GetAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssistantCommandOutput) => void): void;
137
148
  /**
149
+ * @public
138
150
  * <p>Retrieves information about an assistant association.</p>
139
151
  */
140
152
  getAssistantAssociation(args: GetAssistantAssociationCommandInput, options?: __HttpHandlerOptions): Promise<GetAssistantAssociationCommandOutput>;
141
153
  getAssistantAssociation(args: GetAssistantAssociationCommandInput, cb: (err: any, data?: GetAssistantAssociationCommandOutput) => void): void;
142
154
  getAssistantAssociation(args: GetAssistantAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAssistantAssociationCommandOutput) => void): void;
143
155
  /**
156
+ * @public
144
157
  * <p>Retrieves content, including a pre-signed URL to download the content.</p>
145
158
  */
146
159
  getContent(args: GetContentCommandInput, options?: __HttpHandlerOptions): Promise<GetContentCommandOutput>;
147
160
  getContent(args: GetContentCommandInput, cb: (err: any, data?: GetContentCommandOutput) => void): void;
148
161
  getContent(args: GetContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentCommandOutput) => void): void;
149
162
  /**
163
+ * @public
150
164
  * <p>Retrieves summary information about the content.</p>
151
165
  */
152
166
  getContentSummary(args: GetContentSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetContentSummaryCommandOutput>;
153
167
  getContentSummary(args: GetContentSummaryCommandInput, cb: (err: any, data?: GetContentSummaryCommandOutput) => void): void;
154
168
  getContentSummary(args: GetContentSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentSummaryCommandOutput) => void): void;
155
169
  /**
170
+ * @public
156
171
  * <p>Retrieves information about the knowledge base.</p>
157
172
  */
158
173
  getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options?: __HttpHandlerOptions): Promise<GetKnowledgeBaseCommandOutput>;
159
174
  getKnowledgeBase(args: GetKnowledgeBaseCommandInput, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
160
175
  getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
161
176
  /**
177
+ * @public
162
178
  * <p>Retrieves recommendations for the specified session. To avoid retrieving the same
163
179
  * recommendations in subsequent calls, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the
164
180
  * <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns
@@ -168,42 +184,49 @@ export declare class Wisdom extends WisdomClient {
168
184
  getRecommendations(args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void): void;
169
185
  getRecommendations(args: GetRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationsCommandOutput) => void): void;
170
186
  /**
187
+ * @public
171
188
  * <p>Retrieves information for a specified session.</p>
172
189
  */
173
190
  getSession(args: GetSessionCommandInput, options?: __HttpHandlerOptions): Promise<GetSessionCommandOutput>;
174
191
  getSession(args: GetSessionCommandInput, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
175
192
  getSession(args: GetSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSessionCommandOutput) => void): void;
176
193
  /**
194
+ * @public
177
195
  * <p>Lists information about assistant associations.</p>
178
196
  */
179
197
  listAssistantAssociations(args: ListAssistantAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssistantAssociationsCommandOutput>;
180
198
  listAssistantAssociations(args: ListAssistantAssociationsCommandInput, cb: (err: any, data?: ListAssistantAssociationsCommandOutput) => void): void;
181
199
  listAssistantAssociations(args: ListAssistantAssociationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssistantAssociationsCommandOutput) => void): void;
182
200
  /**
201
+ * @public
183
202
  * <p>Lists information about assistants.</p>
184
203
  */
185
204
  listAssistants(args: ListAssistantsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssistantsCommandOutput>;
186
205
  listAssistants(args: ListAssistantsCommandInput, cb: (err: any, data?: ListAssistantsCommandOutput) => void): void;
187
206
  listAssistants(args: ListAssistantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssistantsCommandOutput) => void): void;
188
207
  /**
208
+ * @public
189
209
  * <p>Lists the content.</p>
190
210
  */
191
211
  listContents(args: ListContentsCommandInput, options?: __HttpHandlerOptions): Promise<ListContentsCommandOutput>;
192
212
  listContents(args: ListContentsCommandInput, cb: (err: any, data?: ListContentsCommandOutput) => void): void;
193
213
  listContents(args: ListContentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListContentsCommandOutput) => void): void;
194
214
  /**
215
+ * @public
195
216
  * <p>Lists the knowledge bases.</p>
196
217
  */
197
218
  listKnowledgeBases(args: ListKnowledgeBasesCommandInput, options?: __HttpHandlerOptions): Promise<ListKnowledgeBasesCommandOutput>;
198
219
  listKnowledgeBases(args: ListKnowledgeBasesCommandInput, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void): void;
199
220
  listKnowledgeBases(args: ListKnowledgeBasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void): void;
200
221
  /**
222
+ * @public
201
223
  * <p>Lists the tags for the specified resource.</p>
202
224
  */
203
225
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
204
226
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
205
227
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
206
228
  /**
229
+ * @public
207
230
  * <p>Removes the specified recommendations from the specified assistant's queue of newly
208
231
  * available recommendations. You can use this API in conjunction with <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling
209
232
  * behavior and avoiding duplicate recommendations.</p>
@@ -212,6 +235,7 @@ export declare class Wisdom extends WisdomClient {
212
235
  notifyRecommendationsReceived(args: NotifyRecommendationsReceivedCommandInput, cb: (err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void): void;
213
236
  notifyRecommendationsReceived(args: NotifyRecommendationsReceivedCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyRecommendationsReceivedCommandOutput) => void): void;
214
237
  /**
238
+ * @public
215
239
  * <p>Performs a manual search against the specified assistant. To retrieve recommendations for
216
240
  * an assistant, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html">GetRecommendations</a>.
217
241
  * </p>
@@ -220,12 +244,14 @@ export declare class Wisdom extends WisdomClient {
220
244
  queryAssistant(args: QueryAssistantCommandInput, cb: (err: any, data?: QueryAssistantCommandOutput) => void): void;
221
245
  queryAssistant(args: QueryAssistantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryAssistantCommandOutput) => void): void;
222
246
  /**
247
+ * @public
223
248
  * <p>Removes a URI template from a knowledge base.</p>
224
249
  */
225
250
  removeKnowledgeBaseTemplateUri(args: RemoveKnowledgeBaseTemplateUriCommandInput, options?: __HttpHandlerOptions): Promise<RemoveKnowledgeBaseTemplateUriCommandOutput>;
226
251
  removeKnowledgeBaseTemplateUri(args: RemoveKnowledgeBaseTemplateUriCommandInput, cb: (err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void): void;
227
252
  removeKnowledgeBaseTemplateUri(args: RemoveKnowledgeBaseTemplateUriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RemoveKnowledgeBaseTemplateUriCommandOutput) => void): void;
228
253
  /**
254
+ * @public
229
255
  * <p>Searches for content in a specified knowledge base. Can be used to get a specific content
230
256
  * resource by its name.</p>
231
257
  */
@@ -233,12 +259,14 @@ export declare class Wisdom extends WisdomClient {
233
259
  searchContent(args: SearchContentCommandInput, cb: (err: any, data?: SearchContentCommandOutput) => void): void;
234
260
  searchContent(args: SearchContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchContentCommandOutput) => void): void;
235
261
  /**
262
+ * @public
236
263
  * <p>Searches for sessions.</p>
237
264
  */
238
265
  searchSessions(args: SearchSessionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchSessionsCommandOutput>;
239
266
  searchSessions(args: SearchSessionsCommandInput, cb: (err: any, data?: SearchSessionsCommandOutput) => void): void;
240
267
  searchSessions(args: SearchSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchSessionsCommandOutput) => void): void;
241
268
  /**
269
+ * @public
242
270
  * <p>Get a URL to upload content to a knowledge base. To upload content, first make a PUT
243
271
  * request to the returned URL with your file, making sure to include the required headers. Then
244
272
  * use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html">CreateContent</a> to finalize the content creation process or <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html">UpdateContent</a> to modify an existing resource. You can only upload content to a
@@ -248,29 +276,33 @@ export declare class Wisdom extends WisdomClient {
248
276
  startContentUpload(args: StartContentUploadCommandInput, cb: (err: any, data?: StartContentUploadCommandOutput) => void): void;
249
277
  startContentUpload(args: StartContentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentUploadCommandOutput) => void): void;
250
278
  /**
279
+ * @public
251
280
  * <p>Adds the specified tags to the specified resource.</p>
252
281
  */
253
282
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
254
283
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
255
284
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
256
285
  /**
286
+ * @public
257
287
  * <p>Removes the specified tags from the specified resource.</p>
258
288
  */
259
289
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
260
290
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
261
291
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
262
292
  /**
293
+ * @public
263
294
  * <p>Updates information about the content.</p>
264
295
  */
265
296
  updateContent(args: UpdateContentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateContentCommandOutput>;
266
297
  updateContent(args: UpdateContentCommandInput, cb: (err: any, data?: UpdateContentCommandOutput) => void): void;
267
298
  updateContent(args: UpdateContentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateContentCommandOutput) => void): void;
268
299
  /**
300
+ * @public
269
301
  * <p>Updates the template URI of a knowledge base. This is only supported for knowledge bases
270
- * of type EXTERNAL. Include a single variable in <code>${variable}</code> format; this
302
+ * of type EXTERNAL. Include a single variable in <code>$\{variable\}</code> format; this
271
303
  * interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce
272
304
  * article, it has an <code>Id</code> value, and you can set the template URI to
273
- * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*\/view</code>.
305
+ * <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*\/view</code>.
274
306
  * </p>
275
307
  */
276
308
  updateKnowledgeBaseTemplateUri(args: UpdateKnowledgeBaseTemplateUriCommandInput, options?: __HttpHandlerOptions): Promise<UpdateKnowledgeBaseTemplateUriCommandOutput>;
@@ -39,15 +39,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
39
39
  import { UpdateContentCommandInput, UpdateContentCommandOutput } from "./commands/UpdateContentCommand";
40
40
  import { UpdateKnowledgeBaseTemplateUriCommandInput, UpdateKnowledgeBaseTemplateUriCommandOutput } from "./commands/UpdateKnowledgeBaseTemplateUriCommand";
41
41
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
42
+ /**
43
+ * @public
44
+ */
42
45
  export type ServiceInputTypes = CreateAssistantAssociationCommandInput | CreateAssistantCommandInput | CreateContentCommandInput | CreateKnowledgeBaseCommandInput | CreateSessionCommandInput | DeleteAssistantAssociationCommandInput | DeleteAssistantCommandInput | DeleteContentCommandInput | DeleteKnowledgeBaseCommandInput | GetAssistantAssociationCommandInput | GetAssistantCommandInput | GetContentCommandInput | GetContentSummaryCommandInput | GetKnowledgeBaseCommandInput | GetRecommendationsCommandInput | GetSessionCommandInput | ListAssistantAssociationsCommandInput | ListAssistantsCommandInput | ListContentsCommandInput | ListKnowledgeBasesCommandInput | ListTagsForResourceCommandInput | NotifyRecommendationsReceivedCommandInput | QueryAssistantCommandInput | RemoveKnowledgeBaseTemplateUriCommandInput | SearchContentCommandInput | SearchSessionsCommandInput | StartContentUploadCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateContentCommandInput | UpdateKnowledgeBaseTemplateUriCommandInput;
46
+ /**
47
+ * @public
48
+ */
43
49
  export type ServiceOutputTypes = CreateAssistantAssociationCommandOutput | CreateAssistantCommandOutput | CreateContentCommandOutput | CreateKnowledgeBaseCommandOutput | CreateSessionCommandOutput | DeleteAssistantAssociationCommandOutput | DeleteAssistantCommandOutput | DeleteContentCommandOutput | DeleteKnowledgeBaseCommandOutput | GetAssistantAssociationCommandOutput | GetAssistantCommandOutput | GetContentCommandOutput | GetContentSummaryCommandOutput | GetKnowledgeBaseCommandOutput | GetRecommendationsCommandOutput | GetSessionCommandOutput | ListAssistantAssociationsCommandOutput | ListAssistantsCommandOutput | ListContentsCommandOutput | ListKnowledgeBasesCommandOutput | ListTagsForResourceCommandOutput | NotifyRecommendationsReceivedCommandOutput | QueryAssistantCommandOutput | RemoveKnowledgeBaseTemplateUriCommandOutput | SearchContentCommandOutput | SearchSessionsCommandOutput | StartContentUploadCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateContentCommandOutput | UpdateKnowledgeBaseTemplateUriCommandOutput;
50
+ /**
51
+ * @public
52
+ */
44
53
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
45
54
  /**
46
55
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
47
56
  */
48
57
  requestHandler?: __HttpHandler;
49
58
  /**
50
- * A constructor for a class implementing the {@link __Checksum} interface
59
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
51
60
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
52
61
  * @internal
53
62
  */
@@ -137,23 +146,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
137
146
  */
138
147
  logger?: __Logger;
139
148
  /**
140
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
149
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
150
  */
142
151
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
143
152
  }
153
+ /**
154
+ * @public
155
+ */
144
156
  type WisdomClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
145
157
  /**
146
- * The configuration interface of WisdomClient class constructor that set the region, credentials and other options.
158
+ * @public
159
+ *
160
+ * The configuration interface of WisdomClient class constructor that set the region, credentials and other options.
147
161
  */
148
162
  export interface WisdomClientConfig extends WisdomClientConfigType {
149
163
  }
164
+ /**
165
+ * @public
166
+ */
150
167
  type WisdomClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
151
168
  /**
152
- * The resolved configuration interface of WisdomClient class. This is resolved and normalized from the {@link WisdomClientConfig | constructor configuration interface}.
169
+ * @public
170
+ *
171
+ * The resolved configuration interface of WisdomClient class. This is resolved and normalized from the {@link WisdomClientConfig | constructor configuration interface}.
153
172
  */
154
173
  export interface WisdomClientResolvedConfig extends WisdomClientResolvedConfigType {
155
174
  }
156
175
  /**
176
+ * @public
157
177
  * <p>Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're
158
178
  * actively speaking with customers. Agents can search across connected repositories from within
159
179
  * their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateAssistantAssociationRequest, CreateAssistantAssociationResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAssistantAssociationCommand}.
8
10
  */
9
11
  export interface CreateAssistantAssociationCommandInput extends CreateAssistantAssociationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAssistantAssociationCommand}.
13
17
  */
14
18
  export interface CreateAssistantAssociationCommandOutput extends CreateAssistantAssociationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the
18
23
  * only supported association is with a knowledge base. An assistant can have only a single
19
24
  * association.</p>
@@ -27,6 +32,8 @@ export interface CreateAssistantAssociationCommandOutput extends CreateAssistant
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateAssistantAssociationCommandInput - {@link CreateAssistantAssociationCommandInput}
36
+ * @returns {@link CreateAssistantAssociationCommandOutput}
30
37
  * @see {@link CreateAssistantAssociationCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateAssistantAssociationCommandOutput} for command's `response` shape.
32
39
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -55,11 +62,20 @@ export interface CreateAssistantAssociationCommandOutput extends CreateAssistant
55
62
  export declare class CreateAssistantAssociationCommand extends $Command<CreateAssistantAssociationCommandInput, CreateAssistantAssociationCommandOutput, WisdomClientResolvedConfig> {
56
63
  readonly input: CreateAssistantAssociationCommandInput;
57
64
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
65
+ /**
66
+ * @public
67
+ */
58
68
  constructor(input: CreateAssistantAssociationCommandInput);
59
69
  /**
60
70
  * @internal
61
71
  */
62
72
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAssistantAssociationCommandInput, CreateAssistantAssociationCommandOutput>;
73
+ /**
74
+ * @internal
75
+ */
63
76
  private serialize;
77
+ /**
78
+ * @internal
79
+ */
64
80
  private deserialize;
65
81
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateAssistantRequest, CreateAssistantResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAssistantCommand}.
8
10
  */
9
11
  export interface CreateAssistantCommandInput extends CreateAssistantRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAssistantCommand}.
13
17
  */
14
18
  export interface CreateAssistantCommandOutput extends CreateAssistantResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Connect Wisdom assistant.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateAssistantCommandOutput extends CreateAssistantResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateAssistantCommandInput - {@link CreateAssistantCommandInput}
34
+ * @returns {@link CreateAssistantCommandOutput}
28
35
  * @see {@link CreateAssistantCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateAssistantCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -50,11 +57,20 @@ export interface CreateAssistantCommandOutput extends CreateAssistantResponse, _
50
57
  export declare class CreateAssistantCommand extends $Command<CreateAssistantCommandInput, CreateAssistantCommandOutput, WisdomClientResolvedConfig> {
51
58
  readonly input: CreateAssistantCommandInput;
52
59
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ /**
61
+ * @public
62
+ */
53
63
  constructor(input: CreateAssistantCommandInput);
54
64
  /**
55
65
  * @internal
56
66
  */
57
67
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAssistantCommandInput, CreateAssistantCommandOutput>;
68
+ /**
69
+ * @internal
70
+ */
58
71
  private serialize;
72
+ /**
73
+ * @internal
74
+ */
59
75
  private deserialize;
60
76
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateContentRequest, CreateContentResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateContentCommand}.
8
10
  */
9
11
  export interface CreateContentCommandInput extends CreateContentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateContentCommand}.
13
17
  */
14
18
  export interface CreateContentCommandOutput extends CreateContentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates Wisdom content. Before to calling this API, use <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a> to
18
23
  * upload an asset.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateContentCommandOutput extends CreateContentResponse, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateContentCommandInput - {@link CreateContentCommandInput}
35
+ * @returns {@link CreateContentCommandOutput}
29
36
  * @see {@link CreateContentCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateContentCommandOutput} for command's `response` shape.
31
38
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateContentCommandOutput extends CreateContentResponse, __Met
54
61
  export declare class CreateContentCommand extends $Command<CreateContentCommandInput, CreateContentCommandOutput, WisdomClientResolvedConfig> {
55
62
  readonly input: CreateContentCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateContentCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateContentCommandInput, CreateContentCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateKnowledgeBaseCommand}.
8
10
  */
9
11
  export interface CreateKnowledgeBaseCommandInput extends CreateKnowledgeBaseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateKnowledgeBaseCommand}.
13
17
  */
14
18
  export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a knowledge base.</p>
18
23
  * <note>
19
24
  * <p>When using this API, you cannot reuse <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html">Amazon AppIntegrations</a>
@@ -48,6 +53,8 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
48
53
  * const response = await client.send(command);
49
54
  * ```
50
55
  *
56
+ * @param CreateKnowledgeBaseCommandInput - {@link CreateKnowledgeBaseCommandInput}
57
+ * @returns {@link CreateKnowledgeBaseCommandOutput}
51
58
  * @see {@link CreateKnowledgeBaseCommandInput} for command's `input` shape.
52
59
  * @see {@link CreateKnowledgeBaseCommandOutput} for command's `response` shape.
53
60
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -73,11 +80,20 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
73
80
  export declare class CreateKnowledgeBaseCommand extends $Command<CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput, WisdomClientResolvedConfig> {
74
81
  readonly input: CreateKnowledgeBaseCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: CreateKnowledgeBaseCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateSessionRequest, CreateSessionResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateSessionCommand}.
8
10
  */
9
11
  export interface CreateSessionCommandInput extends CreateSessionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateSessionCommand}.
13
17
  */
14
18
  export interface CreateSessionCommandOutput extends CreateSessionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a session. A session is a contextual container used for generating
18
23
  * recommendations. Amazon Connect creates a new Wisdom session for each contact on which
19
24
  * Wisdom is enabled.</p>
@@ -27,6 +32,8 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param CreateSessionCommandInput - {@link CreateSessionCommandInput}
36
+ * @returns {@link CreateSessionCommandOutput}
30
37
  * @see {@link CreateSessionCommandInput} for command's `input` shape.
31
38
  * @see {@link CreateSessionCommandOutput} for command's `response` shape.
32
39
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -48,11 +55,20 @@ export interface CreateSessionCommandOutput extends CreateSessionResponse, __Met
48
55
  export declare class CreateSessionCommand extends $Command<CreateSessionCommandInput, CreateSessionCommandOutput, WisdomClientResolvedConfig> {
49
56
  readonly input: CreateSessionCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: CreateSessionCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSessionCommandInput, CreateSessionCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteAssistantAssociationRequest, DeleteAssistantAssociationResponse } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, WisdomClientResolvedConfig } from "../WisdomClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAssistantAssociationCommand}.
8
10
  */
9
11
  export interface DeleteAssistantAssociationCommandInput extends DeleteAssistantAssociationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAssistantAssociationCommand}.
13
17
  */
14
18
  export interface DeleteAssistantAssociationCommandOutput extends DeleteAssistantAssociationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an assistant association.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteAssistantAssociationCommandOutput extends DeleteAssistant
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAssistantAssociationCommandInput - {@link DeleteAssistantAssociationCommandInput}
34
+ * @returns {@link DeleteAssistantAssociationCommandOutput}
28
35
  * @see {@link DeleteAssistantAssociationCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAssistantAssociationCommandOutput} for command's `response` shape.
30
37
  * @see {@link WisdomClientResolvedConfig | config} for WisdomClient's `config` shape.
@@ -43,11 +50,20 @@ export interface DeleteAssistantAssociationCommandOutput extends DeleteAssistant
43
50
  export declare class DeleteAssistantAssociationCommand extends $Command<DeleteAssistantAssociationCommandInput, DeleteAssistantAssociationCommandOutput, WisdomClientResolvedConfig> {
44
51
  readonly input: DeleteAssistantAssociationCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: DeleteAssistantAssociationCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WisdomClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAssistantAssociationCommandInput, DeleteAssistantAssociationCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }