@aws-sdk/client-wisdom 3.529.1 → 3.535.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.
- package/dist-types/Wisdom.d.ts +3 -1
- package/dist-types/WisdomClient.d.ts +1 -1
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreateAssistantCommand.d.ts +2 -1
- package/dist-types/commands/CreateContentCommand.d.ts +2 -1
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAssistantCommand.d.ts +2 -1
- package/dist-types/commands/DeleteContentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +2 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetAssistantCommand.d.ts +2 -1
- package/dist-types/commands/GetContentCommand.d.ts +2 -1
- package/dist-types/commands/GetContentSummaryCommand.d.ts +2 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +2 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/GetQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +3 -3
- package/dist-types/commands/GetSessionCommand.d.ts +2 -1
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListAssistantsCommand.d.ts +2 -1
- package/dist-types/commands/ListContentsCommand.d.ts +2 -1
- package/dist-types/commands/ListImportJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +2 -1
- package/dist-types/commands/ListQuickResponsesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +2 -1
- package/dist-types/commands/QueryAssistantCommand.d.ts +3 -3
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -1
- package/dist-types/commands/SearchContentCommand.d.ts +2 -1
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +2 -1
- package/dist-types/commands/SearchSessionsCommand.d.ts +2 -1
- package/dist-types/commands/StartContentUploadCommand.d.ts +2 -1
- package/dist-types/commands/StartImportJobCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +481 -481
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/Wisdom.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetContentSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAssistantAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAssistantsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/NotifyRecommendationsReceivedCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchSessionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { WisdomServiceException as __BaseException } from "./WisdomServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -13,12 +13,11 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
export interface AppIntegrationsConfiguration {
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>
|
|
23
22
|
* <ul>
|
|
24
23
|
* <li>
|
|
@@ -59,10 +58,10 @@ export interface AppIntegrationsConfiguration {
|
|
|
59
58
|
* </important>
|
|
60
59
|
* </li>
|
|
61
60
|
* </ul>
|
|
61
|
+
* @public
|
|
62
62
|
*/
|
|
63
63
|
appIntegrationArn: string | undefined;
|
|
64
64
|
/**
|
|
65
|
-
* @public
|
|
66
65
|
* <p>The fields from the source that are made available to your agents in Wisdom. Optional if
|
|
67
66
|
* ObjectConfiguration is included in the provided DataIntegration. </p>
|
|
68
67
|
* <ul>
|
|
@@ -84,15 +83,16 @@ export interface AppIntegrationsConfiguration {
|
|
|
84
83
|
* </ul>
|
|
85
84
|
* <p>Make sure to include additional fields. These fields are indexed and used to source
|
|
86
85
|
* recommendations. </p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
objectFields?: string[];
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
|
-
* @public
|
|
92
91
|
* <p>The request could not be processed because of conflict in the current state of the
|
|
93
92
|
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
94
93
|
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
95
94
|
* same name) is being created or mutated.</p>
|
|
95
|
+
* @public
|
|
96
96
|
*/
|
|
97
97
|
export declare class ConflictException extends __BaseException {
|
|
98
98
|
readonly name: "ConflictException";
|
|
@@ -103,8 +103,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
103
103
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
* @public
|
|
107
106
|
* <p>The data that is input into Wisdom as a result of the assistant association.</p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
|
|
110
110
|
/**
|
|
@@ -112,9 +112,9 @@ export type AssistantAssociationInputData = AssistantAssociationInputData.Knowle
|
|
|
112
112
|
*/
|
|
113
113
|
export declare namespace AssistantAssociationInputData {
|
|
114
114
|
/**
|
|
115
|
-
* @public
|
|
116
115
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
117
116
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
117
|
+
* @public
|
|
118
118
|
*/
|
|
119
119
|
interface KnowledgeBaseIdMember {
|
|
120
120
|
knowledgeBaseId: string;
|
|
@@ -149,54 +149,54 @@ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationT
|
|
|
149
149
|
*/
|
|
150
150
|
export interface CreateAssistantAssociationRequest {
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
assistantId: string | undefined;
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The type of association.</p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
associationType: AssociationType | undefined;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>The identifier of the associated resource.</p>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
association: AssistantAssociationInputData | undefined;
|
|
166
166
|
/**
|
|
167
|
-
* @public
|
|
168
167
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
169
168
|
* request. If not provided, the Amazon Web Services
|
|
170
169
|
* SDK populates this field. For more information about idempotency, see
|
|
171
170
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
clientToken?: string;
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
tags?: Record<string, string>;
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
|
-
* @public
|
|
182
181
|
* <p>Association information about the knowledge base.</p>
|
|
182
|
+
* @public
|
|
183
183
|
*/
|
|
184
184
|
export interface KnowledgeBaseAssociationData {
|
|
185
185
|
/**
|
|
186
|
-
* @public
|
|
187
186
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
188
187
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
knowledgeBaseId?: string;
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
knowledgeBaseArn?: string;
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* @public
|
|
199
198
|
* <p>The data that is output as a result of the assistant association.</p>
|
|
199
|
+
* @public
|
|
200
200
|
*/
|
|
201
201
|
export type AssistantAssociationOutputData = AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
|
|
202
202
|
/**
|
|
@@ -204,8 +204,8 @@ export type AssistantAssociationOutputData = AssistantAssociationOutputData.Know
|
|
|
204
204
|
*/
|
|
205
205
|
export declare namespace AssistantAssociationOutputData {
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>The knowledge base where output data is sent.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
interface KnowledgeBaseAssociationMember {
|
|
211
211
|
knowledgeBaseAssociation: KnowledgeBaseAssociationData;
|
|
@@ -225,43 +225,43 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
225
225
|
const visit: <T>(value: AssistantAssociationOutputData, visitor: Visitor<T>) => T;
|
|
226
226
|
}
|
|
227
227
|
/**
|
|
228
|
-
* @public
|
|
229
228
|
* <p>Information about the assistant association.</p>
|
|
229
|
+
* @public
|
|
230
230
|
*/
|
|
231
231
|
export interface AssistantAssociationData {
|
|
232
232
|
/**
|
|
233
|
-
* @public
|
|
234
233
|
* <p>The identifier of the assistant association.</p>
|
|
234
|
+
* @public
|
|
235
235
|
*/
|
|
236
236
|
assistantAssociationId: string | undefined;
|
|
237
237
|
/**
|
|
238
|
-
* @public
|
|
239
238
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
239
|
+
* @public
|
|
240
240
|
*/
|
|
241
241
|
assistantAssociationArn: string | undefined;
|
|
242
242
|
/**
|
|
243
|
-
* @public
|
|
244
243
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
244
|
+
* @public
|
|
245
245
|
*/
|
|
246
246
|
assistantId: string | undefined;
|
|
247
247
|
/**
|
|
248
|
-
* @public
|
|
249
248
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
249
|
+
* @public
|
|
250
250
|
*/
|
|
251
251
|
assistantArn: string | undefined;
|
|
252
252
|
/**
|
|
253
|
-
* @public
|
|
254
253
|
* <p>The type of association.</p>
|
|
254
|
+
* @public
|
|
255
255
|
*/
|
|
256
256
|
associationType: AssociationType | undefined;
|
|
257
257
|
/**
|
|
258
|
-
* @public
|
|
259
258
|
* <p>A union type that currently has a single argument, the knowledge base ID.</p>
|
|
259
|
+
* @public
|
|
260
260
|
*/
|
|
261
261
|
associationData: AssistantAssociationOutputData | undefined;
|
|
262
262
|
/**
|
|
263
|
-
* @public
|
|
264
263
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
tags?: Record<string, string>;
|
|
267
267
|
}
|
|
@@ -270,21 +270,21 @@ export interface AssistantAssociationData {
|
|
|
270
270
|
*/
|
|
271
271
|
export interface CreateAssistantAssociationResponse {
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The assistant association.</p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
assistantAssociation?: AssistantAssociationData;
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>The specified resource does not exist.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
283
283
|
readonly name: "ResourceNotFoundException";
|
|
284
284
|
readonly $fault: "client";
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>The specified resource name.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
resourceName?: string;
|
|
290
290
|
/**
|
|
@@ -293,9 +293,9 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
293
293
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
294
294
|
}
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
298
297
|
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
301
301
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -306,8 +306,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
306
306
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
307
307
|
}
|
|
308
308
|
/**
|
|
309
|
-
* @public
|
|
310
309
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
310
|
+
* @public
|
|
311
311
|
*/
|
|
312
312
|
export declare class ValidationException extends __BaseException {
|
|
313
313
|
readonly name: "ValidationException";
|
|
@@ -322,13 +322,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
322
322
|
*/
|
|
323
323
|
export interface DeleteAssistantAssociationRequest {
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
assistantAssociationId: string | undefined;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
assistantId: string | undefined;
|
|
334
334
|
}
|
|
@@ -342,13 +342,13 @@ export interface DeleteAssistantAssociationResponse {
|
|
|
342
342
|
*/
|
|
343
343
|
export interface GetAssistantAssociationRequest {
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
assistantAssociationId: string | undefined;
|
|
349
349
|
/**
|
|
350
|
-
* @public
|
|
351
350
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
351
|
+
* @public
|
|
352
352
|
*/
|
|
353
353
|
assistantId: string | undefined;
|
|
354
354
|
}
|
|
@@ -357,8 +357,8 @@ export interface GetAssistantAssociationRequest {
|
|
|
357
357
|
*/
|
|
358
358
|
export interface GetAssistantAssociationResponse {
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <p>The assistant association.</p>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
assistantAssociation?: AssistantAssociationData;
|
|
364
364
|
}
|
|
@@ -367,60 +367,60 @@ export interface GetAssistantAssociationResponse {
|
|
|
367
367
|
*/
|
|
368
368
|
export interface ListAssistantAssociationsRequest {
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
372
371
|
* response in the next request to retrieve the next set of results.</p>
|
|
372
|
+
* @public
|
|
373
373
|
*/
|
|
374
374
|
nextToken?: string;
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>The maximum number of results to return per page.</p>
|
|
377
|
+
* @public
|
|
378
378
|
*/
|
|
379
379
|
maxResults?: number;
|
|
380
380
|
/**
|
|
381
|
-
* @public
|
|
382
381
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
382
|
+
* @public
|
|
383
383
|
*/
|
|
384
384
|
assistantId: string | undefined;
|
|
385
385
|
}
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>Summary information about the assistant association.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
export interface AssistantAssociationSummary {
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>The identifier of the assistant association.</p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
assistantAssociationId: string | undefined;
|
|
396
396
|
/**
|
|
397
|
-
* @public
|
|
398
397
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
398
|
+
* @public
|
|
399
399
|
*/
|
|
400
400
|
assistantAssociationArn: string | undefined;
|
|
401
401
|
/**
|
|
402
|
-
* @public
|
|
403
402
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
403
|
+
* @public
|
|
404
404
|
*/
|
|
405
405
|
assistantId: string | undefined;
|
|
406
406
|
/**
|
|
407
|
-
* @public
|
|
408
407
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
assistantArn: string | undefined;
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>The type of association.</p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
associationType: AssociationType | undefined;
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>The association data.</p>
|
|
418
|
+
* @public
|
|
419
419
|
*/
|
|
420
420
|
associationData: AssistantAssociationOutputData | undefined;
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
423
|
+
* @public
|
|
424
424
|
*/
|
|
425
425
|
tags?: Record<string, string>;
|
|
426
426
|
}
|
|
@@ -429,26 +429,26 @@ export interface AssistantAssociationSummary {
|
|
|
429
429
|
*/
|
|
430
430
|
export interface ListAssistantAssociationsResponse {
|
|
431
431
|
/**
|
|
432
|
-
* @public
|
|
433
432
|
* <p>Summary information about assistant associations.</p>
|
|
433
|
+
* @public
|
|
434
434
|
*/
|
|
435
435
|
assistantAssociationSummaries: AssistantAssociationSummary[] | undefined;
|
|
436
436
|
/**
|
|
437
|
-
* @public
|
|
438
437
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
438
|
+
* @public
|
|
439
439
|
*/
|
|
440
440
|
nextToken?: string;
|
|
441
441
|
}
|
|
442
442
|
/**
|
|
443
|
-
* @public
|
|
444
443
|
* <p>The configuration information for the customer managed key used for encryption.</p>
|
|
444
|
+
* @public
|
|
445
445
|
*/
|
|
446
446
|
export interface ServerSideEncryptionConfiguration {
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>The customer managed key used for encryption. For more information about setting up a
|
|
450
449
|
* customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom for your
|
|
451
450
|
* instance</a>. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
kmsKeyId?: string;
|
|
454
454
|
}
|
|
@@ -468,35 +468,34 @@ export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
|
|
|
468
468
|
*/
|
|
469
469
|
export interface CreateAssistantRequest {
|
|
470
470
|
/**
|
|
471
|
-
* @public
|
|
472
471
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
473
472
|
* request. If not provided, the Amazon Web Services
|
|
474
473
|
* SDK populates this field. For more information about idempotency, see
|
|
475
474
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
clientToken?: string;
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>The name of the assistant.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
name: string | undefined;
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>The type of assistant.</p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
type: AssistantType | undefined;
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>The description of the assistant.</p>
|
|
490
|
+
* @public
|
|
491
491
|
*/
|
|
492
492
|
description?: string;
|
|
493
493
|
/**
|
|
494
|
-
* @public
|
|
495
494
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
495
|
+
* @public
|
|
496
496
|
*/
|
|
497
497
|
tags?: Record<string, string>;
|
|
498
498
|
/**
|
|
499
|
-
* @public
|
|
500
499
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
501
500
|
* <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
502
501
|
* <code> kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
@@ -506,17 +505,18 @@ export interface CreateAssistantRequest {
|
|
|
506
505
|
* principal. </p>
|
|
507
506
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
508
507
|
* for your instance</a>.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
511
511
|
}
|
|
512
512
|
/**
|
|
513
|
-
* @public
|
|
514
513
|
* <p>The configuration information for the Wisdom assistant integration.</p>
|
|
514
|
+
* @public
|
|
515
515
|
*/
|
|
516
516
|
export interface AssistantIntegrationConfiguration {
|
|
517
517
|
/**
|
|
518
|
-
* @public
|
|
519
518
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
519
|
+
* @public
|
|
520
520
|
*/
|
|
521
521
|
topicIntegrationArn?: string;
|
|
522
522
|
}
|
|
@@ -537,47 +537,46 @@ export declare const AssistantStatus: {
|
|
|
537
537
|
*/
|
|
538
538
|
export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantStatus];
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p>The assistant data.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
export interface AssistantData {
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
assistantId: string | undefined;
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
assistantArn: string | undefined;
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>The name.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
name: string | undefined;
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>The type of assistant.</p>
|
|
561
|
+
* @public
|
|
562
562
|
*/
|
|
563
563
|
type: AssistantType | undefined;
|
|
564
564
|
/**
|
|
565
|
-
* @public
|
|
566
565
|
* <p>The status of the assistant.</p>
|
|
566
|
+
* @public
|
|
567
567
|
*/
|
|
568
568
|
status: AssistantStatus | undefined;
|
|
569
569
|
/**
|
|
570
|
-
* @public
|
|
571
570
|
* <p>The description.</p>
|
|
571
|
+
* @public
|
|
572
572
|
*/
|
|
573
573
|
description?: string;
|
|
574
574
|
/**
|
|
575
|
-
* @public
|
|
576
575
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
576
|
+
* @public
|
|
577
577
|
*/
|
|
578
578
|
tags?: Record<string, string>;
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
582
581
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
583
582
|
* <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
@@ -587,11 +586,12 @@ export interface AssistantData {
|
|
|
587
586
|
* principal. </p>
|
|
588
587
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
589
588
|
* for your instance</a>.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
592
592
|
/**
|
|
593
|
-
* @public
|
|
594
593
|
* <p>The configuration information for the Wisdom assistant integration.</p>
|
|
594
|
+
* @public
|
|
595
595
|
*/
|
|
596
596
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
597
597
|
}
|
|
@@ -600,8 +600,8 @@ export interface AssistantData {
|
|
|
600
600
|
*/
|
|
601
601
|
export interface CreateAssistantResponse {
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>Information about the assistant.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
assistant?: AssistantData;
|
|
607
607
|
}
|
|
@@ -610,8 +610,8 @@ export interface CreateAssistantResponse {
|
|
|
610
610
|
*/
|
|
611
611
|
export interface DeleteAssistantRequest {
|
|
612
612
|
/**
|
|
613
|
-
* @public
|
|
614
613
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
614
|
+
* @public
|
|
615
615
|
*/
|
|
616
616
|
assistantId: string | undefined;
|
|
617
617
|
}
|
|
@@ -625,8 +625,8 @@ export interface DeleteAssistantResponse {
|
|
|
625
625
|
*/
|
|
626
626
|
export interface GetAssistantRequest {
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
assistantId: string | undefined;
|
|
632
632
|
}
|
|
@@ -635,8 +635,8 @@ export interface GetAssistantRequest {
|
|
|
635
635
|
*/
|
|
636
636
|
export interface GetAssistantResponse {
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* <p>Information about the assistant.</p>
|
|
639
|
+
* @public
|
|
640
640
|
*/
|
|
641
641
|
assistant?: AssistantData;
|
|
642
642
|
}
|
|
@@ -645,107 +645,107 @@ export interface GetAssistantResponse {
|
|
|
645
645
|
*/
|
|
646
646
|
export interface GetRecommendationsRequest {
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
assistantId: string | undefined;
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
sessionId: string | undefined;
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The maximum number of results to return per page.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
maxResults?: number;
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>The duration (in seconds) for which the call waits for a recommendation to be made
|
|
665
664
|
* available before returning. If a recommendation is available, the call returns sooner than
|
|
666
665
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the
|
|
667
666
|
* call returns successfully with an empty list.</p>
|
|
667
|
+
* @public
|
|
668
668
|
*/
|
|
669
669
|
waitTimeSeconds?: number;
|
|
670
670
|
}
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>Reference information about the content.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
export interface ContentReference {
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
knowledgeBaseArn?: string;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
684
683
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
684
|
+
* @public
|
|
685
685
|
*/
|
|
686
686
|
knowledgeBaseId?: string;
|
|
687
687
|
/**
|
|
688
|
-
* @public
|
|
689
688
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
689
|
+
* @public
|
|
690
690
|
*/
|
|
691
691
|
contentArn?: string;
|
|
692
692
|
/**
|
|
693
|
-
* @public
|
|
694
693
|
* <p>The identifier of the content.</p>
|
|
694
|
+
* @public
|
|
695
695
|
*/
|
|
696
696
|
contentId?: string;
|
|
697
697
|
}
|
|
698
698
|
/**
|
|
699
|
-
* @public
|
|
700
699
|
* <p>Offset specification to describe highlighting of document excerpts for rendering search
|
|
701
700
|
* results and recommendations.</p>
|
|
701
|
+
* @public
|
|
702
702
|
*/
|
|
703
703
|
export interface Highlight {
|
|
704
704
|
/**
|
|
705
|
-
* @public
|
|
706
705
|
* <p>The offset for the start of the highlight.</p>
|
|
706
|
+
* @public
|
|
707
707
|
*/
|
|
708
708
|
beginOffsetInclusive?: number;
|
|
709
709
|
/**
|
|
710
|
-
* @public
|
|
711
710
|
* <p>The offset for the end of the highlight.</p>
|
|
711
|
+
* @public
|
|
712
712
|
*/
|
|
713
713
|
endOffsetExclusive?: number;
|
|
714
714
|
}
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>The text of the document.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
export interface DocumentText {
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>Text in the document.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
text?: string;
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>Highlights in the document text.</p>
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
highlights?: Highlight[];
|
|
730
730
|
}
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>The document.</p>
|
|
733
|
+
* @public
|
|
734
734
|
*/
|
|
735
735
|
export interface Document {
|
|
736
736
|
/**
|
|
737
|
-
* @public
|
|
738
737
|
* <p>A reference to the content resource.</p>
|
|
738
|
+
* @public
|
|
739
739
|
*/
|
|
740
740
|
contentReference: ContentReference | undefined;
|
|
741
741
|
/**
|
|
742
|
-
* @public
|
|
743
742
|
* <p>The title of the document.</p>
|
|
743
|
+
* @public
|
|
744
744
|
*/
|
|
745
745
|
title?: DocumentText;
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The excerpt from the document.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
excerpt?: DocumentText;
|
|
751
751
|
}
|
|
@@ -774,50 +774,50 @@ export declare const RecommendationType: {
|
|
|
774
774
|
*/
|
|
775
775
|
export type RecommendationType = (typeof RecommendationType)[keyof typeof RecommendationType];
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>Information about the recommendation.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
export interface RecommendationData {
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The identifier of the recommendation.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
recommendationId: string | undefined;
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <p>The recommended document.</p>
|
|
788
|
+
* @public
|
|
789
789
|
*/
|
|
790
790
|
document: Document | undefined;
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <p>The relevance score of the recommendation.</p>
|
|
793
|
+
* @public
|
|
794
794
|
*/
|
|
795
795
|
relevanceScore?: number;
|
|
796
796
|
/**
|
|
797
|
-
* @public
|
|
798
797
|
* <p>The relevance level of the recommendation.</p>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
relevanceLevel?: RelevanceLevel;
|
|
801
801
|
/**
|
|
802
|
-
* @public
|
|
803
802
|
* <p>The type of recommendation.</p>
|
|
803
|
+
* @public
|
|
804
804
|
*/
|
|
805
805
|
type?: RecommendationType;
|
|
806
806
|
}
|
|
807
807
|
/**
|
|
808
|
-
* @public
|
|
809
808
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
export interface QueryRecommendationTriggerData {
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The text associated with the recommendation trigger.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
text?: string;
|
|
817
817
|
}
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>A union type containing information related to the trigger.</p>
|
|
820
|
+
* @public
|
|
821
821
|
*/
|
|
822
822
|
export type RecommendationTriggerData = RecommendationTriggerData.QueryMember | RecommendationTriggerData.$UnknownMember;
|
|
823
823
|
/**
|
|
@@ -825,8 +825,8 @@ export type RecommendationTriggerData = RecommendationTriggerData.QueryMember |
|
|
|
825
825
|
*/
|
|
826
826
|
export declare namespace RecommendationTriggerData {
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
interface QueryMember {
|
|
832
832
|
query: QueryRecommendationTriggerData;
|
|
@@ -870,24 +870,23 @@ export declare const RecommendationTriggerType: {
|
|
|
870
870
|
*/
|
|
871
871
|
export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
|
|
872
872
|
/**
|
|
873
|
-
* @public
|
|
874
873
|
* <p>A recommendation trigger provides context on the event that produced the referenced
|
|
875
874
|
* recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a
|
|
876
875
|
* single RecommendationTrigger.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
export interface RecommendationTrigger {
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <p>The identifier of the recommendation trigger.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
id: string | undefined;
|
|
884
884
|
/**
|
|
885
|
-
* @public
|
|
886
885
|
* <p>The type of recommendation trigger.</p>
|
|
886
|
+
* @public
|
|
887
887
|
*/
|
|
888
888
|
type: RecommendationTriggerType | undefined;
|
|
889
889
|
/**
|
|
890
|
-
* @public
|
|
891
890
|
* <p>The source of the recommendation trigger.</p>
|
|
892
891
|
* <ul>
|
|
893
892
|
* <li>
|
|
@@ -899,16 +898,17 @@ export interface RecommendationTrigger {
|
|
|
899
898
|
* rule.</p>
|
|
900
899
|
* </li>
|
|
901
900
|
* </ul>
|
|
901
|
+
* @public
|
|
902
902
|
*/
|
|
903
903
|
source: RecommendationSourceType | undefined;
|
|
904
904
|
/**
|
|
905
|
-
* @public
|
|
906
905
|
* <p>A union type containing information related to the trigger.</p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
data: RecommendationTriggerData | undefined;
|
|
909
909
|
/**
|
|
910
|
-
* @public
|
|
911
910
|
* <p>The identifiers of the recommendations.</p>
|
|
911
|
+
* @public
|
|
912
912
|
*/
|
|
913
913
|
recommendationIds: string[] | undefined;
|
|
914
914
|
}
|
|
@@ -917,13 +917,13 @@ export interface RecommendationTrigger {
|
|
|
917
917
|
*/
|
|
918
918
|
export interface GetRecommendationsResponse {
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>The recommendations.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
recommendations: RecommendationData[] | undefined;
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>The triggers corresponding to recommendations.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
triggers?: RecommendationTrigger[];
|
|
929
929
|
}
|
|
@@ -932,59 +932,58 @@ export interface GetRecommendationsResponse {
|
|
|
932
932
|
*/
|
|
933
933
|
export interface ListAssistantsRequest {
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
937
936
|
* response in the next request to retrieve the next set of results.</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
nextToken?: string;
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>The maximum number of results to return per page.</p>
|
|
942
|
+
* @public
|
|
943
943
|
*/
|
|
944
944
|
maxResults?: number;
|
|
945
945
|
}
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>Summary information about the assistant.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
export interface AssistantSummary {
|
|
951
951
|
/**
|
|
952
|
-
* @public
|
|
953
952
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
953
|
+
* @public
|
|
954
954
|
*/
|
|
955
955
|
assistantId: string | undefined;
|
|
956
956
|
/**
|
|
957
|
-
* @public
|
|
958
957
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
assistantArn: string | undefined;
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The name of the assistant.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
name: string | undefined;
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>The type of the assistant.</p>
|
|
968
|
+
* @public
|
|
969
969
|
*/
|
|
970
970
|
type: AssistantType | undefined;
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>The status of the assistant.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
status: AssistantStatus | undefined;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The description of the assistant.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
description?: string;
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
tags?: Record<string, string>;
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
989
988
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
990
989
|
* <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
@@ -994,11 +993,12 @@ export interface AssistantSummary {
|
|
|
994
993
|
* principal. </p>
|
|
995
994
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
996
995
|
* for your instance</a>.</p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>The configuration information for the Wisdom assistant integration.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
1004
1004
|
}
|
|
@@ -1007,13 +1007,13 @@ export interface AssistantSummary {
|
|
|
1007
1007
|
*/
|
|
1008
1008
|
export interface ListAssistantsResponse {
|
|
1009
1009
|
/**
|
|
1010
|
-
* @public
|
|
1011
1010
|
* <p>Information about the assistants.</p>
|
|
1011
|
+
* @public
|
|
1012
1012
|
*/
|
|
1013
1013
|
assistantSummaries: AssistantSummary[] | undefined;
|
|
1014
1014
|
/**
|
|
1015
|
-
* @public
|
|
1016
1015
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1016
|
+
* @public
|
|
1017
1017
|
*/
|
|
1018
1018
|
nextToken?: string;
|
|
1019
1019
|
}
|
|
@@ -1022,34 +1022,34 @@ export interface ListAssistantsResponse {
|
|
|
1022
1022
|
*/
|
|
1023
1023
|
export interface NotifyRecommendationsReceivedRequest {
|
|
1024
1024
|
/**
|
|
1025
|
-
* @public
|
|
1026
1025
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
assistantId: string | undefined;
|
|
1029
1029
|
/**
|
|
1030
|
-
* @public
|
|
1031
1030
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1031
|
+
* @public
|
|
1032
1032
|
*/
|
|
1033
1033
|
sessionId: string | undefined;
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>The identifiers of the recommendations.</p>
|
|
1036
|
+
* @public
|
|
1037
1037
|
*/
|
|
1038
1038
|
recommendationIds: string[] | undefined;
|
|
1039
1039
|
}
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>An error occurred when creating a recommendation.</p>
|
|
1042
|
+
* @public
|
|
1043
1043
|
*/
|
|
1044
1044
|
export interface NotifyRecommendationsReceivedError {
|
|
1045
1045
|
/**
|
|
1046
|
-
* @public
|
|
1047
1046
|
* <p>The identifier of the recommendation that is in error.</p>
|
|
1047
|
+
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
recommendationId?: string;
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <p>A recommendation is causing an error.</p>
|
|
1052
|
+
* @public
|
|
1053
1053
|
*/
|
|
1054
1054
|
message?: string;
|
|
1055
1055
|
}
|
|
@@ -1058,13 +1058,13 @@ export interface NotifyRecommendationsReceivedError {
|
|
|
1058
1058
|
*/
|
|
1059
1059
|
export interface NotifyRecommendationsReceivedResponse {
|
|
1060
1060
|
/**
|
|
1061
|
-
* @public
|
|
1062
1061
|
* <p>The identifiers of the recommendations.</p>
|
|
1062
|
+
* @public
|
|
1063
1063
|
*/
|
|
1064
1064
|
recommendationIds?: string[];
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>The identifiers of recommendations that are causing errors.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
errors?: NotifyRecommendationsReceivedError[];
|
|
1070
1070
|
}
|
|
@@ -1073,45 +1073,45 @@ export interface NotifyRecommendationsReceivedResponse {
|
|
|
1073
1073
|
*/
|
|
1074
1074
|
export interface QueryAssistantRequest {
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1077
|
+
* @public
|
|
1078
1078
|
*/
|
|
1079
1079
|
assistantId: string | undefined;
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The text to search for.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
queryText: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1088
1087
|
* response in the next request to retrieve the next set of results.</p>
|
|
1088
|
+
* @public
|
|
1089
1089
|
*/
|
|
1090
1090
|
nextToken?: string;
|
|
1091
1091
|
/**
|
|
1092
|
-
* @public
|
|
1093
1092
|
* <p>The maximum number of results to return per page.</p>
|
|
1093
|
+
* @public
|
|
1094
1094
|
*/
|
|
1095
1095
|
maxResults?: number;
|
|
1096
1096
|
}
|
|
1097
1097
|
/**
|
|
1098
|
-
* @public
|
|
1099
1098
|
* <p>Information about the result.</p>
|
|
1099
|
+
* @public
|
|
1100
1100
|
*/
|
|
1101
1101
|
export interface ResultData {
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The identifier of the result data.</p>
|
|
1104
|
+
* @public
|
|
1105
1105
|
*/
|
|
1106
1106
|
resultId: string | undefined;
|
|
1107
1107
|
/**
|
|
1108
|
-
* @public
|
|
1109
1108
|
* <p>The document.</p>
|
|
1109
|
+
* @public
|
|
1110
1110
|
*/
|
|
1111
1111
|
document: Document | undefined;
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>The relevance score of the results.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
relevanceScore?: number;
|
|
1117
1117
|
}
|
|
@@ -1120,21 +1120,21 @@ export interface ResultData {
|
|
|
1120
1120
|
*/
|
|
1121
1121
|
export interface QueryAssistantResponse {
|
|
1122
1122
|
/**
|
|
1123
|
-
* @public
|
|
1124
1123
|
* <p>The results of the query.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
results: ResultData[] | undefined;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
nextToken?: string;
|
|
1132
1132
|
}
|
|
1133
1133
|
/**
|
|
1134
|
-
* @public
|
|
1135
1134
|
* <p>The request reached the service more than 15 minutes after the date stamp on the request
|
|
1136
1135
|
* or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
|
|
1137
1136
|
* the date stamp on the request is more than 15 minutes in the future.</p>
|
|
1137
|
+
* @public
|
|
1138
1138
|
*/
|
|
1139
1139
|
export declare class RequestTimeoutException extends __BaseException {
|
|
1140
1140
|
readonly name: "RequestTimeoutException";
|
|
@@ -1168,34 +1168,34 @@ export declare const FilterOperator: {
|
|
|
1168
1168
|
*/
|
|
1169
1169
|
export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>A search filter.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
export interface Filter {
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The field on which to filter.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
field: FilterField | undefined;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The operator to use for comparing the field’s value with the provided value.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
operator: FilterOperator | undefined;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The desired field value on which to filter.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
value: string | undefined;
|
|
1190
1190
|
}
|
|
1191
1191
|
/**
|
|
1192
|
-
* @public
|
|
1193
1192
|
* <p>The search expression.</p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
export interface SearchExpression {
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>The search expression filters.</p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
filters: Filter[] | undefined;
|
|
1201
1201
|
}
|
|
@@ -1204,50 +1204,50 @@ export interface SearchExpression {
|
|
|
1204
1204
|
*/
|
|
1205
1205
|
export interface SearchSessionsRequest {
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1209
1208
|
* response in the next request to retrieve the next set of results.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
nextToken?: string;
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>The maximum number of results to return per page.</p>
|
|
1214
|
+
* @public
|
|
1215
1215
|
*/
|
|
1216
1216
|
maxResults?: number;
|
|
1217
1217
|
/**
|
|
1218
|
-
* @public
|
|
1219
1218
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1219
|
+
* @public
|
|
1220
1220
|
*/
|
|
1221
1221
|
assistantId: string | undefined;
|
|
1222
1222
|
/**
|
|
1223
|
-
* @public
|
|
1224
1223
|
* <p>The search expression to filter results.</p>
|
|
1224
|
+
* @public
|
|
1225
1225
|
*/
|
|
1226
1226
|
searchExpression: SearchExpression | undefined;
|
|
1227
1227
|
}
|
|
1228
1228
|
/**
|
|
1229
|
-
* @public
|
|
1230
1229
|
* <p>Summary information about the session.</p>
|
|
1230
|
+
* @public
|
|
1231
1231
|
*/
|
|
1232
1232
|
export interface SessionSummary {
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>The identifier of the session.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
sessionId: string | undefined;
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
sessionArn: string | undefined;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
assistantId: string | undefined;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
assistantArn: string | undefined;
|
|
1253
1253
|
}
|
|
@@ -1256,13 +1256,13 @@ export interface SessionSummary {
|
|
|
1256
1256
|
*/
|
|
1257
1257
|
export interface SearchSessionsResponse {
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>Summary information about the sessions.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
sessionSummaries: SessionSummary[] | undefined;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
nextToken?: string;
|
|
1268
1268
|
}
|
|
@@ -1271,78 +1271,78 @@ export interface SearchSessionsResponse {
|
|
|
1271
1271
|
*/
|
|
1272
1272
|
export interface CreateSessionRequest {
|
|
1273
1273
|
/**
|
|
1274
|
-
* @public
|
|
1275
1274
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1276
1275
|
* request. If not provided, the Amazon Web Services
|
|
1277
1276
|
* SDK populates this field. For more information about idempotency, see
|
|
1278
1277
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1278
|
+
* @public
|
|
1279
1279
|
*/
|
|
1280
1280
|
clientToken?: string;
|
|
1281
1281
|
/**
|
|
1282
|
-
* @public
|
|
1283
1282
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1283
|
+
* @public
|
|
1284
1284
|
*/
|
|
1285
1285
|
assistantId: string | undefined;
|
|
1286
1286
|
/**
|
|
1287
|
-
* @public
|
|
1288
1287
|
* <p>The name of the session.</p>
|
|
1288
|
+
* @public
|
|
1289
1289
|
*/
|
|
1290
1290
|
name: string | undefined;
|
|
1291
1291
|
/**
|
|
1292
|
-
* @public
|
|
1293
1292
|
* <p>The description.</p>
|
|
1293
|
+
* @public
|
|
1294
1294
|
*/
|
|
1295
1295
|
description?: string;
|
|
1296
1296
|
/**
|
|
1297
|
-
* @public
|
|
1298
1297
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1298
|
+
* @public
|
|
1299
1299
|
*/
|
|
1300
1300
|
tags?: Record<string, string>;
|
|
1301
1301
|
}
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>The configuration information for the session integration.</p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
export interface SessionIntegrationConfiguration {
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
topicIntegrationArn?: string;
|
|
1312
1312
|
}
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>Information about the session.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
export interface SessionData {
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1320
|
+
* @public
|
|
1321
1321
|
*/
|
|
1322
1322
|
sessionArn: string | undefined;
|
|
1323
1323
|
/**
|
|
1324
|
-
* @public
|
|
1325
1324
|
* <p>The identifier of the session.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
sessionId: string | undefined;
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>The name of the session.</p>
|
|
1330
|
+
* @public
|
|
1331
1331
|
*/
|
|
1332
1332
|
name: string | undefined;
|
|
1333
1333
|
/**
|
|
1334
|
-
* @public
|
|
1335
1334
|
* <p>The description of the session.</p>
|
|
1335
|
+
* @public
|
|
1336
1336
|
*/
|
|
1337
1337
|
description?: string;
|
|
1338
1338
|
/**
|
|
1339
|
-
* @public
|
|
1340
1339
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1340
|
+
* @public
|
|
1341
1341
|
*/
|
|
1342
1342
|
tags?: Record<string, string>;
|
|
1343
1343
|
/**
|
|
1344
|
-
* @public
|
|
1345
1344
|
* <p>The configuration information for the session integration.</p>
|
|
1345
|
+
* @public
|
|
1346
1346
|
*/
|
|
1347
1347
|
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
1348
1348
|
}
|
|
@@ -1351,8 +1351,8 @@ export interface SessionData {
|
|
|
1351
1351
|
*/
|
|
1352
1352
|
export interface CreateSessionResponse {
|
|
1353
1353
|
/**
|
|
1354
|
-
* @public
|
|
1355
1354
|
* <p>The session.</p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
session?: SessionData;
|
|
1358
1358
|
}
|
|
@@ -1361,13 +1361,13 @@ export interface CreateSessionResponse {
|
|
|
1361
1361
|
*/
|
|
1362
1362
|
export interface GetSessionRequest {
|
|
1363
1363
|
/**
|
|
1364
|
-
* @public
|
|
1365
1364
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
assistantId: string | undefined;
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
sessionId: string | undefined;
|
|
1373
1373
|
}
|
|
@@ -1376,25 +1376,25 @@ export interface GetSessionRequest {
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
export interface GetSessionResponse {
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The session.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
session?: SessionData;
|
|
1383
1383
|
}
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
export interface ConnectConfiguration {
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
instanceId?: string;
|
|
1394
1394
|
}
|
|
1395
1395
|
/**
|
|
1396
|
-
* @public
|
|
1397
1396
|
* <p>The configuration information of the external data source.</p>
|
|
1397
|
+
* @public
|
|
1398
1398
|
*/
|
|
1399
1399
|
export type Configuration = Configuration.ConnectConfigurationMember | Configuration.$UnknownMember;
|
|
1400
1400
|
/**
|
|
@@ -1402,8 +1402,8 @@ export type Configuration = Configuration.ConnectConfigurationMember | Configura
|
|
|
1402
1402
|
*/
|
|
1403
1403
|
export declare namespace Configuration {
|
|
1404
1404
|
/**
|
|
1405
|
-
* @public
|
|
1406
1405
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
1406
|
+
* @public
|
|
1407
1407
|
*/
|
|
1408
1408
|
interface ConnectConfigurationMember {
|
|
1409
1409
|
connectConfiguration: ConnectConfiguration;
|
|
@@ -1427,51 +1427,51 @@ export declare namespace Configuration {
|
|
|
1427
1427
|
*/
|
|
1428
1428
|
export interface CreateContentRequest {
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1432
1431
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1432
|
+
* @public
|
|
1433
1433
|
*/
|
|
1434
1434
|
knowledgeBaseId: string | undefined;
|
|
1435
1435
|
/**
|
|
1436
|
-
* @public
|
|
1437
1436
|
* <p>The name of the content. Each piece of content in a knowledge base must have a unique
|
|
1438
1437
|
* name. You can retrieve a piece of content using only its knowledge base and its name with the
|
|
1439
1438
|
* <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>
|
|
1439
|
+
* @public
|
|
1440
1440
|
*/
|
|
1441
1441
|
name: string | undefined;
|
|
1442
1442
|
/**
|
|
1443
|
-
* @public
|
|
1444
1443
|
* <p>The title of the content. If not set, the title is equal to the name.</p>
|
|
1444
|
+
* @public
|
|
1445
1445
|
*/
|
|
1446
1446
|
title?: string;
|
|
1447
1447
|
/**
|
|
1448
|
-
* @public
|
|
1449
1448
|
* <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
|
|
1450
1449
|
* this argument overrides it for this piece of content.</p>
|
|
1450
|
+
* @public
|
|
1451
1451
|
*/
|
|
1452
1452
|
overrideLinkOutUri?: string;
|
|
1453
1453
|
/**
|
|
1454
|
-
* @public
|
|
1455
1454
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1456
1455
|
* For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1456
|
+
* @public
|
|
1457
1457
|
*/
|
|
1458
1458
|
metadata?: Record<string, string>;
|
|
1459
1459
|
/**
|
|
1460
|
-
* @public
|
|
1461
1460
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
1461
|
+
* @public
|
|
1462
1462
|
*/
|
|
1463
1463
|
uploadId: string | undefined;
|
|
1464
1464
|
/**
|
|
1465
|
-
* @public
|
|
1466
1465
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1467
1466
|
* request. If not provided, the Amazon Web Services
|
|
1468
1467
|
* SDK populates this field. For more information about idempotency, see
|
|
1469
1468
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1469
|
+
* @public
|
|
1470
1470
|
*/
|
|
1471
1471
|
clientToken?: string;
|
|
1472
1472
|
/**
|
|
1473
|
-
* @public
|
|
1474
1473
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1474
|
+
* @public
|
|
1475
1475
|
*/
|
|
1476
1476
|
tags?: Record<string, string>;
|
|
1477
1477
|
}
|
|
@@ -1493,80 +1493,80 @@ export declare const ContentStatus: {
|
|
|
1493
1493
|
*/
|
|
1494
1494
|
export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>Information about the content.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
export interface ContentData {
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
contentArn: string | undefined;
|
|
1505
1505
|
/**
|
|
1506
|
-
* @public
|
|
1507
1506
|
* <p>The identifier of the content.</p>
|
|
1507
|
+
* @public
|
|
1508
1508
|
*/
|
|
1509
1509
|
contentId: string | undefined;
|
|
1510
1510
|
/**
|
|
1511
|
-
* @public
|
|
1512
1511
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1512
|
+
* @public
|
|
1513
1513
|
*/
|
|
1514
1514
|
knowledgeBaseArn: string | undefined;
|
|
1515
1515
|
/**
|
|
1516
|
-
* @public
|
|
1517
1516
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1518
1517
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
knowledgeBaseId: string | undefined;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>The name of the content.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
name: string | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>The identifier of the content revision.</p>
|
|
1528
|
+
* @public
|
|
1529
1529
|
*/
|
|
1530
1530
|
revisionId: string | undefined;
|
|
1531
1531
|
/**
|
|
1532
|
-
* @public
|
|
1533
1532
|
* <p>The title of the content.</p>
|
|
1533
|
+
* @public
|
|
1534
1534
|
*/
|
|
1535
1535
|
title: string | undefined;
|
|
1536
1536
|
/**
|
|
1537
|
-
* @public
|
|
1538
1537
|
* <p>The media type of the content.</p>
|
|
1538
|
+
* @public
|
|
1539
1539
|
*/
|
|
1540
1540
|
contentType: string | undefined;
|
|
1541
1541
|
/**
|
|
1542
|
-
* @public
|
|
1543
1542
|
* <p>The status of the content.</p>
|
|
1543
|
+
* @public
|
|
1544
1544
|
*/
|
|
1545
1545
|
status: ContentStatus | undefined;
|
|
1546
1546
|
/**
|
|
1547
|
-
* @public
|
|
1548
1547
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1549
1548
|
* For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1549
|
+
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
metadata: Record<string, string> | undefined;
|
|
1552
1552
|
/**
|
|
1553
|
-
* @public
|
|
1554
1553
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
tags?: Record<string, string>;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The URI of the content.</p>
|
|
1559
|
+
* @public
|
|
1560
1560
|
*/
|
|
1561
1561
|
linkOutUri?: string;
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>The URL of the content.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
url: string | undefined;
|
|
1567
1567
|
/**
|
|
1568
|
-
* @public
|
|
1569
1568
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
1569
|
+
* @public
|
|
1570
1570
|
*/
|
|
1571
1571
|
urlExpiry: Date | undefined;
|
|
1572
1572
|
}
|
|
@@ -1575,8 +1575,8 @@ export interface ContentData {
|
|
|
1575
1575
|
*/
|
|
1576
1576
|
export interface CreateContentResponse {
|
|
1577
1577
|
/**
|
|
1578
|
-
* @public
|
|
1579
1578
|
* <p>The content.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
content?: ContentData;
|
|
1582
1582
|
}
|
|
@@ -1585,14 +1585,14 @@ export interface CreateContentResponse {
|
|
|
1585
1585
|
*/
|
|
1586
1586
|
export interface DeleteContentRequest {
|
|
1587
1587
|
/**
|
|
1588
|
-
* @public
|
|
1589
1588
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1590
1589
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1590
|
+
* @public
|
|
1591
1591
|
*/
|
|
1592
1592
|
knowledgeBaseId: string | undefined;
|
|
1593
1593
|
/**
|
|
1594
|
-
* @public
|
|
1595
1594
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1595
|
+
* @public
|
|
1596
1596
|
*/
|
|
1597
1597
|
contentId: string | undefined;
|
|
1598
1598
|
}
|
|
@@ -1606,14 +1606,14 @@ export interface DeleteContentResponse {
|
|
|
1606
1606
|
*/
|
|
1607
1607
|
export interface GetContentRequest {
|
|
1608
1608
|
/**
|
|
1609
|
-
* @public
|
|
1610
1609
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1610
|
+
* @public
|
|
1611
1611
|
*/
|
|
1612
1612
|
contentId: string | undefined;
|
|
1613
1613
|
/**
|
|
1614
|
-
* @public
|
|
1615
1614
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1616
1615
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
knowledgeBaseId: string | undefined;
|
|
1619
1619
|
}
|
|
@@ -1622,8 +1622,8 @@ export interface GetContentRequest {
|
|
|
1622
1622
|
*/
|
|
1623
1623
|
export interface GetContentResponse {
|
|
1624
1624
|
/**
|
|
1625
|
-
* @public
|
|
1626
1625
|
* <p>The content.</p>
|
|
1626
|
+
* @public
|
|
1627
1627
|
*/
|
|
1628
1628
|
content?: ContentData;
|
|
1629
1629
|
}
|
|
@@ -1632,77 +1632,77 @@ export interface GetContentResponse {
|
|
|
1632
1632
|
*/
|
|
1633
1633
|
export interface GetContentSummaryRequest {
|
|
1634
1634
|
/**
|
|
1635
|
-
* @public
|
|
1636
1635
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1636
|
+
* @public
|
|
1637
1637
|
*/
|
|
1638
1638
|
contentId: string | undefined;
|
|
1639
1639
|
/**
|
|
1640
|
-
* @public
|
|
1641
1640
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1642
1641
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1642
|
+
* @public
|
|
1643
1643
|
*/
|
|
1644
1644
|
knowledgeBaseId: string | undefined;
|
|
1645
1645
|
}
|
|
1646
1646
|
/**
|
|
1647
|
-
* @public
|
|
1648
1647
|
* <p>Summary information about the content.</p>
|
|
1648
|
+
* @public
|
|
1649
1649
|
*/
|
|
1650
1650
|
export interface ContentSummary {
|
|
1651
1651
|
/**
|
|
1652
|
-
* @public
|
|
1653
1652
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1653
|
+
* @public
|
|
1654
1654
|
*/
|
|
1655
1655
|
contentArn: string | undefined;
|
|
1656
1656
|
/**
|
|
1657
|
-
* @public
|
|
1658
1657
|
* <p>The identifier of the content.</p>
|
|
1658
|
+
* @public
|
|
1659
1659
|
*/
|
|
1660
1660
|
contentId: string | undefined;
|
|
1661
1661
|
/**
|
|
1662
|
-
* @public
|
|
1663
1662
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
knowledgeBaseArn: string | undefined;
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1669
1668
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
1669
|
+
* @public
|
|
1670
1670
|
*/
|
|
1671
1671
|
knowledgeBaseId: string | undefined;
|
|
1672
1672
|
/**
|
|
1673
|
-
* @public
|
|
1674
1673
|
* <p>The name of the content.</p>
|
|
1674
|
+
* @public
|
|
1675
1675
|
*/
|
|
1676
1676
|
name: string | undefined;
|
|
1677
1677
|
/**
|
|
1678
|
-
* @public
|
|
1679
1678
|
* <p>The identifier of the revision of the content.</p>
|
|
1679
|
+
* @public
|
|
1680
1680
|
*/
|
|
1681
1681
|
revisionId: string | undefined;
|
|
1682
1682
|
/**
|
|
1683
|
-
* @public
|
|
1684
1683
|
* <p>The title of the content.</p>
|
|
1684
|
+
* @public
|
|
1685
1685
|
*/
|
|
1686
1686
|
title: string | undefined;
|
|
1687
1687
|
/**
|
|
1688
|
-
* @public
|
|
1689
1688
|
* <p>The media type of the content.</p>
|
|
1689
|
+
* @public
|
|
1690
1690
|
*/
|
|
1691
1691
|
contentType: string | undefined;
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>The status of the content.</p>
|
|
1694
|
+
* @public
|
|
1695
1695
|
*/
|
|
1696
1696
|
status: ContentStatus | undefined;
|
|
1697
1697
|
/**
|
|
1698
|
-
* @public
|
|
1699
1698
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1700
1699
|
* For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1700
|
+
* @public
|
|
1701
1701
|
*/
|
|
1702
1702
|
metadata: Record<string, string> | undefined;
|
|
1703
1703
|
/**
|
|
1704
|
-
* @public
|
|
1705
1704
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
tags?: Record<string, string>;
|
|
1708
1708
|
}
|
|
@@ -1711,8 +1711,8 @@ export interface ContentSummary {
|
|
|
1711
1711
|
*/
|
|
1712
1712
|
export interface GetContentSummaryResponse {
|
|
1713
1713
|
/**
|
|
1714
|
-
* @public
|
|
1715
1714
|
* <p>The content summary.</p>
|
|
1715
|
+
* @public
|
|
1716
1716
|
*/
|
|
1717
1717
|
contentSummary?: ContentSummary;
|
|
1718
1718
|
}
|
|
@@ -1721,20 +1721,20 @@ export interface GetContentSummaryResponse {
|
|
|
1721
1721
|
*/
|
|
1722
1722
|
export interface ListContentsRequest {
|
|
1723
1723
|
/**
|
|
1724
|
-
* @public
|
|
1725
1724
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1726
1725
|
* response in the next request to retrieve the next set of results.</p>
|
|
1726
|
+
* @public
|
|
1727
1727
|
*/
|
|
1728
1728
|
nextToken?: string;
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The maximum number of results to return per page.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
maxResults?: number;
|
|
1734
1734
|
/**
|
|
1735
|
-
* @public
|
|
1736
1735
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1737
1736
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1737
|
+
* @public
|
|
1738
1738
|
*/
|
|
1739
1739
|
knowledgeBaseId: string | undefined;
|
|
1740
1740
|
}
|
|
@@ -1743,20 +1743,20 @@ export interface ListContentsRequest {
|
|
|
1743
1743
|
*/
|
|
1744
1744
|
export interface ListContentsResponse {
|
|
1745
1745
|
/**
|
|
1746
|
-
* @public
|
|
1747
1746
|
* <p>Information about the content.</p>
|
|
1747
|
+
* @public
|
|
1748
1748
|
*/
|
|
1749
1749
|
contentSummaries: ContentSummary[] | undefined;
|
|
1750
1750
|
/**
|
|
1751
|
-
* @public
|
|
1752
1751
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1752
|
+
* @public
|
|
1753
1753
|
*/
|
|
1754
1754
|
nextToken?: string;
|
|
1755
1755
|
}
|
|
1756
1756
|
/**
|
|
1757
|
-
* @public
|
|
1758
1757
|
* <p>The provided <code>revisionId</code> does not match, indicating the content has been
|
|
1759
1758
|
* modified since it was last read.</p>
|
|
1759
|
+
* @public
|
|
1760
1760
|
*/
|
|
1761
1761
|
export declare class PreconditionFailedException extends __BaseException {
|
|
1762
1762
|
readonly name: "PreconditionFailedException";
|
|
@@ -1771,53 +1771,53 @@ export declare class PreconditionFailedException extends __BaseException {
|
|
|
1771
1771
|
*/
|
|
1772
1772
|
export interface UpdateContentRequest {
|
|
1773
1773
|
/**
|
|
1774
|
-
* @public
|
|
1775
1774
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1776
1775
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
knowledgeBaseId: string | undefined;
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
contentId: string | undefined;
|
|
1784
1784
|
/**
|
|
1785
|
-
* @public
|
|
1786
1785
|
* <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call
|
|
1787
1786
|
* to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or
|
|
1788
1787
|
* <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure
|
|
1789
1788
|
* content was not modified since it was last read. If it has been modified, this API throws a
|
|
1790
1789
|
* <code>PreconditionFailedException</code>.</p>
|
|
1790
|
+
* @public
|
|
1791
1791
|
*/
|
|
1792
1792
|
revisionId?: string;
|
|
1793
1793
|
/**
|
|
1794
|
-
* @public
|
|
1795
1794
|
* <p>The title of the content.</p>
|
|
1795
|
+
* @public
|
|
1796
1796
|
*/
|
|
1797
1797
|
title?: string;
|
|
1798
1798
|
/**
|
|
1799
|
-
* @public
|
|
1800
1799
|
* <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
|
|
1801
1800
|
* overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
|
|
1802
1801
|
* exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
overrideLinkOutUri?: string;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>
|
|
1807
|
+
* @public
|
|
1808
1808
|
*/
|
|
1809
1809
|
removeOverrideLinkOutUri?: boolean;
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>A key/value map to store attributes without affecting tagging or recommendations. For
|
|
1813
1812
|
* example, when synchronizing data between an external system and Wisdom, you can store an
|
|
1814
1813
|
* external version identifier as metadata to utilize for determining drift.</p>
|
|
1814
|
+
* @public
|
|
1815
1815
|
*/
|
|
1816
1816
|
metadata?: Record<string, string>;
|
|
1817
1817
|
/**
|
|
1818
|
-
* @public
|
|
1819
1818
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.
|
|
1820
1819
|
* </p>
|
|
1820
|
+
* @public
|
|
1821
1821
|
*/
|
|
1822
1822
|
uploadId?: string;
|
|
1823
1823
|
}
|
|
@@ -1826,8 +1826,8 @@ export interface UpdateContentRequest {
|
|
|
1826
1826
|
*/
|
|
1827
1827
|
export interface UpdateContentResponse {
|
|
1828
1828
|
/**
|
|
1829
|
-
* @public
|
|
1830
1829
|
* <p>The content.</p>
|
|
1830
|
+
* @public
|
|
1831
1831
|
*/
|
|
1832
1832
|
content?: ContentData;
|
|
1833
1833
|
}
|
|
@@ -1845,12 +1845,11 @@ export declare const KnowledgeBaseType: {
|
|
|
1845
1845
|
*/
|
|
1846
1846
|
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>Information about how to render the content.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
export interface RenderingConfiguration {
|
|
1852
1852
|
/**
|
|
1853
|
-
* @public
|
|
1854
1853
|
* <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
|
|
1855
1854
|
* This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
|
|
1856
1855
|
* and Zendesk, the variable must be one of the following:</p>
|
|
@@ -1872,12 +1871,13 @@ export interface RenderingConfiguration {
|
|
|
1872
1871
|
* </li>
|
|
1873
1872
|
* </ul>
|
|
1874
1873
|
* <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
|
|
1874
|
+
* @public
|
|
1875
1875
|
*/
|
|
1876
1876
|
templateUri?: string;
|
|
1877
1877
|
}
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>Configuration information about the external data source.</p>
|
|
1880
|
+
* @public
|
|
1881
1881
|
*/
|
|
1882
1882
|
export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.$UnknownMember;
|
|
1883
1883
|
/**
|
|
@@ -1885,8 +1885,8 @@ export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | So
|
|
|
1885
1885
|
*/
|
|
1886
1886
|
export declare namespace SourceConfiguration {
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
1889
|
+
* @public
|
|
1890
1890
|
*/
|
|
1891
1891
|
interface AppIntegrationsMember {
|
|
1892
1892
|
appIntegrations: AppIntegrationsConfiguration;
|
|
@@ -1910,54 +1910,54 @@ export declare namespace SourceConfiguration {
|
|
|
1910
1910
|
*/
|
|
1911
1911
|
export interface CreateKnowledgeBaseRequest {
|
|
1912
1912
|
/**
|
|
1913
|
-
* @public
|
|
1914
1913
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1915
1914
|
* request. If not provided, the Amazon Web Services
|
|
1916
1915
|
* SDK populates this field. For more information about idempotency, see
|
|
1917
1916
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1917
|
+
* @public
|
|
1918
1918
|
*/
|
|
1919
1919
|
clientToken?: string;
|
|
1920
1920
|
/**
|
|
1921
|
-
* @public
|
|
1922
1921
|
* <p>The name of the knowledge base.</p>
|
|
1922
|
+
* @public
|
|
1923
1923
|
*/
|
|
1924
1924
|
name: string | undefined;
|
|
1925
1925
|
/**
|
|
1926
|
-
* @public
|
|
1927
1926
|
* <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.
|
|
1928
1927
|
* EXTERNAL knowledge bases support integrations with third-party systems whose content is
|
|
1929
1928
|
* synchronized automatically. </p>
|
|
1929
|
+
* @public
|
|
1930
1930
|
*/
|
|
1931
1931
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
1932
1932
|
/**
|
|
1933
|
-
* @public
|
|
1934
1933
|
* <p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge
|
|
1935
1934
|
* bases.</p>
|
|
1935
|
+
* @public
|
|
1936
1936
|
*/
|
|
1937
1937
|
sourceConfiguration?: SourceConfiguration;
|
|
1938
1938
|
/**
|
|
1939
|
-
* @public
|
|
1940
1939
|
* <p>Information about how to render the content.</p>
|
|
1940
|
+
* @public
|
|
1941
1941
|
*/
|
|
1942
1942
|
renderingConfiguration?: RenderingConfiguration;
|
|
1943
1943
|
/**
|
|
1944
|
-
* @public
|
|
1945
1944
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
1946
1945
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
1947
1946
|
* <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
1948
1947
|
* to invoke Wisdom.</p>
|
|
1949
1948
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
1950
1949
|
* for your instance</a>.</p>
|
|
1950
|
+
* @public
|
|
1951
1951
|
*/
|
|
1952
1952
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1953
1953
|
/**
|
|
1954
|
-
* @public
|
|
1955
1954
|
* <p>The description.</p>
|
|
1955
|
+
* @public
|
|
1956
1956
|
*/
|
|
1957
1957
|
description?: string;
|
|
1958
1958
|
/**
|
|
1959
|
-
* @public
|
|
1960
1959
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1960
|
+
* @public
|
|
1961
1961
|
*/
|
|
1962
1962
|
tags?: Record<string, string>;
|
|
1963
1963
|
}
|
|
@@ -1978,70 +1978,70 @@ export declare const KnowledgeBaseStatus: {
|
|
|
1978
1978
|
*/
|
|
1979
1979
|
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
1980
1980
|
/**
|
|
1981
|
-
* @public
|
|
1982
1981
|
* <p>Information about the knowledge base.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
export interface KnowledgeBaseData {
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1988
1987
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
1988
|
+
* @public
|
|
1989
1989
|
*/
|
|
1990
1990
|
knowledgeBaseId: string | undefined;
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
knowledgeBaseArn: string | undefined;
|
|
1996
1996
|
/**
|
|
1997
|
-
* @public
|
|
1998
1997
|
* <p>The name of the knowledge base.</p>
|
|
1998
|
+
* @public
|
|
1999
1999
|
*/
|
|
2000
2000
|
name: string | undefined;
|
|
2001
2001
|
/**
|
|
2002
|
-
* @public
|
|
2003
2002
|
* <p>The type of knowledge base.</p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
2006
2006
|
/**
|
|
2007
|
-
* @public
|
|
2008
2007
|
* <p>The status of the knowledge base.</p>
|
|
2008
|
+
* @public
|
|
2009
2009
|
*/
|
|
2010
2010
|
status: KnowledgeBaseStatus | undefined;
|
|
2011
2011
|
/**
|
|
2012
|
-
* @public
|
|
2013
2012
|
* <p>An epoch timestamp indicating the most recent content modification inside the knowledge
|
|
2014
2013
|
* base. If no content exists in a knowledge base, this value is unset.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
lastContentModificationTime?: Date;
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p>Source configuration information about the knowledge base.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
sourceConfiguration?: SourceConfiguration;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>Information about how to render the content.</p>
|
|
2024
|
+
* @public
|
|
2025
2025
|
*/
|
|
2026
2026
|
renderingConfiguration?: RenderingConfiguration;
|
|
2027
2027
|
/**
|
|
2028
|
-
* @public
|
|
2029
2028
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2030
2029
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2031
2030
|
* <code>kms:DescribeKey</code>, and <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
2032
2031
|
* to invoke Wisdom. </p>
|
|
2033
2032
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
2034
2033
|
* for your instance</a>.</p>
|
|
2034
|
+
* @public
|
|
2035
2035
|
*/
|
|
2036
2036
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2037
2037
|
/**
|
|
2038
|
-
* @public
|
|
2039
2038
|
* <p>The description.</p>
|
|
2039
|
+
* @public
|
|
2040
2040
|
*/
|
|
2041
2041
|
description?: string;
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
tags?: Record<string, string>;
|
|
2047
2047
|
}
|
|
@@ -2050,14 +2050,14 @@ export interface KnowledgeBaseData {
|
|
|
2050
2050
|
*/
|
|
2051
2051
|
export interface CreateKnowledgeBaseResponse {
|
|
2052
2052
|
/**
|
|
2053
|
-
* @public
|
|
2054
2053
|
* <p>The knowledge base.</p>
|
|
2054
|
+
* @public
|
|
2055
2055
|
*/
|
|
2056
2056
|
knowledgeBase?: KnowledgeBaseData;
|
|
2057
2057
|
}
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>The container of quick response data.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
|
|
2063
2063
|
/**
|
|
@@ -2065,8 +2065,8 @@ export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember
|
|
|
2065
2065
|
*/
|
|
2066
2066
|
export declare namespace QuickResponseDataProvider {
|
|
2067
2067
|
/**
|
|
2068
|
-
* @public
|
|
2069
2068
|
* <p>The content of the quick response.</p>
|
|
2069
|
+
* @public
|
|
2070
2070
|
*/
|
|
2071
2071
|
interface ContentMember {
|
|
2072
2072
|
content: string;
|
|
@@ -2086,12 +2086,11 @@ export declare namespace QuickResponseDataProvider {
|
|
|
2086
2086
|
const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
|
|
2087
2087
|
}
|
|
2088
2088
|
/**
|
|
2089
|
-
* @public
|
|
2090
2089
|
* <p>The configuration information of the grouping of Wisdom users.</p>
|
|
2090
|
+
* @public
|
|
2091
2091
|
*/
|
|
2092
2092
|
export interface GroupingConfiguration {
|
|
2093
2093
|
/**
|
|
2094
|
-
* @public
|
|
2095
2094
|
* <p>The criteria used for grouping Wisdom users.</p>
|
|
2096
2095
|
* <p>The following is the list of supported criteria values.</p>
|
|
2097
2096
|
* <ul>
|
|
@@ -2101,10 +2100,10 @@ export interface GroupingConfiguration {
|
|
|
2101
2100
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
|
|
2102
2101
|
* </li>
|
|
2103
2102
|
* </ul>
|
|
2103
|
+
* @public
|
|
2104
2104
|
*/
|
|
2105
2105
|
criteria?: string;
|
|
2106
2106
|
/**
|
|
2107
|
-
* @public
|
|
2108
2107
|
* <p>The list of values that define different groups of Wisdom users.</p>
|
|
2109
2108
|
* <ul>
|
|
2110
2109
|
* <li>
|
|
@@ -2112,6 +2111,7 @@ export interface GroupingConfiguration {
|
|
|
2112
2111
|
* ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p>
|
|
2113
2112
|
* </li>
|
|
2114
2113
|
* </ul>
|
|
2114
|
+
* @public
|
|
2115
2115
|
*/
|
|
2116
2116
|
values?: string[];
|
|
2117
2117
|
}
|
|
@@ -2120,23 +2120,22 @@ export interface GroupingConfiguration {
|
|
|
2120
2120
|
*/
|
|
2121
2121
|
export interface CreateQuickResponseRequest {
|
|
2122
2122
|
/**
|
|
2123
|
-
* @public
|
|
2124
2123
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2125
2124
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
knowledgeBaseId: string | undefined;
|
|
2128
2128
|
/**
|
|
2129
|
-
* @public
|
|
2130
2129
|
* <p>The name of the quick response.</p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
name: string | undefined;
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p>The content of the quick response.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
content: QuickResponseDataProvider | undefined;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The media type of the quick response content.</p>
|
|
2141
2140
|
* <ul>
|
|
2142
2141
|
* <li>
|
|
@@ -2146,60 +2145,61 @@ export interface CreateQuickResponseRequest {
|
|
|
2146
2145
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p>
|
|
2147
2146
|
* </li>
|
|
2148
2147
|
* </ul>
|
|
2148
|
+
* @public
|
|
2149
2149
|
*/
|
|
2150
2150
|
contentType?: string;
|
|
2151
2151
|
/**
|
|
2152
|
-
* @public
|
|
2153
2152
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
2153
|
+
* @public
|
|
2154
2154
|
*/
|
|
2155
2155
|
groupingConfiguration?: GroupingConfiguration;
|
|
2156
2156
|
/**
|
|
2157
|
-
* @public
|
|
2158
2157
|
* <p>The description of the quick response.</p>
|
|
2158
|
+
* @public
|
|
2159
2159
|
*/
|
|
2160
2160
|
description?: string;
|
|
2161
2161
|
/**
|
|
2162
|
-
* @public
|
|
2163
2162
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2164
2163
|
* knowledge base.
|
|
2165
2164
|
* </p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
shortcutKey?: string;
|
|
2168
2168
|
/**
|
|
2169
|
-
* @public
|
|
2170
2169
|
* <p>Whether the quick response is active.</p>
|
|
2170
|
+
* @public
|
|
2171
2171
|
*/
|
|
2172
2172
|
isActive?: boolean;
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
2175
|
+
* @public
|
|
2176
2176
|
*/
|
|
2177
2177
|
channels?: string[];
|
|
2178
2178
|
/**
|
|
2179
|
-
* @public
|
|
2180
2179
|
* <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
|
|
2181
2180
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
2182
2181
|
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
2183
2182
|
* </p>
|
|
2183
|
+
* @public
|
|
2184
2184
|
*/
|
|
2185
2185
|
language?: string;
|
|
2186
2186
|
/**
|
|
2187
|
-
* @public
|
|
2188
2187
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2189
2188
|
* request. If not provided, the Amazon Web Services
|
|
2190
2189
|
* SDK populates this field. For more information about idempotency, see
|
|
2191
2190
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2191
|
+
* @public
|
|
2192
2192
|
*/
|
|
2193
2193
|
clientToken?: string;
|
|
2194
2194
|
/**
|
|
2195
|
-
* @public
|
|
2196
2195
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
tags?: Record<string, string>;
|
|
2199
2199
|
}
|
|
2200
2200
|
/**
|
|
2201
|
-
* @public
|
|
2202
2201
|
* <p>The container quick response content.</p>
|
|
2202
|
+
* @public
|
|
2203
2203
|
*/
|
|
2204
2204
|
export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
|
|
2205
2205
|
/**
|
|
@@ -2207,8 +2207,8 @@ export type QuickResponseContentProvider = QuickResponseContentProvider.ContentM
|
|
|
2207
2207
|
*/
|
|
2208
2208
|
export declare namespace QuickResponseContentProvider {
|
|
2209
2209
|
/**
|
|
2210
|
-
* @public
|
|
2211
2210
|
* <p>The content of the quick response.</p>
|
|
2211
|
+
* @public
|
|
2212
2212
|
*/
|
|
2213
2213
|
interface ContentMember {
|
|
2214
2214
|
content: string;
|
|
@@ -2228,18 +2228,18 @@ export declare namespace QuickResponseContentProvider {
|
|
|
2228
2228
|
const visit: <T>(value: QuickResponseContentProvider, visitor: Visitor<T>) => T;
|
|
2229
2229
|
}
|
|
2230
2230
|
/**
|
|
2231
|
-
* @public
|
|
2232
2231
|
* <p>The content of the quick response stored in different media types.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
export interface QuickResponseContents {
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>The container quick response content.</p>
|
|
2237
|
+
* @public
|
|
2238
2238
|
*/
|
|
2239
2239
|
plainText?: QuickResponseContentProvider;
|
|
2240
2240
|
/**
|
|
2241
|
-
* @public
|
|
2242
2241
|
* <p>The container quick response content.</p>
|
|
2242
|
+
* @public
|
|
2243
2243
|
*/
|
|
2244
2244
|
markdown?: QuickResponseContentProvider;
|
|
2245
2245
|
}
|
|
@@ -2262,38 +2262,37 @@ export declare const QuickResponseStatus: {
|
|
|
2262
2262
|
*/
|
|
2263
2263
|
export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
|
|
2264
2264
|
/**
|
|
2265
|
-
* @public
|
|
2266
2265
|
* <p>Information about the quick response.</p>
|
|
2266
|
+
* @public
|
|
2267
2267
|
*/
|
|
2268
2268
|
export interface QuickResponseData {
|
|
2269
2269
|
/**
|
|
2270
|
-
* @public
|
|
2271
2270
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
2271
|
+
* @public
|
|
2272
2272
|
*/
|
|
2273
2273
|
quickResponseArn: string | undefined;
|
|
2274
2274
|
/**
|
|
2275
|
-
* @public
|
|
2276
2275
|
* <p>The identifier of the quick response.</p>
|
|
2276
|
+
* @public
|
|
2277
2277
|
*/
|
|
2278
2278
|
quickResponseId: string | undefined;
|
|
2279
2279
|
/**
|
|
2280
|
-
* @public
|
|
2281
2280
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2281
|
+
* @public
|
|
2282
2282
|
*/
|
|
2283
2283
|
knowledgeBaseArn: string | undefined;
|
|
2284
2284
|
/**
|
|
2285
|
-
* @public
|
|
2286
2285
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2287
2286
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2287
|
+
* @public
|
|
2288
2288
|
*/
|
|
2289
2289
|
knowledgeBaseId: string | undefined;
|
|
2290
2290
|
/**
|
|
2291
|
-
* @public
|
|
2292
2291
|
* <p>The name of the quick response.</p>
|
|
2292
|
+
* @public
|
|
2293
2293
|
*/
|
|
2294
2294
|
name: string | undefined;
|
|
2295
2295
|
/**
|
|
2296
|
-
* @public
|
|
2297
2296
|
* <p>The media type of the quick response content.</p>
|
|
2298
2297
|
* <ul>
|
|
2299
2298
|
* <li>
|
|
@@ -2303,67 +2302,68 @@ export interface QuickResponseData {
|
|
|
2303
2302
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
2304
2303
|
* </li>
|
|
2305
2304
|
* </ul>
|
|
2305
|
+
* @public
|
|
2306
2306
|
*/
|
|
2307
2307
|
contentType: string | undefined;
|
|
2308
2308
|
/**
|
|
2309
|
-
* @public
|
|
2310
2309
|
* <p>The status of the quick response data.</p>
|
|
2310
|
+
* @public
|
|
2311
2311
|
*/
|
|
2312
2312
|
status: QuickResponseStatus | undefined;
|
|
2313
2313
|
/**
|
|
2314
|
-
* @public
|
|
2315
2314
|
* <p>The timestamp when the quick response was created.</p>
|
|
2315
|
+
* @public
|
|
2316
2316
|
*/
|
|
2317
2317
|
createdTime: Date | undefined;
|
|
2318
2318
|
/**
|
|
2319
|
-
* @public
|
|
2320
2319
|
* <p>The timestamp when the quick response data was last modified.</p>
|
|
2320
|
+
* @public
|
|
2321
2321
|
*/
|
|
2322
2322
|
lastModifiedTime: Date | undefined;
|
|
2323
2323
|
/**
|
|
2324
|
-
* @public
|
|
2325
2324
|
* <p>The contents of the quick response.</p>
|
|
2325
|
+
* @public
|
|
2326
2326
|
*/
|
|
2327
2327
|
contents?: QuickResponseContents;
|
|
2328
2328
|
/**
|
|
2329
|
-
* @public
|
|
2330
2329
|
* <p>The description of the quick response.</p>
|
|
2330
|
+
* @public
|
|
2331
2331
|
*/
|
|
2332
2332
|
description?: string;
|
|
2333
2333
|
/**
|
|
2334
|
-
* @public
|
|
2335
2334
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
2335
|
+
* @public
|
|
2336
2336
|
*/
|
|
2337
2337
|
groupingConfiguration?: GroupingConfiguration;
|
|
2338
2338
|
/**
|
|
2339
|
-
* @public
|
|
2340
2339
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2341
2340
|
* knowledge base.</p>
|
|
2341
|
+
* @public
|
|
2342
2342
|
*/
|
|
2343
2343
|
shortcutKey?: string;
|
|
2344
2344
|
/**
|
|
2345
|
-
* @public
|
|
2346
2345
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
2346
|
+
* @public
|
|
2347
2347
|
*/
|
|
2348
2348
|
lastModifiedBy?: string;
|
|
2349
2349
|
/**
|
|
2350
|
-
* @public
|
|
2351
2350
|
* <p>Whether the quick response is active.</p>
|
|
2351
|
+
* @public
|
|
2352
2352
|
*/
|
|
2353
2353
|
isActive?: boolean;
|
|
2354
2354
|
/**
|
|
2355
|
-
* @public
|
|
2356
2355
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
2356
|
+
* @public
|
|
2357
2357
|
*/
|
|
2358
2358
|
channels?: string[];
|
|
2359
2359
|
/**
|
|
2360
|
-
* @public
|
|
2361
2360
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
language?: string;
|
|
2364
2364
|
/**
|
|
2365
|
-
* @public
|
|
2366
2365
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2366
|
+
* @public
|
|
2367
2367
|
*/
|
|
2368
2368
|
tags?: Record<string, string>;
|
|
2369
2369
|
}
|
|
@@ -2372,8 +2372,8 @@ export interface QuickResponseData {
|
|
|
2372
2372
|
*/
|
|
2373
2373
|
export interface CreateQuickResponseResponse {
|
|
2374
2374
|
/**
|
|
2375
|
-
* @public
|
|
2376
2375
|
* <p>The quick response.</p>
|
|
2376
|
+
* @public
|
|
2377
2377
|
*/
|
|
2378
2378
|
quickResponse?: QuickResponseData;
|
|
2379
2379
|
}
|
|
@@ -2382,14 +2382,14 @@ export interface CreateQuickResponseResponse {
|
|
|
2382
2382
|
*/
|
|
2383
2383
|
export interface DeleteImportJobRequest {
|
|
2384
2384
|
/**
|
|
2385
|
-
* @public
|
|
2386
2385
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2387
2386
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2387
|
+
* @public
|
|
2388
2388
|
*/
|
|
2389
2389
|
knowledgeBaseId: string | undefined;
|
|
2390
2390
|
/**
|
|
2391
|
-
* @public
|
|
2392
2391
|
* <p>The identifier of the import job to be deleted.</p>
|
|
2392
|
+
* @public
|
|
2393
2393
|
*/
|
|
2394
2394
|
importJobId: string | undefined;
|
|
2395
2395
|
}
|
|
@@ -2403,8 +2403,8 @@ export interface DeleteImportJobResponse {
|
|
|
2403
2403
|
*/
|
|
2404
2404
|
export interface DeleteKnowledgeBaseRequest {
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2407
|
+
* @public
|
|
2408
2408
|
*/
|
|
2409
2409
|
knowledgeBaseId: string | undefined;
|
|
2410
2410
|
}
|
|
@@ -2418,14 +2418,14 @@ export interface DeleteKnowledgeBaseResponse {
|
|
|
2418
2418
|
*/
|
|
2419
2419
|
export interface DeleteQuickResponseRequest {
|
|
2420
2420
|
/**
|
|
2421
|
-
* @public
|
|
2422
2421
|
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2423
2422
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2423
|
+
* @public
|
|
2424
2424
|
*/
|
|
2425
2425
|
knowledgeBaseId: string | undefined;
|
|
2426
2426
|
/**
|
|
2427
|
-
* @public
|
|
2428
2427
|
* <p>The identifier of the quick response to delete.</p>
|
|
2428
|
+
* @public
|
|
2429
2429
|
*/
|
|
2430
2430
|
quickResponseId: string | undefined;
|
|
2431
2431
|
}
|
|
@@ -2446,18 +2446,18 @@ export declare const ExternalSource: {
|
|
|
2446
2446
|
*/
|
|
2447
2447
|
export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
|
|
2448
2448
|
/**
|
|
2449
|
-
* @public
|
|
2450
2449
|
* <p>The configuration information of the external data source.</p>
|
|
2450
|
+
* @public
|
|
2451
2451
|
*/
|
|
2452
2452
|
export interface ExternalSourceConfiguration {
|
|
2453
2453
|
/**
|
|
2454
|
-
* @public
|
|
2455
2454
|
* <p>The type of the external data source.</p>
|
|
2455
|
+
* @public
|
|
2456
2456
|
*/
|
|
2457
2457
|
source: ExternalSource | undefined;
|
|
2458
2458
|
/**
|
|
2459
|
-
* @public
|
|
2460
2459
|
* <p>The configuration information of the external data source.</p>
|
|
2460
|
+
* @public
|
|
2461
2461
|
*/
|
|
2462
2462
|
configuration: Configuration | undefined;
|
|
2463
2463
|
}
|
|
@@ -2466,13 +2466,13 @@ export interface ExternalSourceConfiguration {
|
|
|
2466
2466
|
*/
|
|
2467
2467
|
export interface GetImportJobRequest {
|
|
2468
2468
|
/**
|
|
2469
|
-
* @public
|
|
2470
2469
|
* <p>The identifier of the import job to retrieve.</p>
|
|
2470
|
+
* @public
|
|
2471
2471
|
*/
|
|
2472
2472
|
importJobId: string | undefined;
|
|
2473
2473
|
/**
|
|
2474
|
-
* @public
|
|
2475
2474
|
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
2475
|
+
* @public
|
|
2476
2476
|
*/
|
|
2477
2477
|
knowledgeBaseId: string | undefined;
|
|
2478
2478
|
}
|
|
@@ -2504,74 +2504,74 @@ export declare const ImportJobStatus: {
|
|
|
2504
2504
|
*/
|
|
2505
2505
|
export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
|
|
2506
2506
|
/**
|
|
2507
|
-
* @public
|
|
2508
2507
|
* <p>Summary information about the import job.</p>
|
|
2508
|
+
* @public
|
|
2509
2509
|
*/
|
|
2510
2510
|
export interface ImportJobData {
|
|
2511
2511
|
/**
|
|
2512
|
-
* @public
|
|
2513
2512
|
* <p>The identifier of the import job.</p>
|
|
2513
|
+
* @public
|
|
2514
2514
|
*/
|
|
2515
2515
|
importJobId: string | undefined;
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2519
2518
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
knowledgeBaseId: string | undefined;
|
|
2522
2522
|
/**
|
|
2523
|
-
* @public
|
|
2524
2523
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
2524
|
+
* @public
|
|
2525
2525
|
*/
|
|
2526
2526
|
uploadId: string | undefined;
|
|
2527
2527
|
/**
|
|
2528
|
-
* @public
|
|
2529
2528
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2529
|
+
* @public
|
|
2530
2530
|
*/
|
|
2531
2531
|
knowledgeBaseArn: string | undefined;
|
|
2532
2532
|
/**
|
|
2533
|
-
* @public
|
|
2534
2533
|
* <p>The type of the import job.</p>
|
|
2534
|
+
* @public
|
|
2535
2535
|
*/
|
|
2536
2536
|
importJobType: ImportJobType | undefined;
|
|
2537
2537
|
/**
|
|
2538
|
-
* @public
|
|
2539
2538
|
* <p>The status of the import job.</p>
|
|
2539
|
+
* @public
|
|
2540
2540
|
*/
|
|
2541
2541
|
status: ImportJobStatus | undefined;
|
|
2542
2542
|
/**
|
|
2543
|
-
* @public
|
|
2544
2543
|
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
2544
|
+
* @public
|
|
2545
2545
|
*/
|
|
2546
2546
|
url: string | undefined;
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>The link to donwload the information of resource data that failed to be imported.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
failedRecordReport?: string;
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
2554
|
+
* @public
|
|
2555
2555
|
*/
|
|
2556
2556
|
urlExpiry: Date | undefined;
|
|
2557
2557
|
/**
|
|
2558
|
-
* @public
|
|
2559
2558
|
* <p>The timestamp when the import job was created.</p>
|
|
2559
|
+
* @public
|
|
2560
2560
|
*/
|
|
2561
2561
|
createdTime: Date | undefined;
|
|
2562
2562
|
/**
|
|
2563
|
-
* @public
|
|
2564
2563
|
* <p>The timestamp when the import job data was last modified.</p>
|
|
2564
|
+
* @public
|
|
2565
2565
|
*/
|
|
2566
2566
|
lastModifiedTime: Date | undefined;
|
|
2567
2567
|
/**
|
|
2568
|
-
* @public
|
|
2569
2568
|
* <p>The metadata fields of the imported Wisdom resources.</p>
|
|
2569
|
+
* @public
|
|
2570
2570
|
*/
|
|
2571
2571
|
metadata?: Record<string, string>;
|
|
2572
2572
|
/**
|
|
2573
|
-
* @public
|
|
2574
2573
|
* <p>The configuration information of the external data source.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
2577
2577
|
}
|
|
@@ -2580,8 +2580,8 @@ export interface ImportJobData {
|
|
|
2580
2580
|
*/
|
|
2581
2581
|
export interface GetImportJobResponse {
|
|
2582
2582
|
/**
|
|
2583
|
-
* @public
|
|
2584
2583
|
* <p>The import job.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
importJob?: ImportJobData;
|
|
2587
2587
|
}
|
|
@@ -2590,9 +2590,9 @@ export interface GetImportJobResponse {
|
|
|
2590
2590
|
*/
|
|
2591
2591
|
export interface GetKnowledgeBaseRequest {
|
|
2592
2592
|
/**
|
|
2593
|
-
* @public
|
|
2594
2593
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2595
2594
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2595
|
+
* @public
|
|
2596
2596
|
*/
|
|
2597
2597
|
knowledgeBaseId: string | undefined;
|
|
2598
2598
|
}
|
|
@@ -2601,8 +2601,8 @@ export interface GetKnowledgeBaseRequest {
|
|
|
2601
2601
|
*/
|
|
2602
2602
|
export interface GetKnowledgeBaseResponse {
|
|
2603
2603
|
/**
|
|
2604
|
-
* @public
|
|
2605
2604
|
* <p>The knowledge base.</p>
|
|
2605
|
+
* @public
|
|
2606
2606
|
*/
|
|
2607
2607
|
knowledgeBase?: KnowledgeBaseData;
|
|
2608
2608
|
}
|
|
@@ -2611,13 +2611,13 @@ export interface GetKnowledgeBaseResponse {
|
|
|
2611
2611
|
*/
|
|
2612
2612
|
export interface GetQuickResponseRequest {
|
|
2613
2613
|
/**
|
|
2614
|
-
* @public
|
|
2615
2614
|
* <p>The identifier of the quick response.</p>
|
|
2615
|
+
* @public
|
|
2616
2616
|
*/
|
|
2617
2617
|
quickResponseId: string | undefined;
|
|
2618
2618
|
/**
|
|
2619
|
-
* @public
|
|
2620
2619
|
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
2620
|
+
* @public
|
|
2621
2621
|
*/
|
|
2622
2622
|
knowledgeBaseId: string | undefined;
|
|
2623
2623
|
}
|
|
@@ -2626,65 +2626,65 @@ export interface GetQuickResponseRequest {
|
|
|
2626
2626
|
*/
|
|
2627
2627
|
export interface GetQuickResponseResponse {
|
|
2628
2628
|
/**
|
|
2629
|
-
* @public
|
|
2630
2629
|
* <p>The quick response.</p>
|
|
2630
|
+
* @public
|
|
2631
2631
|
*/
|
|
2632
2632
|
quickResponse?: QuickResponseData;
|
|
2633
2633
|
}
|
|
2634
2634
|
/**
|
|
2635
|
-
* @public
|
|
2636
2635
|
* <p>Summary information about the import job.</p>
|
|
2636
|
+
* @public
|
|
2637
2637
|
*/
|
|
2638
2638
|
export interface ImportJobSummary {
|
|
2639
2639
|
/**
|
|
2640
|
-
* @public
|
|
2641
2640
|
* <p>The identifier of the import job.</p>
|
|
2641
|
+
* @public
|
|
2642
2642
|
*/
|
|
2643
2643
|
importJobId: string | undefined;
|
|
2644
2644
|
/**
|
|
2645
|
-
* @public
|
|
2646
2645
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2647
2646
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2647
|
+
* @public
|
|
2648
2648
|
*/
|
|
2649
2649
|
knowledgeBaseId: string | undefined;
|
|
2650
2650
|
/**
|
|
2651
|
-
* @public
|
|
2652
2651
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
2652
|
+
* @public
|
|
2653
2653
|
*/
|
|
2654
2654
|
uploadId: string | undefined;
|
|
2655
2655
|
/**
|
|
2656
|
-
* @public
|
|
2657
2656
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2657
|
+
* @public
|
|
2658
2658
|
*/
|
|
2659
2659
|
knowledgeBaseArn: string | undefined;
|
|
2660
2660
|
/**
|
|
2661
|
-
* @public
|
|
2662
2661
|
* <p>The type of import job.</p>
|
|
2662
|
+
* @public
|
|
2663
2663
|
*/
|
|
2664
2664
|
importJobType: ImportJobType | undefined;
|
|
2665
2665
|
/**
|
|
2666
|
-
* @public
|
|
2667
2666
|
* <p>The status of the import job.</p>
|
|
2667
|
+
* @public
|
|
2668
2668
|
*/
|
|
2669
2669
|
status: ImportJobStatus | undefined;
|
|
2670
2670
|
/**
|
|
2671
|
-
* @public
|
|
2672
2671
|
* <p>The timestamp when the import job was created.</p>
|
|
2672
|
+
* @public
|
|
2673
2673
|
*/
|
|
2674
2674
|
createdTime: Date | undefined;
|
|
2675
2675
|
/**
|
|
2676
|
-
* @public
|
|
2677
2676
|
* <p>The timestamp when the import job was last modified.</p>
|
|
2677
|
+
* @public
|
|
2678
2678
|
*/
|
|
2679
2679
|
lastModifiedTime: Date | undefined;
|
|
2680
2680
|
/**
|
|
2681
|
-
* @public
|
|
2682
2681
|
* <p>The metadata fields of the imported Wisdom resources.</p>
|
|
2682
|
+
* @public
|
|
2683
2683
|
*/
|
|
2684
2684
|
metadata?: Record<string, string>;
|
|
2685
2685
|
/**
|
|
2686
|
-
* @public
|
|
2687
2686
|
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
2687
|
+
* @public
|
|
2688
2688
|
*/
|
|
2689
2689
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
2690
2690
|
}
|
|
@@ -2693,20 +2693,20 @@ export interface ImportJobSummary {
|
|
|
2693
2693
|
*/
|
|
2694
2694
|
export interface ListImportJobsRequest {
|
|
2695
2695
|
/**
|
|
2696
|
-
* @public
|
|
2697
2696
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2698
2697
|
* response in the next request to retrieve the next set of results.</p>
|
|
2698
|
+
* @public
|
|
2699
2699
|
*/
|
|
2700
2700
|
nextToken?: string;
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>The maximum number of results to return per page.</p>
|
|
2703
|
+
* @public
|
|
2704
2704
|
*/
|
|
2705
2705
|
maxResults?: number;
|
|
2706
2706
|
/**
|
|
2707
|
-
* @public
|
|
2708
2707
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2709
2708
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
knowledgeBaseId: string | undefined;
|
|
2712
2712
|
}
|
|
@@ -2715,14 +2715,14 @@ export interface ListImportJobsRequest {
|
|
|
2715
2715
|
*/
|
|
2716
2716
|
export interface ListImportJobsResponse {
|
|
2717
2717
|
/**
|
|
2718
|
-
* @public
|
|
2719
2718
|
* <p>Summary information about the import jobs.</p>
|
|
2719
|
+
* @public
|
|
2720
2720
|
*/
|
|
2721
2721
|
importJobSummaries: ImportJobSummary[] | undefined;
|
|
2722
2722
|
/**
|
|
2723
|
-
* @public
|
|
2724
2723
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2725
2724
|
* response in the next request to retrieve the next set of results.</p>
|
|
2725
|
+
* @public
|
|
2726
2726
|
*/
|
|
2727
2727
|
nextToken?: string;
|
|
2728
2728
|
}
|
|
@@ -2731,76 +2731,76 @@ export interface ListImportJobsResponse {
|
|
|
2731
2731
|
*/
|
|
2732
2732
|
export interface ListKnowledgeBasesRequest {
|
|
2733
2733
|
/**
|
|
2734
|
-
* @public
|
|
2735
2734
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2736
2735
|
* response in the next request to retrieve the next set of results.</p>
|
|
2736
|
+
* @public
|
|
2737
2737
|
*/
|
|
2738
2738
|
nextToken?: string;
|
|
2739
2739
|
/**
|
|
2740
|
-
* @public
|
|
2741
2740
|
* <p>The maximum number of results to return per page.</p>
|
|
2741
|
+
* @public
|
|
2742
2742
|
*/
|
|
2743
2743
|
maxResults?: number;
|
|
2744
2744
|
}
|
|
2745
2745
|
/**
|
|
2746
|
-
* @public
|
|
2747
2746
|
* <p>Summary information about the knowledge base.</p>
|
|
2747
|
+
* @public
|
|
2748
2748
|
*/
|
|
2749
2749
|
export interface KnowledgeBaseSummary {
|
|
2750
2750
|
/**
|
|
2751
|
-
* @public
|
|
2752
2751
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2753
2752
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2753
|
+
* @public
|
|
2754
2754
|
*/
|
|
2755
2755
|
knowledgeBaseId: string | undefined;
|
|
2756
2756
|
/**
|
|
2757
|
-
* @public
|
|
2758
2757
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2758
|
+
* @public
|
|
2759
2759
|
*/
|
|
2760
2760
|
knowledgeBaseArn: string | undefined;
|
|
2761
2761
|
/**
|
|
2762
|
-
* @public
|
|
2763
2762
|
* <p>The name of the knowledge base.</p>
|
|
2763
|
+
* @public
|
|
2764
2764
|
*/
|
|
2765
2765
|
name: string | undefined;
|
|
2766
2766
|
/**
|
|
2767
|
-
* @public
|
|
2768
2767
|
* <p>The type of knowledge base.</p>
|
|
2768
|
+
* @public
|
|
2769
2769
|
*/
|
|
2770
2770
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
2771
2771
|
/**
|
|
2772
|
-
* @public
|
|
2773
2772
|
* <p>The status of the knowledge base summary.</p>
|
|
2773
|
+
* @public
|
|
2774
2774
|
*/
|
|
2775
2775
|
status: KnowledgeBaseStatus | undefined;
|
|
2776
2776
|
/**
|
|
2777
|
-
* @public
|
|
2778
2777
|
* <p>Configuration information about the external data source.</p>
|
|
2778
|
+
* @public
|
|
2779
2779
|
*/
|
|
2780
2780
|
sourceConfiguration?: SourceConfiguration;
|
|
2781
2781
|
/**
|
|
2782
|
-
* @public
|
|
2783
2782
|
* <p>Information about how to render the content.</p>
|
|
2783
|
+
* @public
|
|
2784
2784
|
*/
|
|
2785
2785
|
renderingConfiguration?: RenderingConfiguration;
|
|
2786
2786
|
/**
|
|
2787
|
-
* @public
|
|
2788
2787
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2789
2788
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2790
2789
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt/kms:GenerateDataKey</code> permissions to the IAM identity using the key
|
|
2791
2790
|
* to invoke Wisdom. </p>
|
|
2792
2791
|
* <p>For more information about setting up a customer managed key for Wisdom, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html">Enable Amazon Connect Wisdom
|
|
2793
2792
|
* for your instance</a>.</p>
|
|
2793
|
+
* @public
|
|
2794
2794
|
*/
|
|
2795
2795
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2796
2796
|
/**
|
|
2797
|
-
* @public
|
|
2798
2797
|
* <p>The description of the knowledge base.</p>
|
|
2798
|
+
* @public
|
|
2799
2799
|
*/
|
|
2800
2800
|
description?: string;
|
|
2801
2801
|
/**
|
|
2802
|
-
* @public
|
|
2803
2802
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2803
|
+
* @public
|
|
2804
2804
|
*/
|
|
2805
2805
|
tags?: Record<string, string>;
|
|
2806
2806
|
}
|
|
@@ -2809,13 +2809,13 @@ export interface KnowledgeBaseSummary {
|
|
|
2809
2809
|
*/
|
|
2810
2810
|
export interface ListKnowledgeBasesResponse {
|
|
2811
2811
|
/**
|
|
2812
|
-
* @public
|
|
2813
2812
|
* <p>Information about the knowledge bases.</p>
|
|
2813
|
+
* @public
|
|
2814
2814
|
*/
|
|
2815
2815
|
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
2816
2816
|
/**
|
|
2817
|
-
* @public
|
|
2818
2817
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2818
|
+
* @public
|
|
2819
2819
|
*/
|
|
2820
2820
|
nextToken?: string;
|
|
2821
2821
|
}
|
|
@@ -2824,56 +2824,55 @@ export interface ListKnowledgeBasesResponse {
|
|
|
2824
2824
|
*/
|
|
2825
2825
|
export interface ListQuickResponsesRequest {
|
|
2826
2826
|
/**
|
|
2827
|
-
* @public
|
|
2828
2827
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2829
2828
|
* response in the next request to retrieve the next set of results.</p>
|
|
2829
|
+
* @public
|
|
2830
2830
|
*/
|
|
2831
2831
|
nextToken?: string;
|
|
2832
2832
|
/**
|
|
2833
|
-
* @public
|
|
2834
2833
|
* <p>The maximum number of results to return per page.</p>
|
|
2834
|
+
* @public
|
|
2835
2835
|
*/
|
|
2836
2836
|
maxResults?: number;
|
|
2837
2837
|
/**
|
|
2838
|
-
* @public
|
|
2839
2838
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2840
2839
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2840
|
+
* @public
|
|
2841
2841
|
*/
|
|
2842
2842
|
knowledgeBaseId: string | undefined;
|
|
2843
2843
|
}
|
|
2844
2844
|
/**
|
|
2845
|
-
* @public
|
|
2846
2845
|
* <p>The summary information about the quick response.</p>
|
|
2846
|
+
* @public
|
|
2847
2847
|
*/
|
|
2848
2848
|
export interface QuickResponseSummary {
|
|
2849
2849
|
/**
|
|
2850
|
-
* @public
|
|
2851
2850
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
quickResponseArn: string | undefined;
|
|
2854
2854
|
/**
|
|
2855
|
-
* @public
|
|
2856
2855
|
* <p>The identifier of the quick response.</p>
|
|
2856
|
+
* @public
|
|
2857
2857
|
*/
|
|
2858
2858
|
quickResponseId: string | undefined;
|
|
2859
2859
|
/**
|
|
2860
|
-
* @public
|
|
2861
2860
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2861
|
+
* @public
|
|
2862
2862
|
*/
|
|
2863
2863
|
knowledgeBaseArn: string | undefined;
|
|
2864
2864
|
/**
|
|
2865
|
-
* @public
|
|
2866
2865
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2867
2866
|
* base if you're storing Wisdom Content resource to it.</p>
|
|
2867
|
+
* @public
|
|
2868
2868
|
*/
|
|
2869
2869
|
knowledgeBaseId: string | undefined;
|
|
2870
2870
|
/**
|
|
2871
|
-
* @public
|
|
2872
2871
|
* <p>The name of the quick response.</p>
|
|
2872
|
+
* @public
|
|
2873
2873
|
*/
|
|
2874
2874
|
name: string | undefined;
|
|
2875
2875
|
/**
|
|
2876
|
-
* @public
|
|
2877
2876
|
* <p>The media type of the quick response content.</p>
|
|
2878
2877
|
* <ul>
|
|
2879
2878
|
* <li>
|
|
@@ -2883,46 +2882,47 @@ export interface QuickResponseSummary {
|
|
|
2883
2882
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
2884
2883
|
* </li>
|
|
2885
2884
|
* </ul>
|
|
2885
|
+
* @public
|
|
2886
2886
|
*/
|
|
2887
2887
|
contentType: string | undefined;
|
|
2888
2888
|
/**
|
|
2889
|
-
* @public
|
|
2890
2889
|
* <p>The resource status of the quick response.</p>
|
|
2890
|
+
* @public
|
|
2891
2891
|
*/
|
|
2892
2892
|
status: QuickResponseStatus | undefined;
|
|
2893
2893
|
/**
|
|
2894
|
-
* @public
|
|
2895
2894
|
* <p>The timestamp when the quick response was created.</p>
|
|
2895
|
+
* @public
|
|
2896
2896
|
*/
|
|
2897
2897
|
createdTime: Date | undefined;
|
|
2898
2898
|
/**
|
|
2899
|
-
* @public
|
|
2900
2899
|
* <p>The timestamp when the quick response summary was last modified.</p>
|
|
2900
|
+
* @public
|
|
2901
2901
|
*/
|
|
2902
2902
|
lastModifiedTime: Date | undefined;
|
|
2903
2903
|
/**
|
|
2904
|
-
* @public
|
|
2905
2904
|
* <p>The description of the quick response.</p>
|
|
2905
|
+
* @public
|
|
2906
2906
|
*/
|
|
2907
2907
|
description?: string;
|
|
2908
2908
|
/**
|
|
2909
|
-
* @public
|
|
2910
2909
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
2910
|
+
* @public
|
|
2911
2911
|
*/
|
|
2912
2912
|
lastModifiedBy?: string;
|
|
2913
2913
|
/**
|
|
2914
|
-
* @public
|
|
2915
2914
|
* <p>Whether the quick response is active.</p>
|
|
2915
|
+
* @public
|
|
2916
2916
|
*/
|
|
2917
2917
|
isActive?: boolean;
|
|
2918
2918
|
/**
|
|
2919
|
-
* @public
|
|
2920
2919
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
2920
|
+
* @public
|
|
2921
2921
|
*/
|
|
2922
2922
|
channels?: string[];
|
|
2923
2923
|
/**
|
|
2924
|
-
* @public
|
|
2925
2924
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2925
|
+
* @public
|
|
2926
2926
|
*/
|
|
2927
2927
|
tags?: Record<string, string>;
|
|
2928
2928
|
}
|
|
@@ -2931,14 +2931,14 @@ export interface QuickResponseSummary {
|
|
|
2931
2931
|
*/
|
|
2932
2932
|
export interface ListQuickResponsesResponse {
|
|
2933
2933
|
/**
|
|
2934
|
-
* @public
|
|
2935
2934
|
* <p>Summary information about the quick responses.</p>
|
|
2935
|
+
* @public
|
|
2936
2936
|
*/
|
|
2937
2937
|
quickResponseSummaries: QuickResponseSummary[] | undefined;
|
|
2938
2938
|
/**
|
|
2939
|
-
* @public
|
|
2940
2939
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2941
2940
|
* response in the next request to retrieve the next set of results.</p>
|
|
2941
|
+
* @public
|
|
2942
2942
|
*/
|
|
2943
2943
|
nextToken?: string;
|
|
2944
2944
|
}
|
|
@@ -2947,28 +2947,27 @@ export interface ListQuickResponsesResponse {
|
|
|
2947
2947
|
*/
|
|
2948
2948
|
export interface UpdateQuickResponseRequest {
|
|
2949
2949
|
/**
|
|
2950
|
-
* @public
|
|
2951
2950
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2952
2951
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2952
|
+
* @public
|
|
2953
2953
|
*/
|
|
2954
2954
|
knowledgeBaseId: string | undefined;
|
|
2955
2955
|
/**
|
|
2956
|
-
* @public
|
|
2957
2956
|
* <p>The identifier of the quick response.</p>
|
|
2957
|
+
* @public
|
|
2958
2958
|
*/
|
|
2959
2959
|
quickResponseId: string | undefined;
|
|
2960
2960
|
/**
|
|
2961
|
-
* @public
|
|
2962
2961
|
* <p>The name of the quick response.</p>
|
|
2962
|
+
* @public
|
|
2963
2963
|
*/
|
|
2964
2964
|
name?: string;
|
|
2965
2965
|
/**
|
|
2966
|
-
* @public
|
|
2967
2966
|
* <p>The updated content of the quick response.</p>
|
|
2967
|
+
* @public
|
|
2968
2968
|
*/
|
|
2969
2969
|
content?: QuickResponseDataProvider;
|
|
2970
2970
|
/**
|
|
2971
|
-
* @public
|
|
2972
2971
|
* <p>The media type of the quick response content.</p>
|
|
2973
2972
|
* <ul>
|
|
2974
2973
|
* <li>
|
|
@@ -2978,55 +2977,56 @@ export interface UpdateQuickResponseRequest {
|
|
|
2978
2977
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
2979
2978
|
* </li>
|
|
2980
2979
|
* </ul>
|
|
2980
|
+
* @public
|
|
2981
2981
|
*/
|
|
2982
2982
|
contentType?: string;
|
|
2983
2983
|
/**
|
|
2984
|
-
* @public
|
|
2985
2984
|
* <p>The updated grouping configuration of the quick response.</p>
|
|
2985
|
+
* @public
|
|
2986
2986
|
*/
|
|
2987
2987
|
groupingConfiguration?: GroupingConfiguration;
|
|
2988
2988
|
/**
|
|
2989
|
-
* @public
|
|
2990
2989
|
* <p>Whether to remove the grouping configuration of the quick response.</p>
|
|
2990
|
+
* @public
|
|
2991
2991
|
*/
|
|
2992
2992
|
removeGroupingConfiguration?: boolean;
|
|
2993
2993
|
/**
|
|
2994
|
-
* @public
|
|
2995
2994
|
* <p>The updated description of the quick response.</p>
|
|
2995
|
+
* @public
|
|
2996
2996
|
*/
|
|
2997
2997
|
description?: string;
|
|
2998
2998
|
/**
|
|
2999
|
-
* @public
|
|
3000
2999
|
* <p>Whether to remove the description from the quick response.</p>
|
|
3000
|
+
* @public
|
|
3001
3001
|
*/
|
|
3002
3002
|
removeDescription?: boolean;
|
|
3003
3003
|
/**
|
|
3004
|
-
* @public
|
|
3005
3004
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
3006
3005
|
* knowledge base.</p>
|
|
3006
|
+
* @public
|
|
3007
3007
|
*/
|
|
3008
3008
|
shortcutKey?: string;
|
|
3009
3009
|
/**
|
|
3010
|
-
* @public
|
|
3011
3010
|
* <p>Whether to remove the shortcut key of the quick response.</p>
|
|
3011
|
+
* @public
|
|
3012
3012
|
*/
|
|
3013
3013
|
removeShortcutKey?: boolean;
|
|
3014
3014
|
/**
|
|
3015
|
-
* @public
|
|
3016
3015
|
* <p>Whether the quick response is active. </p>
|
|
3016
|
+
* @public
|
|
3017
3017
|
*/
|
|
3018
3018
|
isActive?: boolean;
|
|
3019
3019
|
/**
|
|
3020
|
-
* @public
|
|
3021
3020
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
3021
|
+
* @public
|
|
3022
3022
|
*/
|
|
3023
3023
|
channels?: string[];
|
|
3024
3024
|
/**
|
|
3025
|
-
* @public
|
|
3026
3025
|
* <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
|
|
3027
3026
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
3028
3027
|
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
3029
3028
|
* </p>
|
|
3029
|
+
* @public
|
|
3030
3030
|
*/
|
|
3031
3031
|
language?: string;
|
|
3032
3032
|
}
|
|
@@ -3035,8 +3035,8 @@ export interface UpdateQuickResponseRequest {
|
|
|
3035
3035
|
*/
|
|
3036
3036
|
export interface UpdateQuickResponseResponse {
|
|
3037
3037
|
/**
|
|
3038
|
-
* @public
|
|
3039
3038
|
* <p>The quick response.</p>
|
|
3039
|
+
* @public
|
|
3040
3040
|
*/
|
|
3041
3041
|
quickResponse?: QuickResponseData;
|
|
3042
3042
|
}
|
|
@@ -3045,9 +3045,9 @@ export interface UpdateQuickResponseResponse {
|
|
|
3045
3045
|
*/
|
|
3046
3046
|
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
3047
3047
|
/**
|
|
3048
|
-
* @public
|
|
3049
3048
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3050
3049
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3050
|
+
* @public
|
|
3051
3051
|
*/
|
|
3052
3052
|
knowledgeBaseId: string | undefined;
|
|
3053
3053
|
}
|
|
@@ -3061,25 +3061,25 @@ export interface RemoveKnowledgeBaseTemplateUriResponse {
|
|
|
3061
3061
|
*/
|
|
3062
3062
|
export interface SearchContentRequest {
|
|
3063
3063
|
/**
|
|
3064
|
-
* @public
|
|
3065
3064
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3066
3065
|
* response in the next request to retrieve the next set of results.</p>
|
|
3066
|
+
* @public
|
|
3067
3067
|
*/
|
|
3068
3068
|
nextToken?: string;
|
|
3069
3069
|
/**
|
|
3070
|
-
* @public
|
|
3071
3070
|
* <p>The maximum number of results to return per page.</p>
|
|
3071
|
+
* @public
|
|
3072
3072
|
*/
|
|
3073
3073
|
maxResults?: number;
|
|
3074
3074
|
/**
|
|
3075
|
-
* @public
|
|
3076
3075
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3077
3076
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3077
|
+
* @public
|
|
3078
3078
|
*/
|
|
3079
3079
|
knowledgeBaseId: string | undefined;
|
|
3080
3080
|
/**
|
|
3081
|
-
* @public
|
|
3082
3081
|
* <p>The search expression to filter results.</p>
|
|
3082
|
+
* @public
|
|
3083
3083
|
*/
|
|
3084
3084
|
searchExpression: SearchExpression | undefined;
|
|
3085
3085
|
}
|
|
@@ -3088,13 +3088,13 @@ export interface SearchContentRequest {
|
|
|
3088
3088
|
*/
|
|
3089
3089
|
export interface SearchContentResponse {
|
|
3090
3090
|
/**
|
|
3091
|
-
* @public
|
|
3092
3091
|
* <p>Summary information about the content.</p>
|
|
3092
|
+
* @public
|
|
3093
3093
|
*/
|
|
3094
3094
|
contentSummaries: ContentSummary[] | undefined;
|
|
3095
3095
|
/**
|
|
3096
|
-
* @public
|
|
3097
3096
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3097
|
+
* @public
|
|
3098
3098
|
*/
|
|
3099
3099
|
nextToken?: string;
|
|
3100
3100
|
}
|
|
@@ -3111,7 +3111,6 @@ export declare const QuickResponseFilterOperator: {
|
|
|
3111
3111
|
*/
|
|
3112
3112
|
export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
|
|
3113
3113
|
/**
|
|
3114
|
-
* @public
|
|
3115
3114
|
* <p>The quick response fields to filter the quick response query results by.</p>
|
|
3116
3115
|
* <p>The following is the list of supported field names.</p>
|
|
3117
3116
|
* <ul>
|
|
@@ -3152,26 +3151,27 @@ export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[k
|
|
|
3152
3151
|
* <p>groupingConfiguration.values</p>
|
|
3153
3152
|
* </li>
|
|
3154
3153
|
* </ul>
|
|
3154
|
+
* @public
|
|
3155
3155
|
*/
|
|
3156
3156
|
export interface QuickResponseFilterField {
|
|
3157
3157
|
/**
|
|
3158
|
-
* @public
|
|
3159
3158
|
* <p>The name of the attribute field to filter the quick responses by.</p>
|
|
3159
|
+
* @public
|
|
3160
3160
|
*/
|
|
3161
3161
|
name: string | undefined;
|
|
3162
3162
|
/**
|
|
3163
|
-
* @public
|
|
3164
3163
|
* <p>The values of attribute field to filter the quick response by.</p>
|
|
3164
|
+
* @public
|
|
3165
3165
|
*/
|
|
3166
3166
|
values?: string[];
|
|
3167
3167
|
/**
|
|
3168
|
-
* @public
|
|
3169
3168
|
* <p>The operator to use for filtering.</p>
|
|
3169
|
+
* @public
|
|
3170
3170
|
*/
|
|
3171
3171
|
operator: QuickResponseFilterOperator | undefined;
|
|
3172
3172
|
/**
|
|
3173
|
-
* @public
|
|
3174
3173
|
* <p>Whether to treat null value as a match for the attribute field.</p>
|
|
3174
|
+
* @public
|
|
3175
3175
|
*/
|
|
3176
3176
|
includeNoExistence?: boolean;
|
|
3177
3177
|
}
|
|
@@ -3188,7 +3188,6 @@ export declare const Order: {
|
|
|
3188
3188
|
*/
|
|
3189
3189
|
export type Order = (typeof Order)[keyof typeof Order];
|
|
3190
3190
|
/**
|
|
3191
|
-
* @public
|
|
3192
3191
|
* <p>The quick response fields to order the quick response query results by.</p>
|
|
3193
3192
|
* <p>The following is the list of supported field names.</p>
|
|
3194
3193
|
* <ul>
|
|
@@ -3229,16 +3228,17 @@ export type Order = (typeof Order)[keyof typeof Order];
|
|
|
3229
3228
|
* <p>groupingConfiguration.values</p>
|
|
3230
3229
|
* </li>
|
|
3231
3230
|
* </ul>
|
|
3231
|
+
* @public
|
|
3232
3232
|
*/
|
|
3233
3233
|
export interface QuickResponseOrderField {
|
|
3234
3234
|
/**
|
|
3235
|
-
* @public
|
|
3236
3235
|
* <p>The name of the attribute to order the quick response query results by.</p>
|
|
3236
|
+
* @public
|
|
3237
3237
|
*/
|
|
3238
3238
|
name: string | undefined;
|
|
3239
3239
|
/**
|
|
3240
|
-
* @public
|
|
3241
3240
|
* <p>The order at which the quick responses are sorted by.</p>
|
|
3241
|
+
* @public
|
|
3242
3242
|
*/
|
|
3243
3243
|
order?: Order;
|
|
3244
3244
|
}
|
|
@@ -3268,7 +3268,6 @@ export declare const Priority: {
|
|
|
3268
3268
|
*/
|
|
3269
3269
|
export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
3270
3270
|
/**
|
|
3271
|
-
* @public
|
|
3272
3271
|
* <p>The quick response fields to query quick responses by.</p>
|
|
3273
3272
|
* <p>The following is the list of supported field names.</p>
|
|
3274
3273
|
* <ul>
|
|
@@ -3285,53 +3284,54 @@ export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
|
3285
3284
|
* <p>shortcutKey</p>
|
|
3286
3285
|
* </li>
|
|
3287
3286
|
* </ul>
|
|
3287
|
+
* @public
|
|
3288
3288
|
*/
|
|
3289
3289
|
export interface QuickResponseQueryField {
|
|
3290
3290
|
/**
|
|
3291
|
-
* @public
|
|
3292
3291
|
* <p>The name of the attribute to query the quick responses by.</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
name: string | undefined;
|
|
3295
3295
|
/**
|
|
3296
|
-
* @public
|
|
3297
3296
|
* <p>The values of the attribute to query the quick responses by.</p>
|
|
3297
|
+
* @public
|
|
3298
3298
|
*/
|
|
3299
3299
|
values: string[] | undefined;
|
|
3300
3300
|
/**
|
|
3301
|
-
* @public
|
|
3302
3301
|
* <p>The operator to use for matching attribute field values in the query.</p>
|
|
3302
|
+
* @public
|
|
3303
3303
|
*/
|
|
3304
3304
|
operator: QuickResponseQueryOperator | undefined;
|
|
3305
3305
|
/**
|
|
3306
|
-
* @public
|
|
3307
3306
|
* <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
|
|
3307
|
+
* @public
|
|
3308
3308
|
*/
|
|
3309
3309
|
allowFuzziness?: boolean;
|
|
3310
3310
|
/**
|
|
3311
|
-
* @public
|
|
3312
3311
|
* <p>The importance of the attribute field when calculating query result relevancy scores.
|
|
3313
3312
|
* The value set for this parameter affects the ordering of search results.</p>
|
|
3313
|
+
* @public
|
|
3314
3314
|
*/
|
|
3315
3315
|
priority?: Priority;
|
|
3316
3316
|
}
|
|
3317
3317
|
/**
|
|
3318
|
-
* @public
|
|
3319
3318
|
* <p>Information about the import job.</p>
|
|
3319
|
+
* @public
|
|
3320
3320
|
*/
|
|
3321
3321
|
export interface QuickResponseSearchExpression {
|
|
3322
3322
|
/**
|
|
3323
|
-
* @public
|
|
3324
3323
|
* <p>The quick response query expressions.</p>
|
|
3324
|
+
* @public
|
|
3325
3325
|
*/
|
|
3326
3326
|
queries?: QuickResponseQueryField[];
|
|
3327
3327
|
/**
|
|
3328
|
-
* @public
|
|
3329
3328
|
* <p>The configuration of filtering rules applied to quick response query results.</p>
|
|
3329
|
+
* @public
|
|
3330
3330
|
*/
|
|
3331
3331
|
filters?: QuickResponseFilterField[];
|
|
3332
3332
|
/**
|
|
3333
|
-
* @public
|
|
3334
3333
|
* <p>The quick response attribute fields on which the query results are ordered.</p>
|
|
3334
|
+
* @public
|
|
3335
3335
|
*/
|
|
3336
3336
|
orderOnField?: QuickResponseOrderField;
|
|
3337
3337
|
}
|
|
@@ -3340,65 +3340,64 @@ export interface QuickResponseSearchExpression {
|
|
|
3340
3340
|
*/
|
|
3341
3341
|
export interface SearchQuickResponsesRequest {
|
|
3342
3342
|
/**
|
|
3343
|
-
* @public
|
|
3344
3343
|
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3344
|
+
* @public
|
|
3345
3345
|
*/
|
|
3346
3346
|
knowledgeBaseId: string | undefined;
|
|
3347
3347
|
/**
|
|
3348
|
-
* @public
|
|
3349
3348
|
* <p>The search expression for querying the quick response.</p>
|
|
3349
|
+
* @public
|
|
3350
3350
|
*/
|
|
3351
3351
|
searchExpression: QuickResponseSearchExpression | undefined;
|
|
3352
3352
|
/**
|
|
3353
|
-
* @public
|
|
3354
3353
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3355
3354
|
* response in the next request to retrieve the next set of results.</p>
|
|
3355
|
+
* @public
|
|
3356
3356
|
*/
|
|
3357
3357
|
nextToken?: string;
|
|
3358
3358
|
/**
|
|
3359
|
-
* @public
|
|
3360
3359
|
* <p>The maximum number of results to return per page.</p>
|
|
3360
|
+
* @public
|
|
3361
3361
|
*/
|
|
3362
3362
|
maxResults?: number;
|
|
3363
3363
|
/**
|
|
3364
|
-
* @public
|
|
3365
3364
|
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>
|
|
3365
|
+
* @public
|
|
3366
3366
|
*/
|
|
3367
3367
|
attributes?: Record<string, string>;
|
|
3368
3368
|
}
|
|
3369
3369
|
/**
|
|
3370
|
-
* @public
|
|
3371
3370
|
* <p>The result of quick response search.</p>
|
|
3371
|
+
* @public
|
|
3372
3372
|
*/
|
|
3373
3373
|
export interface QuickResponseSearchResultData {
|
|
3374
3374
|
/**
|
|
3375
|
-
* @public
|
|
3376
3375
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
3376
|
+
* @public
|
|
3377
3377
|
*/
|
|
3378
3378
|
quickResponseArn: string | undefined;
|
|
3379
3379
|
/**
|
|
3380
|
-
* @public
|
|
3381
3380
|
* <p>The identifier of the quick response.</p>
|
|
3381
|
+
* @public
|
|
3382
3382
|
*/
|
|
3383
3383
|
quickResponseId: string | undefined;
|
|
3384
3384
|
/**
|
|
3385
|
-
* @public
|
|
3386
3385
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
3386
|
+
* @public
|
|
3387
3387
|
*/
|
|
3388
3388
|
knowledgeBaseArn: string | undefined;
|
|
3389
3389
|
/**
|
|
3390
|
-
* @public
|
|
3391
3390
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3392
3391
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3392
|
+
* @public
|
|
3393
3393
|
*/
|
|
3394
3394
|
knowledgeBaseId: string | undefined;
|
|
3395
3395
|
/**
|
|
3396
|
-
* @public
|
|
3397
3396
|
* <p>The name of the quick response.</p>
|
|
3397
|
+
* @public
|
|
3398
3398
|
*/
|
|
3399
3399
|
name: string | undefined;
|
|
3400
3400
|
/**
|
|
3401
|
-
* @public
|
|
3402
3401
|
* <p>The media type of the quick response content.</p>
|
|
3403
3402
|
* <ul>
|
|
3404
3403
|
* <li>
|
|
@@ -3408,77 +3407,78 @@ export interface QuickResponseSearchResultData {
|
|
|
3408
3407
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
3409
3408
|
* </li>
|
|
3410
3409
|
* </ul>
|
|
3410
|
+
* @public
|
|
3411
3411
|
*/
|
|
3412
3412
|
contentType: string | undefined;
|
|
3413
3413
|
/**
|
|
3414
|
-
* @public
|
|
3415
3414
|
* <p>The resource status of the quick response.</p>
|
|
3415
|
+
* @public
|
|
3416
3416
|
*/
|
|
3417
3417
|
status: QuickResponseStatus | undefined;
|
|
3418
3418
|
/**
|
|
3419
|
-
* @public
|
|
3420
3419
|
* <p>The contents of the quick response.</p>
|
|
3420
|
+
* @public
|
|
3421
3421
|
*/
|
|
3422
3422
|
contents: QuickResponseContents | undefined;
|
|
3423
3423
|
/**
|
|
3424
|
-
* @public
|
|
3425
3424
|
* <p>The timestamp when the quick response was created.</p>
|
|
3425
|
+
* @public
|
|
3426
3426
|
*/
|
|
3427
3427
|
createdTime: Date | undefined;
|
|
3428
3428
|
/**
|
|
3429
|
-
* @public
|
|
3430
3429
|
* <p>The timestamp when the quick response search result data was last modified.</p>
|
|
3430
|
+
* @public
|
|
3431
3431
|
*/
|
|
3432
3432
|
lastModifiedTime: Date | undefined;
|
|
3433
3433
|
/**
|
|
3434
|
-
* @public
|
|
3435
3434
|
* <p>Whether the quick response is active.</p>
|
|
3435
|
+
* @public
|
|
3436
3436
|
*/
|
|
3437
3437
|
isActive: boolean | undefined;
|
|
3438
3438
|
/**
|
|
3439
|
-
* @public
|
|
3440
3439
|
* <p>The description of the quick response.</p>
|
|
3440
|
+
* @public
|
|
3441
3441
|
*/
|
|
3442
3442
|
description?: string;
|
|
3443
3443
|
/**
|
|
3444
|
-
* @public
|
|
3445
3444
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
3445
|
+
* @public
|
|
3446
3446
|
*/
|
|
3447
3447
|
groupingConfiguration?: GroupingConfiguration;
|
|
3448
3448
|
/**
|
|
3449
|
-
* @public
|
|
3450
3449
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
3451
3450
|
* knowledge base.</p>
|
|
3451
|
+
* @public
|
|
3452
3452
|
*/
|
|
3453
3453
|
shortcutKey?: string;
|
|
3454
3454
|
/**
|
|
3455
|
-
* @public
|
|
3456
3455
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>
|
|
3456
|
+
* @public
|
|
3457
3457
|
*/
|
|
3458
3458
|
lastModifiedBy?: string;
|
|
3459
3459
|
/**
|
|
3460
|
-
* @public
|
|
3461
3460
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
3461
|
+
* @public
|
|
3462
3462
|
*/
|
|
3463
3463
|
channels?: string[];
|
|
3464
3464
|
/**
|
|
3465
|
-
* @public
|
|
3466
3465
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
3466
|
+
* @public
|
|
3467
3467
|
*/
|
|
3468
3468
|
language?: string;
|
|
3469
3469
|
/**
|
|
3470
|
-
* @public
|
|
3471
3470
|
* <p>The user defined contact attributes that are not resolved when the search result is returned.</p>
|
|
3471
|
+
* @public
|
|
3472
3472
|
*/
|
|
3473
3473
|
attributesNotInterpolated?: string[];
|
|
3474
3474
|
/**
|
|
3475
|
-
* @public
|
|
3476
3475
|
* <p>The user defined contact attributes that are resolved when the search result is returned.</p>
|
|
3476
|
+
* @public
|
|
3477
3477
|
*/
|
|
3478
3478
|
attributesInterpolated?: string[];
|
|
3479
3479
|
/**
|
|
3480
|
-
* @public
|
|
3481
3480
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3481
|
+
* @public
|
|
3482
3482
|
*/
|
|
3483
3483
|
tags?: Record<string, string>;
|
|
3484
3484
|
}
|
|
@@ -3487,14 +3487,14 @@ export interface QuickResponseSearchResultData {
|
|
|
3487
3487
|
*/
|
|
3488
3488
|
export interface SearchQuickResponsesResponse {
|
|
3489
3489
|
/**
|
|
3490
|
-
* @public
|
|
3491
3490
|
* <p>The results of the quick response search.</p>
|
|
3491
|
+
* @public
|
|
3492
3492
|
*/
|
|
3493
3493
|
results: QuickResponseSearchResultData[] | undefined;
|
|
3494
3494
|
/**
|
|
3495
|
-
* @public
|
|
3496
3495
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3497
3496
|
* response in the next request to retrieve the next set of results.</p>
|
|
3497
|
+
* @public
|
|
3498
3498
|
*/
|
|
3499
3499
|
nextToken?: string;
|
|
3500
3500
|
}
|
|
@@ -3503,19 +3503,19 @@ export interface SearchQuickResponsesResponse {
|
|
|
3503
3503
|
*/
|
|
3504
3504
|
export interface StartContentUploadRequest {
|
|
3505
3505
|
/**
|
|
3506
|
-
* @public
|
|
3507
3506
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3508
3507
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3508
|
+
* @public
|
|
3509
3509
|
*/
|
|
3510
3510
|
knowledgeBaseId: string | undefined;
|
|
3511
3511
|
/**
|
|
3512
|
-
* @public
|
|
3513
3512
|
* <p>The type of content to upload.</p>
|
|
3513
|
+
* @public
|
|
3514
3514
|
*/
|
|
3515
3515
|
contentType: string | undefined;
|
|
3516
3516
|
/**
|
|
3517
|
-
* @public
|
|
3518
3517
|
* <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
|
|
3518
|
+
* @public
|
|
3519
3519
|
*/
|
|
3520
3520
|
presignedUrlTimeToLive?: number;
|
|
3521
3521
|
}
|
|
@@ -3524,23 +3524,23 @@ export interface StartContentUploadRequest {
|
|
|
3524
3524
|
*/
|
|
3525
3525
|
export interface StartContentUploadResponse {
|
|
3526
3526
|
/**
|
|
3527
|
-
* @public
|
|
3528
3527
|
* <p>The identifier of the upload.</p>
|
|
3528
|
+
* @public
|
|
3529
3529
|
*/
|
|
3530
3530
|
uploadId: string | undefined;
|
|
3531
3531
|
/**
|
|
3532
|
-
* @public
|
|
3533
3532
|
* <p>The URL of the upload.</p>
|
|
3533
|
+
* @public
|
|
3534
3534
|
*/
|
|
3535
3535
|
url: string | undefined;
|
|
3536
3536
|
/**
|
|
3537
|
-
* @public
|
|
3538
3537
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
3538
|
+
* @public
|
|
3539
3539
|
*/
|
|
3540
3540
|
urlExpiry: Date | undefined;
|
|
3541
3541
|
/**
|
|
3542
|
-
* @public
|
|
3543
3542
|
* <p>The headers to include in the upload.</p>
|
|
3543
|
+
* @public
|
|
3544
3544
|
*/
|
|
3545
3545
|
headersToInclude: Record<string, string> | undefined;
|
|
3546
3546
|
}
|
|
@@ -3549,7 +3549,6 @@ export interface StartContentUploadResponse {
|
|
|
3549
3549
|
*/
|
|
3550
3550
|
export interface StartImportJobRequest {
|
|
3551
3551
|
/**
|
|
3552
|
-
* @public
|
|
3553
3552
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3554
3553
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3555
3554
|
* <ul>
|
|
@@ -3557,36 +3556,37 @@ export interface StartImportJobRequest {
|
|
|
3557
3556
|
* <p>For importing Wisdom quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p>
|
|
3558
3557
|
* </li>
|
|
3559
3558
|
* </ul>
|
|
3559
|
+
* @public
|
|
3560
3560
|
*/
|
|
3561
3561
|
knowledgeBaseId: string | undefined;
|
|
3562
3562
|
/**
|
|
3563
|
-
* @public
|
|
3564
3563
|
* <p>The type of the import job.</p>
|
|
3565
3564
|
* <ul>
|
|
3566
3565
|
* <li>
|
|
3567
3566
|
* <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p>
|
|
3568
3567
|
* </li>
|
|
3569
3568
|
* </ul>
|
|
3569
|
+
* @public
|
|
3570
3570
|
*/
|
|
3571
3571
|
importJobType: ImportJobType | undefined;
|
|
3572
3572
|
/**
|
|
3573
|
-
* @public
|
|
3574
3573
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
3574
|
+
* @public
|
|
3575
3575
|
*/
|
|
3576
3576
|
uploadId: string | undefined;
|
|
3577
3577
|
/**
|
|
3578
|
-
* @public
|
|
3579
3578
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3579
|
+
* @public
|
|
3580
3580
|
*/
|
|
3581
3581
|
clientToken?: string;
|
|
3582
3582
|
/**
|
|
3583
|
-
* @public
|
|
3584
3583
|
* <p>The metadata fields of the imported Wisdom resources.</p>
|
|
3584
|
+
* @public
|
|
3585
3585
|
*/
|
|
3586
3586
|
metadata?: Record<string, string>;
|
|
3587
3587
|
/**
|
|
3588
|
-
* @public
|
|
3589
3588
|
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
3589
|
+
* @public
|
|
3590
3590
|
*/
|
|
3591
3591
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
3592
3592
|
}
|
|
@@ -3595,8 +3595,8 @@ export interface StartImportJobRequest {
|
|
|
3595
3595
|
*/
|
|
3596
3596
|
export interface StartImportJobResponse {
|
|
3597
3597
|
/**
|
|
3598
|
-
* @public
|
|
3599
3598
|
* <p>The import job.</p>
|
|
3599
|
+
* @public
|
|
3600
3600
|
*/
|
|
3601
3601
|
importJob?: ImportJobData;
|
|
3602
3602
|
}
|
|
@@ -3605,14 +3605,14 @@ export interface StartImportJobResponse {
|
|
|
3605
3605
|
*/
|
|
3606
3606
|
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
3607
3607
|
/**
|
|
3608
|
-
* @public
|
|
3609
3608
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3610
3609
|
* base if you're storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3610
|
+
* @public
|
|
3611
3611
|
*/
|
|
3612
3612
|
knowledgeBaseId: string | undefined;
|
|
3613
3613
|
/**
|
|
3614
|
-
* @public
|
|
3615
3614
|
* <p>The template URI to update.</p>
|
|
3615
|
+
* @public
|
|
3616
3616
|
*/
|
|
3617
3617
|
templateUri: string | undefined;
|
|
3618
3618
|
}
|
|
@@ -3621,8 +3621,8 @@ export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
|
3621
3621
|
*/
|
|
3622
3622
|
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
3623
3623
|
/**
|
|
3624
|
-
* @public
|
|
3625
3624
|
* <p>The knowledge base to update.</p>
|
|
3625
|
+
* @public
|
|
3626
3626
|
*/
|
|
3627
3627
|
knowledgeBase?: KnowledgeBaseData;
|
|
3628
3628
|
}
|
|
@@ -3631,8 +3631,8 @@ export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
|
3631
3631
|
*/
|
|
3632
3632
|
export interface ListTagsForResourceRequest {
|
|
3633
3633
|
/**
|
|
3634
|
-
* @public
|
|
3635
3634
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3635
|
+
* @public
|
|
3636
3636
|
*/
|
|
3637
3637
|
resourceArn: string | undefined;
|
|
3638
3638
|
}
|
|
@@ -3641,8 +3641,8 @@ export interface ListTagsForResourceRequest {
|
|
|
3641
3641
|
*/
|
|
3642
3642
|
export interface ListTagsForResourceResponse {
|
|
3643
3643
|
/**
|
|
3644
|
-
* @public
|
|
3645
3644
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3645
|
+
* @public
|
|
3646
3646
|
*/
|
|
3647
3647
|
tags?: Record<string, string>;
|
|
3648
3648
|
}
|
|
@@ -3651,13 +3651,13 @@ export interface ListTagsForResourceResponse {
|
|
|
3651
3651
|
*/
|
|
3652
3652
|
export interface TagResourceRequest {
|
|
3653
3653
|
/**
|
|
3654
|
-
* @public
|
|
3655
3654
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3655
|
+
* @public
|
|
3656
3656
|
*/
|
|
3657
3657
|
resourceArn: string | undefined;
|
|
3658
3658
|
/**
|
|
3659
|
-
* @public
|
|
3660
3659
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3660
|
+
* @public
|
|
3661
3661
|
*/
|
|
3662
3662
|
tags: Record<string, string> | undefined;
|
|
3663
3663
|
}
|
|
@@ -3667,15 +3667,15 @@ export interface TagResourceRequest {
|
|
|
3667
3667
|
export interface TagResourceResponse {
|
|
3668
3668
|
}
|
|
3669
3669
|
/**
|
|
3670
|
-
* @public
|
|
3671
3670
|
* <p>Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.</p>
|
|
3671
|
+
* @public
|
|
3672
3672
|
*/
|
|
3673
3673
|
export declare class TooManyTagsException extends __BaseException {
|
|
3674
3674
|
readonly name: "TooManyTagsException";
|
|
3675
3675
|
readonly $fault: "client";
|
|
3676
3676
|
/**
|
|
3677
|
-
* @public
|
|
3678
3677
|
* <p>The specified resource name.</p>
|
|
3678
|
+
* @public
|
|
3679
3679
|
*/
|
|
3680
3680
|
resourceName?: string;
|
|
3681
3681
|
/**
|
|
@@ -3688,13 +3688,13 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
3688
3688
|
*/
|
|
3689
3689
|
export interface UntagResourceRequest {
|
|
3690
3690
|
/**
|
|
3691
|
-
* @public
|
|
3692
3691
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3692
|
+
* @public
|
|
3693
3693
|
*/
|
|
3694
3694
|
resourceArn: string | undefined;
|
|
3695
3695
|
/**
|
|
3696
|
-
* @public
|
|
3697
3696
|
* <p>The tag keys.</p>
|
|
3697
|
+
* @public
|
|
3698
3698
|
*/
|
|
3699
3699
|
tagKeys: string[] | undefined;
|
|
3700
3700
|
}
|