@aws-sdk/client-wisdom 3.379.1 → 3.382.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/models/models_0.d.ts +276 -0
- package/package.json +5 -5
|
@@ -18,6 +18,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
18
18
|
*/
|
|
19
19
|
export interface AppIntegrationsConfiguration {
|
|
20
20
|
/**
|
|
21
|
+
* @public
|
|
21
22
|
* <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>
|
|
22
23
|
* <ul>
|
|
23
24
|
* <li>
|
|
@@ -48,6 +49,7 @@ export interface AppIntegrationsConfiguration {
|
|
|
48
49
|
*/
|
|
49
50
|
appIntegrationArn: string | undefined;
|
|
50
51
|
/**
|
|
52
|
+
* @public
|
|
51
53
|
* <p>The fields from the source that are made available to your agents in Wisdom. Optional if
|
|
52
54
|
* ObjectConfiguration is included in the provided DataIntegration. </p>
|
|
53
55
|
* <ul>
|
|
@@ -97,12 +99,16 @@ export type AssistantAssociationInputData = AssistantAssociationInputData.Knowle
|
|
|
97
99
|
*/
|
|
98
100
|
export declare namespace AssistantAssociationInputData {
|
|
99
101
|
/**
|
|
102
|
+
* @public
|
|
100
103
|
* <p>The identifier of the knowledge base.</p>
|
|
101
104
|
*/
|
|
102
105
|
interface KnowledgeBaseIdMember {
|
|
103
106
|
knowledgeBaseId: string;
|
|
104
107
|
$unknown?: never;
|
|
105
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
106
112
|
interface $UnknownMember {
|
|
107
113
|
knowledgeBaseId?: never;
|
|
108
114
|
$unknown: [string, any];
|
|
@@ -129,18 +135,22 @@ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationT
|
|
|
129
135
|
*/
|
|
130
136
|
export interface CreateAssistantAssociationRequest {
|
|
131
137
|
/**
|
|
138
|
+
* @public
|
|
132
139
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
133
140
|
*/
|
|
134
141
|
assistantId: string | undefined;
|
|
135
142
|
/**
|
|
143
|
+
* @public
|
|
136
144
|
* <p>The type of association.</p>
|
|
137
145
|
*/
|
|
138
146
|
associationType: AssociationType | string | undefined;
|
|
139
147
|
/**
|
|
148
|
+
* @public
|
|
140
149
|
* <p>The identifier of the associated resource.</p>
|
|
141
150
|
*/
|
|
142
151
|
association: AssistantAssociationInputData | undefined;
|
|
143
152
|
/**
|
|
153
|
+
* @public
|
|
144
154
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
145
155
|
* request. If not provided, the Amazon Web Services
|
|
146
156
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -148,6 +158,7 @@ export interface CreateAssistantAssociationRequest {
|
|
|
148
158
|
*/
|
|
149
159
|
clientToken?: string;
|
|
150
160
|
/**
|
|
161
|
+
* @public
|
|
151
162
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
152
163
|
*/
|
|
153
164
|
tags?: Record<string, string>;
|
|
@@ -158,10 +169,12 @@ export interface CreateAssistantAssociationRequest {
|
|
|
158
169
|
*/
|
|
159
170
|
export interface KnowledgeBaseAssociationData {
|
|
160
171
|
/**
|
|
172
|
+
* @public
|
|
161
173
|
* <p>The identifier of the knowledge base.</p>
|
|
162
174
|
*/
|
|
163
175
|
knowledgeBaseId?: string;
|
|
164
176
|
/**
|
|
177
|
+
* @public
|
|
165
178
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
166
179
|
*/
|
|
167
180
|
knowledgeBaseArn?: string;
|
|
@@ -176,12 +189,16 @@ export type AssistantAssociationOutputData = AssistantAssociationOutputData.Know
|
|
|
176
189
|
*/
|
|
177
190
|
export declare namespace AssistantAssociationOutputData {
|
|
178
191
|
/**
|
|
192
|
+
* @public
|
|
179
193
|
* <p>The knowledge base where output data is sent.</p>
|
|
180
194
|
*/
|
|
181
195
|
interface KnowledgeBaseAssociationMember {
|
|
182
196
|
knowledgeBaseAssociation: KnowledgeBaseAssociationData;
|
|
183
197
|
$unknown?: never;
|
|
184
198
|
}
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
185
202
|
interface $UnknownMember {
|
|
186
203
|
knowledgeBaseAssociation?: never;
|
|
187
204
|
$unknown: [string, any];
|
|
@@ -198,30 +215,37 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
198
215
|
*/
|
|
199
216
|
export interface AssistantAssociationData {
|
|
200
217
|
/**
|
|
218
|
+
* @public
|
|
201
219
|
* <p>The identifier of the assistant association.</p>
|
|
202
220
|
*/
|
|
203
221
|
assistantAssociationId: string | undefined;
|
|
204
222
|
/**
|
|
223
|
+
* @public
|
|
205
224
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
206
225
|
*/
|
|
207
226
|
assistantAssociationArn: string | undefined;
|
|
208
227
|
/**
|
|
228
|
+
* @public
|
|
209
229
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
210
230
|
*/
|
|
211
231
|
assistantId: string | undefined;
|
|
212
232
|
/**
|
|
233
|
+
* @public
|
|
213
234
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
214
235
|
*/
|
|
215
236
|
assistantArn: string | undefined;
|
|
216
237
|
/**
|
|
238
|
+
* @public
|
|
217
239
|
* <p>The type of association.</p>
|
|
218
240
|
*/
|
|
219
241
|
associationType: AssociationType | string | undefined;
|
|
220
242
|
/**
|
|
243
|
+
* @public
|
|
221
244
|
* <p>A union type that currently has a single argument, the knowledge base ID.</p>
|
|
222
245
|
*/
|
|
223
246
|
associationData: AssistantAssociationOutputData | undefined;
|
|
224
247
|
/**
|
|
248
|
+
* @public
|
|
225
249
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
226
250
|
*/
|
|
227
251
|
tags?: Record<string, string>;
|
|
@@ -231,6 +255,7 @@ export interface AssistantAssociationData {
|
|
|
231
255
|
*/
|
|
232
256
|
export interface CreateAssistantAssociationResponse {
|
|
233
257
|
/**
|
|
258
|
+
* @public
|
|
234
259
|
* <p>The assistant association.</p>
|
|
235
260
|
*/
|
|
236
261
|
assistantAssociation?: AssistantAssociationData;
|
|
@@ -243,6 +268,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
243
268
|
readonly name: "ResourceNotFoundException";
|
|
244
269
|
readonly $fault: "client";
|
|
245
270
|
/**
|
|
271
|
+
* @public
|
|
246
272
|
* <p>The specified resource name.</p>
|
|
247
273
|
*/
|
|
248
274
|
resourceName?: string;
|
|
@@ -281,10 +307,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
281
307
|
*/
|
|
282
308
|
export interface DeleteAssistantAssociationRequest {
|
|
283
309
|
/**
|
|
310
|
+
* @public
|
|
284
311
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
285
312
|
*/
|
|
286
313
|
assistantAssociationId: string | undefined;
|
|
287
314
|
/**
|
|
315
|
+
* @public
|
|
288
316
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
289
317
|
*/
|
|
290
318
|
assistantId: string | undefined;
|
|
@@ -299,10 +327,12 @@ export interface DeleteAssistantAssociationResponse {
|
|
|
299
327
|
*/
|
|
300
328
|
export interface GetAssistantAssociationRequest {
|
|
301
329
|
/**
|
|
330
|
+
* @public
|
|
302
331
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
303
332
|
*/
|
|
304
333
|
assistantAssociationId: string | undefined;
|
|
305
334
|
/**
|
|
335
|
+
* @public
|
|
306
336
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
307
337
|
*/
|
|
308
338
|
assistantId: string | undefined;
|
|
@@ -312,6 +342,7 @@ export interface GetAssistantAssociationRequest {
|
|
|
312
342
|
*/
|
|
313
343
|
export interface GetAssistantAssociationResponse {
|
|
314
344
|
/**
|
|
345
|
+
* @public
|
|
315
346
|
* <p>The assistant association.</p>
|
|
316
347
|
*/
|
|
317
348
|
assistantAssociation?: AssistantAssociationData;
|
|
@@ -321,15 +352,18 @@ export interface GetAssistantAssociationResponse {
|
|
|
321
352
|
*/
|
|
322
353
|
export interface ListAssistantAssociationsRequest {
|
|
323
354
|
/**
|
|
355
|
+
* @public
|
|
324
356
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
325
357
|
* response in the next request to retrieve the next set of results.</p>
|
|
326
358
|
*/
|
|
327
359
|
nextToken?: string;
|
|
328
360
|
/**
|
|
361
|
+
* @public
|
|
329
362
|
* <p>The maximum number of results to return per page.</p>
|
|
330
363
|
*/
|
|
331
364
|
maxResults?: number;
|
|
332
365
|
/**
|
|
366
|
+
* @public
|
|
333
367
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
334
368
|
*/
|
|
335
369
|
assistantId: string | undefined;
|
|
@@ -340,30 +374,37 @@ export interface ListAssistantAssociationsRequest {
|
|
|
340
374
|
*/
|
|
341
375
|
export interface AssistantAssociationSummary {
|
|
342
376
|
/**
|
|
377
|
+
* @public
|
|
343
378
|
* <p>The identifier of the assistant association.</p>
|
|
344
379
|
*/
|
|
345
380
|
assistantAssociationId: string | undefined;
|
|
346
381
|
/**
|
|
382
|
+
* @public
|
|
347
383
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
348
384
|
*/
|
|
349
385
|
assistantAssociationArn: string | undefined;
|
|
350
386
|
/**
|
|
387
|
+
* @public
|
|
351
388
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
352
389
|
*/
|
|
353
390
|
assistantId: string | undefined;
|
|
354
391
|
/**
|
|
392
|
+
* @public
|
|
355
393
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
356
394
|
*/
|
|
357
395
|
assistantArn: string | undefined;
|
|
358
396
|
/**
|
|
397
|
+
* @public
|
|
359
398
|
* <p>The type of association.</p>
|
|
360
399
|
*/
|
|
361
400
|
associationType: AssociationType | string | undefined;
|
|
362
401
|
/**
|
|
402
|
+
* @public
|
|
363
403
|
* <p>The association data.</p>
|
|
364
404
|
*/
|
|
365
405
|
associationData: AssistantAssociationOutputData | undefined;
|
|
366
406
|
/**
|
|
407
|
+
* @public
|
|
367
408
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
368
409
|
*/
|
|
369
410
|
tags?: Record<string, string>;
|
|
@@ -373,10 +414,12 @@ export interface AssistantAssociationSummary {
|
|
|
373
414
|
*/
|
|
374
415
|
export interface ListAssistantAssociationsResponse {
|
|
375
416
|
/**
|
|
417
|
+
* @public
|
|
376
418
|
* <p>Summary information about assistant associations.</p>
|
|
377
419
|
*/
|
|
378
420
|
assistantAssociationSummaries: AssistantAssociationSummary[] | undefined;
|
|
379
421
|
/**
|
|
422
|
+
* @public
|
|
380
423
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
381
424
|
*/
|
|
382
425
|
nextToken?: string;
|
|
@@ -387,6 +430,7 @@ export interface ListAssistantAssociationsResponse {
|
|
|
387
430
|
*/
|
|
388
431
|
export interface ServerSideEncryptionConfiguration {
|
|
389
432
|
/**
|
|
433
|
+
* @public
|
|
390
434
|
* <p>The KMS key. For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers
|
|
391
435
|
* (KeyId)</a>.</p>
|
|
392
436
|
*/
|
|
@@ -408,6 +452,7 @@ export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
|
|
|
408
452
|
*/
|
|
409
453
|
export interface CreateAssistantRequest {
|
|
410
454
|
/**
|
|
455
|
+
* @public
|
|
411
456
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
412
457
|
* request. If not provided, the Amazon Web Services
|
|
413
458
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -415,22 +460,27 @@ export interface CreateAssistantRequest {
|
|
|
415
460
|
*/
|
|
416
461
|
clientToken?: string;
|
|
417
462
|
/**
|
|
463
|
+
* @public
|
|
418
464
|
* <p>The name of the assistant.</p>
|
|
419
465
|
*/
|
|
420
466
|
name: string | undefined;
|
|
421
467
|
/**
|
|
468
|
+
* @public
|
|
422
469
|
* <p>The type of assistant.</p>
|
|
423
470
|
*/
|
|
424
471
|
type: AssistantType | string | undefined;
|
|
425
472
|
/**
|
|
473
|
+
* @public
|
|
426
474
|
* <p>The description of the assistant.</p>
|
|
427
475
|
*/
|
|
428
476
|
description?: string;
|
|
429
477
|
/**
|
|
478
|
+
* @public
|
|
430
479
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
431
480
|
*/
|
|
432
481
|
tags?: Record<string, string>;
|
|
433
482
|
/**
|
|
483
|
+
* @public
|
|
434
484
|
* <p>The KMS key used for encryption.</p>
|
|
435
485
|
*/
|
|
436
486
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
@@ -441,6 +491,7 @@ export interface CreateAssistantRequest {
|
|
|
441
491
|
*/
|
|
442
492
|
export interface AssistantIntegrationConfiguration {
|
|
443
493
|
/**
|
|
494
|
+
* @public
|
|
444
495
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
445
496
|
*/
|
|
446
497
|
topicIntegrationArn?: string;
|
|
@@ -467,38 +518,47 @@ export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantSta
|
|
|
467
518
|
*/
|
|
468
519
|
export interface AssistantData {
|
|
469
520
|
/**
|
|
521
|
+
* @public
|
|
470
522
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
471
523
|
*/
|
|
472
524
|
assistantId: string | undefined;
|
|
473
525
|
/**
|
|
526
|
+
* @public
|
|
474
527
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
475
528
|
*/
|
|
476
529
|
assistantArn: string | undefined;
|
|
477
530
|
/**
|
|
531
|
+
* @public
|
|
478
532
|
* <p>The name.</p>
|
|
479
533
|
*/
|
|
480
534
|
name: string | undefined;
|
|
481
535
|
/**
|
|
536
|
+
* @public
|
|
482
537
|
* <p>The type of assistant.</p>
|
|
483
538
|
*/
|
|
484
539
|
type: AssistantType | string | undefined;
|
|
485
540
|
/**
|
|
541
|
+
* @public
|
|
486
542
|
* <p>The status of the assistant.</p>
|
|
487
543
|
*/
|
|
488
544
|
status: AssistantStatus | string | undefined;
|
|
489
545
|
/**
|
|
546
|
+
* @public
|
|
490
547
|
* <p>The description.</p>
|
|
491
548
|
*/
|
|
492
549
|
description?: string;
|
|
493
550
|
/**
|
|
551
|
+
* @public
|
|
494
552
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
495
553
|
*/
|
|
496
554
|
tags?: Record<string, string>;
|
|
497
555
|
/**
|
|
556
|
+
* @public
|
|
498
557
|
* <p>The KMS key used for encryption.</p>
|
|
499
558
|
*/
|
|
500
559
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
501
560
|
/**
|
|
561
|
+
* @public
|
|
502
562
|
* <p>The configuration information for the Wisdom assistant integration.</p>
|
|
503
563
|
*/
|
|
504
564
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
@@ -508,6 +568,7 @@ export interface AssistantData {
|
|
|
508
568
|
*/
|
|
509
569
|
export interface CreateAssistantResponse {
|
|
510
570
|
/**
|
|
571
|
+
* @public
|
|
511
572
|
* <p>Information about the assistant.</p>
|
|
512
573
|
*/
|
|
513
574
|
assistant?: AssistantData;
|
|
@@ -517,6 +578,7 @@ export interface CreateAssistantResponse {
|
|
|
517
578
|
*/
|
|
518
579
|
export interface DeleteAssistantRequest {
|
|
519
580
|
/**
|
|
581
|
+
* @public
|
|
520
582
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
521
583
|
*/
|
|
522
584
|
assistantId: string | undefined;
|
|
@@ -531,6 +593,7 @@ export interface DeleteAssistantResponse {
|
|
|
531
593
|
*/
|
|
532
594
|
export interface GetAssistantRequest {
|
|
533
595
|
/**
|
|
596
|
+
* @public
|
|
534
597
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
535
598
|
*/
|
|
536
599
|
assistantId: string | undefined;
|
|
@@ -540,6 +603,7 @@ export interface GetAssistantRequest {
|
|
|
540
603
|
*/
|
|
541
604
|
export interface GetAssistantResponse {
|
|
542
605
|
/**
|
|
606
|
+
* @public
|
|
543
607
|
* <p>Information about the assistant.</p>
|
|
544
608
|
*/
|
|
545
609
|
assistant?: AssistantData;
|
|
@@ -549,18 +613,22 @@ export interface GetAssistantResponse {
|
|
|
549
613
|
*/
|
|
550
614
|
export interface GetRecommendationsRequest {
|
|
551
615
|
/**
|
|
616
|
+
* @public
|
|
552
617
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
553
618
|
*/
|
|
554
619
|
assistantId: string | undefined;
|
|
555
620
|
/**
|
|
621
|
+
* @public
|
|
556
622
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
557
623
|
*/
|
|
558
624
|
sessionId: string | undefined;
|
|
559
625
|
/**
|
|
626
|
+
* @public
|
|
560
627
|
* <p>The maximum number of results to return per page.</p>
|
|
561
628
|
*/
|
|
562
629
|
maxResults?: number;
|
|
563
630
|
/**
|
|
631
|
+
* @public
|
|
564
632
|
* <p>The duration (in seconds) for which the call waits for a recommendation to be made
|
|
565
633
|
* available before returning. If a recommendation is available, the call returns sooner than
|
|
566
634
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the
|
|
@@ -574,18 +642,22 @@ export interface GetRecommendationsRequest {
|
|
|
574
642
|
*/
|
|
575
643
|
export interface ContentReference {
|
|
576
644
|
/**
|
|
645
|
+
* @public
|
|
577
646
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
578
647
|
*/
|
|
579
648
|
knowledgeBaseArn?: string;
|
|
580
649
|
/**
|
|
650
|
+
* @public
|
|
581
651
|
* <p>The identifier of the knowledge base.</p>
|
|
582
652
|
*/
|
|
583
653
|
knowledgeBaseId?: string;
|
|
584
654
|
/**
|
|
655
|
+
* @public
|
|
585
656
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
586
657
|
*/
|
|
587
658
|
contentArn?: string;
|
|
588
659
|
/**
|
|
660
|
+
* @public
|
|
589
661
|
* <p>The identifier of the content.</p>
|
|
590
662
|
*/
|
|
591
663
|
contentId?: string;
|
|
@@ -597,10 +669,12 @@ export interface ContentReference {
|
|
|
597
669
|
*/
|
|
598
670
|
export interface Highlight {
|
|
599
671
|
/**
|
|
672
|
+
* @public
|
|
600
673
|
* <p>The offset for the start of the highlight.</p>
|
|
601
674
|
*/
|
|
602
675
|
beginOffsetInclusive?: number;
|
|
603
676
|
/**
|
|
677
|
+
* @public
|
|
604
678
|
* <p>The offset for the end of the highlight.</p>
|
|
605
679
|
*/
|
|
606
680
|
endOffsetExclusive?: number;
|
|
@@ -611,10 +685,12 @@ export interface Highlight {
|
|
|
611
685
|
*/
|
|
612
686
|
export interface DocumentText {
|
|
613
687
|
/**
|
|
688
|
+
* @public
|
|
614
689
|
* <p>Text in the document.</p>
|
|
615
690
|
*/
|
|
616
691
|
text?: string;
|
|
617
692
|
/**
|
|
693
|
+
* @public
|
|
618
694
|
* <p>Highlights in the document text.</p>
|
|
619
695
|
*/
|
|
620
696
|
highlights?: Highlight[];
|
|
@@ -625,14 +701,17 @@ export interface DocumentText {
|
|
|
625
701
|
*/
|
|
626
702
|
export interface Document {
|
|
627
703
|
/**
|
|
704
|
+
* @public
|
|
628
705
|
* <p>A reference to the content resource.</p>
|
|
629
706
|
*/
|
|
630
707
|
contentReference: ContentReference | undefined;
|
|
631
708
|
/**
|
|
709
|
+
* @public
|
|
632
710
|
* <p>The title of the document.</p>
|
|
633
711
|
*/
|
|
634
712
|
title?: DocumentText;
|
|
635
713
|
/**
|
|
714
|
+
* @public
|
|
636
715
|
* <p>The excerpt from the document.</p>
|
|
637
716
|
*/
|
|
638
717
|
excerpt?: DocumentText;
|
|
@@ -667,22 +746,27 @@ export type RecommendationType = (typeof RecommendationType)[keyof typeof Recomm
|
|
|
667
746
|
*/
|
|
668
747
|
export interface RecommendationData {
|
|
669
748
|
/**
|
|
749
|
+
* @public
|
|
670
750
|
* <p>The identifier of the recommendation.</p>
|
|
671
751
|
*/
|
|
672
752
|
recommendationId: string | undefined;
|
|
673
753
|
/**
|
|
754
|
+
* @public
|
|
674
755
|
* <p>The recommended document.</p>
|
|
675
756
|
*/
|
|
676
757
|
document: Document | undefined;
|
|
677
758
|
/**
|
|
759
|
+
* @public
|
|
678
760
|
* <p>The relevance score of the recommendation.</p>
|
|
679
761
|
*/
|
|
680
762
|
relevanceScore?: number;
|
|
681
763
|
/**
|
|
764
|
+
* @public
|
|
682
765
|
* <p>The relevance level of the recommendation.</p>
|
|
683
766
|
*/
|
|
684
767
|
relevanceLevel?: RelevanceLevel | string;
|
|
685
768
|
/**
|
|
769
|
+
* @public
|
|
686
770
|
* <p>The type of recommendation.</p>
|
|
687
771
|
*/
|
|
688
772
|
type?: RecommendationType | string;
|
|
@@ -693,6 +777,7 @@ export interface RecommendationData {
|
|
|
693
777
|
*/
|
|
694
778
|
export interface QueryRecommendationTriggerData {
|
|
695
779
|
/**
|
|
780
|
+
* @public
|
|
696
781
|
* <p>The text associated with the recommendation trigger.</p>
|
|
697
782
|
*/
|
|
698
783
|
text?: string;
|
|
@@ -707,12 +792,16 @@ export type RecommendationTriggerData = RecommendationTriggerData.QueryMember |
|
|
|
707
792
|
*/
|
|
708
793
|
export declare namespace RecommendationTriggerData {
|
|
709
794
|
/**
|
|
795
|
+
* @public
|
|
710
796
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
711
797
|
*/
|
|
712
798
|
interface QueryMember {
|
|
713
799
|
query: QueryRecommendationTriggerData;
|
|
714
800
|
$unknown?: never;
|
|
715
801
|
}
|
|
802
|
+
/**
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
716
805
|
interface $UnknownMember {
|
|
717
806
|
query?: never;
|
|
718
807
|
$unknown: [string, any];
|
|
@@ -755,14 +844,17 @@ export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof
|
|
|
755
844
|
*/
|
|
756
845
|
export interface RecommendationTrigger {
|
|
757
846
|
/**
|
|
847
|
+
* @public
|
|
758
848
|
* <p>The identifier of the recommendation trigger.</p>
|
|
759
849
|
*/
|
|
760
850
|
id: string | undefined;
|
|
761
851
|
/**
|
|
852
|
+
* @public
|
|
762
853
|
* <p>The type of recommendation trigger.</p>
|
|
763
854
|
*/
|
|
764
855
|
type: RecommendationTriggerType | string | undefined;
|
|
765
856
|
/**
|
|
857
|
+
* @public
|
|
766
858
|
* <p>The source of the recommendation trigger.</p>
|
|
767
859
|
* <ul>
|
|
768
860
|
* <li>
|
|
@@ -777,10 +869,12 @@ export interface RecommendationTrigger {
|
|
|
777
869
|
*/
|
|
778
870
|
source: RecommendationSourceType | string | undefined;
|
|
779
871
|
/**
|
|
872
|
+
* @public
|
|
780
873
|
* <p>A union type containing information related to the trigger.</p>
|
|
781
874
|
*/
|
|
782
875
|
data: RecommendationTriggerData | undefined;
|
|
783
876
|
/**
|
|
877
|
+
* @public
|
|
784
878
|
* <p>The identifiers of the recommendations.</p>
|
|
785
879
|
*/
|
|
786
880
|
recommendationIds: string[] | undefined;
|
|
@@ -790,10 +884,12 @@ export interface RecommendationTrigger {
|
|
|
790
884
|
*/
|
|
791
885
|
export interface GetRecommendationsResponse {
|
|
792
886
|
/**
|
|
887
|
+
* @public
|
|
793
888
|
* <p>The recommendations.</p>
|
|
794
889
|
*/
|
|
795
890
|
recommendations: RecommendationData[] | undefined;
|
|
796
891
|
/**
|
|
892
|
+
* @public
|
|
797
893
|
* <p>The triggers corresponding to recommendations.</p>
|
|
798
894
|
*/
|
|
799
895
|
triggers?: RecommendationTrigger[];
|
|
@@ -803,11 +899,13 @@ export interface GetRecommendationsResponse {
|
|
|
803
899
|
*/
|
|
804
900
|
export interface ListAssistantsRequest {
|
|
805
901
|
/**
|
|
902
|
+
* @public
|
|
806
903
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
807
904
|
* response in the next request to retrieve the next set of results.</p>
|
|
808
905
|
*/
|
|
809
906
|
nextToken?: string;
|
|
810
907
|
/**
|
|
908
|
+
* @public
|
|
811
909
|
* <p>The maximum number of results to return per page.</p>
|
|
812
910
|
*/
|
|
813
911
|
maxResults?: number;
|
|
@@ -818,38 +916,47 @@ export interface ListAssistantsRequest {
|
|
|
818
916
|
*/
|
|
819
917
|
export interface AssistantSummary {
|
|
820
918
|
/**
|
|
919
|
+
* @public
|
|
821
920
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
822
921
|
*/
|
|
823
922
|
assistantId: string | undefined;
|
|
824
923
|
/**
|
|
924
|
+
* @public
|
|
825
925
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
826
926
|
*/
|
|
827
927
|
assistantArn: string | undefined;
|
|
828
928
|
/**
|
|
929
|
+
* @public
|
|
829
930
|
* <p>The name of the assistant.</p>
|
|
830
931
|
*/
|
|
831
932
|
name: string | undefined;
|
|
832
933
|
/**
|
|
934
|
+
* @public
|
|
833
935
|
* <p>The type of the assistant.</p>
|
|
834
936
|
*/
|
|
835
937
|
type: AssistantType | string | undefined;
|
|
836
938
|
/**
|
|
939
|
+
* @public
|
|
837
940
|
* <p>The status of the assistant.</p>
|
|
838
941
|
*/
|
|
839
942
|
status: AssistantStatus | string | undefined;
|
|
840
943
|
/**
|
|
944
|
+
* @public
|
|
841
945
|
* <p>The description of the assistant.</p>
|
|
842
946
|
*/
|
|
843
947
|
description?: string;
|
|
844
948
|
/**
|
|
949
|
+
* @public
|
|
845
950
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
846
951
|
*/
|
|
847
952
|
tags?: Record<string, string>;
|
|
848
953
|
/**
|
|
954
|
+
* @public
|
|
849
955
|
* <p>The KMS key used for encryption.</p>
|
|
850
956
|
*/
|
|
851
957
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
852
958
|
/**
|
|
959
|
+
* @public
|
|
853
960
|
* <p>The configuration information for the Wisdom assistant integration.</p>
|
|
854
961
|
*/
|
|
855
962
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
@@ -859,10 +966,12 @@ export interface AssistantSummary {
|
|
|
859
966
|
*/
|
|
860
967
|
export interface ListAssistantsResponse {
|
|
861
968
|
/**
|
|
969
|
+
* @public
|
|
862
970
|
* <p>Information about the assistants.</p>
|
|
863
971
|
*/
|
|
864
972
|
assistantSummaries: AssistantSummary[] | undefined;
|
|
865
973
|
/**
|
|
974
|
+
* @public
|
|
866
975
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
867
976
|
*/
|
|
868
977
|
nextToken?: string;
|
|
@@ -872,14 +981,17 @@ export interface ListAssistantsResponse {
|
|
|
872
981
|
*/
|
|
873
982
|
export interface NotifyRecommendationsReceivedRequest {
|
|
874
983
|
/**
|
|
984
|
+
* @public
|
|
875
985
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
876
986
|
*/
|
|
877
987
|
assistantId: string | undefined;
|
|
878
988
|
/**
|
|
989
|
+
* @public
|
|
879
990
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
880
991
|
*/
|
|
881
992
|
sessionId: string | undefined;
|
|
882
993
|
/**
|
|
994
|
+
* @public
|
|
883
995
|
* <p>The identifiers of the recommendations.</p>
|
|
884
996
|
*/
|
|
885
997
|
recommendationIds: string[] | undefined;
|
|
@@ -890,10 +1002,12 @@ export interface NotifyRecommendationsReceivedRequest {
|
|
|
890
1002
|
*/
|
|
891
1003
|
export interface NotifyRecommendationsReceivedError {
|
|
892
1004
|
/**
|
|
1005
|
+
* @public
|
|
893
1006
|
* <p>The identifier of the recommendation that is in error.</p>
|
|
894
1007
|
*/
|
|
895
1008
|
recommendationId?: string;
|
|
896
1009
|
/**
|
|
1010
|
+
* @public
|
|
897
1011
|
* <p>A recommendation is causing an error.</p>
|
|
898
1012
|
*/
|
|
899
1013
|
message?: string;
|
|
@@ -903,10 +1017,12 @@ export interface NotifyRecommendationsReceivedError {
|
|
|
903
1017
|
*/
|
|
904
1018
|
export interface NotifyRecommendationsReceivedResponse {
|
|
905
1019
|
/**
|
|
1020
|
+
* @public
|
|
906
1021
|
* <p>The identifiers of the recommendations.</p>
|
|
907
1022
|
*/
|
|
908
1023
|
recommendationIds?: string[];
|
|
909
1024
|
/**
|
|
1025
|
+
* @public
|
|
910
1026
|
* <p>The identifiers of recommendations that are causing errors.</p>
|
|
911
1027
|
*/
|
|
912
1028
|
errors?: NotifyRecommendationsReceivedError[];
|
|
@@ -916,19 +1032,23 @@ export interface NotifyRecommendationsReceivedResponse {
|
|
|
916
1032
|
*/
|
|
917
1033
|
export interface QueryAssistantRequest {
|
|
918
1034
|
/**
|
|
1035
|
+
* @public
|
|
919
1036
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
920
1037
|
*/
|
|
921
1038
|
assistantId: string | undefined;
|
|
922
1039
|
/**
|
|
1040
|
+
* @public
|
|
923
1041
|
* <p>The text to search for.</p>
|
|
924
1042
|
*/
|
|
925
1043
|
queryText: string | undefined;
|
|
926
1044
|
/**
|
|
1045
|
+
* @public
|
|
927
1046
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
928
1047
|
* response in the next request to retrieve the next set of results.</p>
|
|
929
1048
|
*/
|
|
930
1049
|
nextToken?: string;
|
|
931
1050
|
/**
|
|
1051
|
+
* @public
|
|
932
1052
|
* <p>The maximum number of results to return per page.</p>
|
|
933
1053
|
*/
|
|
934
1054
|
maxResults?: number;
|
|
@@ -939,14 +1059,17 @@ export interface QueryAssistantRequest {
|
|
|
939
1059
|
*/
|
|
940
1060
|
export interface ResultData {
|
|
941
1061
|
/**
|
|
1062
|
+
* @public
|
|
942
1063
|
* <p>The identifier of the result data.</p>
|
|
943
1064
|
*/
|
|
944
1065
|
resultId: string | undefined;
|
|
945
1066
|
/**
|
|
1067
|
+
* @public
|
|
946
1068
|
* <p>The document.</p>
|
|
947
1069
|
*/
|
|
948
1070
|
document: Document | undefined;
|
|
949
1071
|
/**
|
|
1072
|
+
* @public
|
|
950
1073
|
* <p>The relevance score of the results.</p>
|
|
951
1074
|
*/
|
|
952
1075
|
relevanceScore?: number;
|
|
@@ -956,10 +1079,12 @@ export interface ResultData {
|
|
|
956
1079
|
*/
|
|
957
1080
|
export interface QueryAssistantResponse {
|
|
958
1081
|
/**
|
|
1082
|
+
* @public
|
|
959
1083
|
* <p>The results of the query.</p>
|
|
960
1084
|
*/
|
|
961
1085
|
results: ResultData[] | undefined;
|
|
962
1086
|
/**
|
|
1087
|
+
* @public
|
|
963
1088
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
964
1089
|
*/
|
|
965
1090
|
nextToken?: string;
|
|
@@ -992,14 +1117,17 @@ export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator
|
|
|
992
1117
|
*/
|
|
993
1118
|
export interface Filter {
|
|
994
1119
|
/**
|
|
1120
|
+
* @public
|
|
995
1121
|
* <p>The field on which to filter.</p>
|
|
996
1122
|
*/
|
|
997
1123
|
field: FilterField | string | undefined;
|
|
998
1124
|
/**
|
|
1125
|
+
* @public
|
|
999
1126
|
* <p>The operator to use for comparing the field’s value with the provided value.</p>
|
|
1000
1127
|
*/
|
|
1001
1128
|
operator: FilterOperator | string | undefined;
|
|
1002
1129
|
/**
|
|
1130
|
+
* @public
|
|
1003
1131
|
* <p>The desired field value on which to filter.</p>
|
|
1004
1132
|
*/
|
|
1005
1133
|
value: string | undefined;
|
|
@@ -1010,6 +1138,7 @@ export interface Filter {
|
|
|
1010
1138
|
*/
|
|
1011
1139
|
export interface SearchExpression {
|
|
1012
1140
|
/**
|
|
1141
|
+
* @public
|
|
1013
1142
|
* <p>The search expression filters.</p>
|
|
1014
1143
|
*/
|
|
1015
1144
|
filters: Filter[] | undefined;
|
|
@@ -1019,19 +1148,23 @@ export interface SearchExpression {
|
|
|
1019
1148
|
*/
|
|
1020
1149
|
export interface SearchSessionsRequest {
|
|
1021
1150
|
/**
|
|
1151
|
+
* @public
|
|
1022
1152
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1023
1153
|
* response in the next request to retrieve the next set of results.</p>
|
|
1024
1154
|
*/
|
|
1025
1155
|
nextToken?: string;
|
|
1026
1156
|
/**
|
|
1157
|
+
* @public
|
|
1027
1158
|
* <p>The maximum number of results to return per page.</p>
|
|
1028
1159
|
*/
|
|
1029
1160
|
maxResults?: number;
|
|
1030
1161
|
/**
|
|
1162
|
+
* @public
|
|
1031
1163
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1032
1164
|
*/
|
|
1033
1165
|
assistantId: string | undefined;
|
|
1034
1166
|
/**
|
|
1167
|
+
* @public
|
|
1035
1168
|
* <p>The search expression to filter results.</p>
|
|
1036
1169
|
*/
|
|
1037
1170
|
searchExpression: SearchExpression | undefined;
|
|
@@ -1042,18 +1175,22 @@ export interface SearchSessionsRequest {
|
|
|
1042
1175
|
*/
|
|
1043
1176
|
export interface SessionSummary {
|
|
1044
1177
|
/**
|
|
1178
|
+
* @public
|
|
1045
1179
|
* <p>The identifier of the session.</p>
|
|
1046
1180
|
*/
|
|
1047
1181
|
sessionId: string | undefined;
|
|
1048
1182
|
/**
|
|
1183
|
+
* @public
|
|
1049
1184
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1050
1185
|
*/
|
|
1051
1186
|
sessionArn: string | undefined;
|
|
1052
1187
|
/**
|
|
1188
|
+
* @public
|
|
1053
1189
|
* <p>The identifier of the Wisdom assistant.</p>
|
|
1054
1190
|
*/
|
|
1055
1191
|
assistantId: string | undefined;
|
|
1056
1192
|
/**
|
|
1193
|
+
* @public
|
|
1057
1194
|
* <p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>
|
|
1058
1195
|
*/
|
|
1059
1196
|
assistantArn: string | undefined;
|
|
@@ -1063,10 +1200,12 @@ export interface SessionSummary {
|
|
|
1063
1200
|
*/
|
|
1064
1201
|
export interface SearchSessionsResponse {
|
|
1065
1202
|
/**
|
|
1203
|
+
* @public
|
|
1066
1204
|
* <p>Summary information about the sessions.</p>
|
|
1067
1205
|
*/
|
|
1068
1206
|
sessionSummaries: SessionSummary[] | undefined;
|
|
1069
1207
|
/**
|
|
1208
|
+
* @public
|
|
1070
1209
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1071
1210
|
*/
|
|
1072
1211
|
nextToken?: string;
|
|
@@ -1076,6 +1215,7 @@ export interface SearchSessionsResponse {
|
|
|
1076
1215
|
*/
|
|
1077
1216
|
export interface CreateSessionRequest {
|
|
1078
1217
|
/**
|
|
1218
|
+
* @public
|
|
1079
1219
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1080
1220
|
* request. If not provided, the Amazon Web Services
|
|
1081
1221
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -1083,18 +1223,22 @@ export interface CreateSessionRequest {
|
|
|
1083
1223
|
*/
|
|
1084
1224
|
clientToken?: string;
|
|
1085
1225
|
/**
|
|
1226
|
+
* @public
|
|
1086
1227
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1087
1228
|
*/
|
|
1088
1229
|
assistantId: string | undefined;
|
|
1089
1230
|
/**
|
|
1231
|
+
* @public
|
|
1090
1232
|
* <p>The name of the session.</p>
|
|
1091
1233
|
*/
|
|
1092
1234
|
name: string | undefined;
|
|
1093
1235
|
/**
|
|
1236
|
+
* @public
|
|
1094
1237
|
* <p>The description.</p>
|
|
1095
1238
|
*/
|
|
1096
1239
|
description?: string;
|
|
1097
1240
|
/**
|
|
1241
|
+
* @public
|
|
1098
1242
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1099
1243
|
*/
|
|
1100
1244
|
tags?: Record<string, string>;
|
|
@@ -1105,6 +1249,7 @@ export interface CreateSessionRequest {
|
|
|
1105
1249
|
*/
|
|
1106
1250
|
export interface SessionIntegrationConfiguration {
|
|
1107
1251
|
/**
|
|
1252
|
+
* @public
|
|
1108
1253
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
1109
1254
|
*/
|
|
1110
1255
|
topicIntegrationArn?: string;
|
|
@@ -1115,26 +1260,32 @@ export interface SessionIntegrationConfiguration {
|
|
|
1115
1260
|
*/
|
|
1116
1261
|
export interface SessionData {
|
|
1117
1262
|
/**
|
|
1263
|
+
* @public
|
|
1118
1264
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1119
1265
|
*/
|
|
1120
1266
|
sessionArn: string | undefined;
|
|
1121
1267
|
/**
|
|
1268
|
+
* @public
|
|
1122
1269
|
* <p>The identifier of the session.</p>
|
|
1123
1270
|
*/
|
|
1124
1271
|
sessionId: string | undefined;
|
|
1125
1272
|
/**
|
|
1273
|
+
* @public
|
|
1126
1274
|
* <p>The name of the session.</p>
|
|
1127
1275
|
*/
|
|
1128
1276
|
name: string | undefined;
|
|
1129
1277
|
/**
|
|
1278
|
+
* @public
|
|
1130
1279
|
* <p>The description of the session.</p>
|
|
1131
1280
|
*/
|
|
1132
1281
|
description?: string;
|
|
1133
1282
|
/**
|
|
1283
|
+
* @public
|
|
1134
1284
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1135
1285
|
*/
|
|
1136
1286
|
tags?: Record<string, string>;
|
|
1137
1287
|
/**
|
|
1288
|
+
* @public
|
|
1138
1289
|
* <p>The configuration information for the session integration.</p>
|
|
1139
1290
|
*/
|
|
1140
1291
|
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
@@ -1144,6 +1295,7 @@ export interface SessionData {
|
|
|
1144
1295
|
*/
|
|
1145
1296
|
export interface CreateSessionResponse {
|
|
1146
1297
|
/**
|
|
1298
|
+
* @public
|
|
1147
1299
|
* <p>The session.</p>
|
|
1148
1300
|
*/
|
|
1149
1301
|
session?: SessionData;
|
|
@@ -1153,10 +1305,12 @@ export interface CreateSessionResponse {
|
|
|
1153
1305
|
*/
|
|
1154
1306
|
export interface GetSessionRequest {
|
|
1155
1307
|
/**
|
|
1308
|
+
* @public
|
|
1156
1309
|
* <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1157
1310
|
*/
|
|
1158
1311
|
assistantId: string | undefined;
|
|
1159
1312
|
/**
|
|
1313
|
+
* @public
|
|
1160
1314
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1161
1315
|
*/
|
|
1162
1316
|
sessionId: string | undefined;
|
|
@@ -1166,6 +1320,7 @@ export interface GetSessionRequest {
|
|
|
1166
1320
|
*/
|
|
1167
1321
|
export interface GetSessionResponse {
|
|
1168
1322
|
/**
|
|
1323
|
+
* @public
|
|
1169
1324
|
* <p>The session.</p>
|
|
1170
1325
|
*/
|
|
1171
1326
|
session?: SessionData;
|
|
@@ -1175,34 +1330,41 @@ export interface GetSessionResponse {
|
|
|
1175
1330
|
*/
|
|
1176
1331
|
export interface CreateContentRequest {
|
|
1177
1332
|
/**
|
|
1333
|
+
* @public
|
|
1178
1334
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1179
1335
|
*/
|
|
1180
1336
|
knowledgeBaseId: string | undefined;
|
|
1181
1337
|
/**
|
|
1338
|
+
* @public
|
|
1182
1339
|
* <p>The name of the content. Each piece of content in a knowledge base must have a unique
|
|
1183
1340
|
* name. You can retrieve a piece of content using only its knowledge base and its name with the
|
|
1184
1341
|
* <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>
|
|
1185
1342
|
*/
|
|
1186
1343
|
name: string | undefined;
|
|
1187
1344
|
/**
|
|
1345
|
+
* @public
|
|
1188
1346
|
* <p>The title of the content. If not set, the title is equal to the name.</p>
|
|
1189
1347
|
*/
|
|
1190
1348
|
title?: string;
|
|
1191
1349
|
/**
|
|
1350
|
+
* @public
|
|
1192
1351
|
* <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
|
|
1193
1352
|
* this argument overrides it for this piece of content.</p>
|
|
1194
1353
|
*/
|
|
1195
1354
|
overrideLinkOutUri?: string;
|
|
1196
1355
|
/**
|
|
1356
|
+
* @public
|
|
1197
1357
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1198
1358
|
* 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>
|
|
1199
1359
|
*/
|
|
1200
1360
|
metadata?: Record<string, string>;
|
|
1201
1361
|
/**
|
|
1362
|
+
* @public
|
|
1202
1363
|
* <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>
|
|
1203
1364
|
*/
|
|
1204
1365
|
uploadId: string | undefined;
|
|
1205
1366
|
/**
|
|
1367
|
+
* @public
|
|
1206
1368
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1207
1369
|
* request. If not provided, the Amazon Web Services
|
|
1208
1370
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -1210,6 +1372,7 @@ export interface CreateContentRequest {
|
|
|
1210
1372
|
*/
|
|
1211
1373
|
clientToken?: string;
|
|
1212
1374
|
/**
|
|
1375
|
+
* @public
|
|
1213
1376
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1214
1377
|
*/
|
|
1215
1378
|
tags?: Record<string, string>;
|
|
@@ -1237,59 +1400,73 @@ export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
|
|
|
1237
1400
|
*/
|
|
1238
1401
|
export interface ContentData {
|
|
1239
1402
|
/**
|
|
1403
|
+
* @public
|
|
1240
1404
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1241
1405
|
*/
|
|
1242
1406
|
contentArn: string | undefined;
|
|
1243
1407
|
/**
|
|
1408
|
+
* @public
|
|
1244
1409
|
* <p>The identifier of the content.</p>
|
|
1245
1410
|
*/
|
|
1246
1411
|
contentId: string | undefined;
|
|
1247
1412
|
/**
|
|
1413
|
+
* @public
|
|
1248
1414
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1249
1415
|
*/
|
|
1250
1416
|
knowledgeBaseArn: string | undefined;
|
|
1251
1417
|
/**
|
|
1418
|
+
* @public
|
|
1252
1419
|
* <p>The identifier of the knowledge base.</p>
|
|
1253
1420
|
*/
|
|
1254
1421
|
knowledgeBaseId: string | undefined;
|
|
1255
1422
|
/**
|
|
1423
|
+
* @public
|
|
1256
1424
|
* <p>The name of the content.</p>
|
|
1257
1425
|
*/
|
|
1258
1426
|
name: string | undefined;
|
|
1259
1427
|
/**
|
|
1428
|
+
* @public
|
|
1260
1429
|
* <p>The identifier of the content revision.</p>
|
|
1261
1430
|
*/
|
|
1262
1431
|
revisionId: string | undefined;
|
|
1263
1432
|
/**
|
|
1433
|
+
* @public
|
|
1264
1434
|
* <p>The title of the content.</p>
|
|
1265
1435
|
*/
|
|
1266
1436
|
title: string | undefined;
|
|
1267
1437
|
/**
|
|
1438
|
+
* @public
|
|
1268
1439
|
* <p>The media type of the content.</p>
|
|
1269
1440
|
*/
|
|
1270
1441
|
contentType: string | undefined;
|
|
1271
1442
|
/**
|
|
1443
|
+
* @public
|
|
1272
1444
|
* <p>The status of the content.</p>
|
|
1273
1445
|
*/
|
|
1274
1446
|
status: ContentStatus | string | undefined;
|
|
1275
1447
|
/**
|
|
1448
|
+
* @public
|
|
1276
1449
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1277
1450
|
* 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>
|
|
1278
1451
|
*/
|
|
1279
1452
|
metadata: Record<string, string> | undefined;
|
|
1280
1453
|
/**
|
|
1454
|
+
* @public
|
|
1281
1455
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1282
1456
|
*/
|
|
1283
1457
|
tags?: Record<string, string>;
|
|
1284
1458
|
/**
|
|
1459
|
+
* @public
|
|
1285
1460
|
* <p>The URI of the content.</p>
|
|
1286
1461
|
*/
|
|
1287
1462
|
linkOutUri?: string;
|
|
1288
1463
|
/**
|
|
1464
|
+
* @public
|
|
1289
1465
|
* <p>The URL of the content.</p>
|
|
1290
1466
|
*/
|
|
1291
1467
|
url: string | undefined;
|
|
1292
1468
|
/**
|
|
1469
|
+
* @public
|
|
1293
1470
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
1294
1471
|
*/
|
|
1295
1472
|
urlExpiry: Date | undefined;
|
|
@@ -1299,6 +1476,7 @@ export interface ContentData {
|
|
|
1299
1476
|
*/
|
|
1300
1477
|
export interface CreateContentResponse {
|
|
1301
1478
|
/**
|
|
1479
|
+
* @public
|
|
1302
1480
|
* <p>The content.</p>
|
|
1303
1481
|
*/
|
|
1304
1482
|
content?: ContentData;
|
|
@@ -1308,10 +1486,12 @@ export interface CreateContentResponse {
|
|
|
1308
1486
|
*/
|
|
1309
1487
|
export interface DeleteContentRequest {
|
|
1310
1488
|
/**
|
|
1489
|
+
* @public
|
|
1311
1490
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1312
1491
|
*/
|
|
1313
1492
|
knowledgeBaseId: string | undefined;
|
|
1314
1493
|
/**
|
|
1494
|
+
* @public
|
|
1315
1495
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1316
1496
|
*/
|
|
1317
1497
|
contentId: string | undefined;
|
|
@@ -1326,10 +1506,12 @@ export interface DeleteContentResponse {
|
|
|
1326
1506
|
*/
|
|
1327
1507
|
export interface GetContentRequest {
|
|
1328
1508
|
/**
|
|
1509
|
+
* @public
|
|
1329
1510
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1330
1511
|
*/
|
|
1331
1512
|
contentId: string | undefined;
|
|
1332
1513
|
/**
|
|
1514
|
+
* @public
|
|
1333
1515
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1334
1516
|
*/
|
|
1335
1517
|
knowledgeBaseId: string | undefined;
|
|
@@ -1339,6 +1521,7 @@ export interface GetContentRequest {
|
|
|
1339
1521
|
*/
|
|
1340
1522
|
export interface GetContentResponse {
|
|
1341
1523
|
/**
|
|
1524
|
+
* @public
|
|
1342
1525
|
* <p>The content.</p>
|
|
1343
1526
|
*/
|
|
1344
1527
|
content?: ContentData;
|
|
@@ -1348,10 +1531,12 @@ export interface GetContentResponse {
|
|
|
1348
1531
|
*/
|
|
1349
1532
|
export interface GetContentSummaryRequest {
|
|
1350
1533
|
/**
|
|
1534
|
+
* @public
|
|
1351
1535
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1352
1536
|
*/
|
|
1353
1537
|
contentId: string | undefined;
|
|
1354
1538
|
/**
|
|
1539
|
+
* @public
|
|
1355
1540
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1356
1541
|
*/
|
|
1357
1542
|
knowledgeBaseId: string | undefined;
|
|
@@ -1362,47 +1547,58 @@ export interface GetContentSummaryRequest {
|
|
|
1362
1547
|
*/
|
|
1363
1548
|
export interface ContentSummary {
|
|
1364
1549
|
/**
|
|
1550
|
+
* @public
|
|
1365
1551
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1366
1552
|
*/
|
|
1367
1553
|
contentArn: string | undefined;
|
|
1368
1554
|
/**
|
|
1555
|
+
* @public
|
|
1369
1556
|
* <p>The identifier of the content.</p>
|
|
1370
1557
|
*/
|
|
1371
1558
|
contentId: string | undefined;
|
|
1372
1559
|
/**
|
|
1560
|
+
* @public
|
|
1373
1561
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1374
1562
|
*/
|
|
1375
1563
|
knowledgeBaseArn: string | undefined;
|
|
1376
1564
|
/**
|
|
1565
|
+
* @public
|
|
1377
1566
|
* <p>The identifier of the knowledge base.</p>
|
|
1378
1567
|
*/
|
|
1379
1568
|
knowledgeBaseId: string | undefined;
|
|
1380
1569
|
/**
|
|
1570
|
+
* @public
|
|
1381
1571
|
* <p>The name of the content.</p>
|
|
1382
1572
|
*/
|
|
1383
1573
|
name: string | undefined;
|
|
1384
1574
|
/**
|
|
1575
|
+
* @public
|
|
1385
1576
|
* <p>The identifier of the revision of the content.</p>
|
|
1386
1577
|
*/
|
|
1387
1578
|
revisionId: string | undefined;
|
|
1388
1579
|
/**
|
|
1580
|
+
* @public
|
|
1389
1581
|
* <p>The title of the content.</p>
|
|
1390
1582
|
*/
|
|
1391
1583
|
title: string | undefined;
|
|
1392
1584
|
/**
|
|
1585
|
+
* @public
|
|
1393
1586
|
* <p>The media type of the content.</p>
|
|
1394
1587
|
*/
|
|
1395
1588
|
contentType: string | undefined;
|
|
1396
1589
|
/**
|
|
1590
|
+
* @public
|
|
1397
1591
|
* <p>The status of the content.</p>
|
|
1398
1592
|
*/
|
|
1399
1593
|
status: ContentStatus | string | undefined;
|
|
1400
1594
|
/**
|
|
1595
|
+
* @public
|
|
1401
1596
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1402
1597
|
* 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>
|
|
1403
1598
|
*/
|
|
1404
1599
|
metadata: Record<string, string> | undefined;
|
|
1405
1600
|
/**
|
|
1601
|
+
* @public
|
|
1406
1602
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1407
1603
|
*/
|
|
1408
1604
|
tags?: Record<string, string>;
|
|
@@ -1412,6 +1608,7 @@ export interface ContentSummary {
|
|
|
1412
1608
|
*/
|
|
1413
1609
|
export interface GetContentSummaryResponse {
|
|
1414
1610
|
/**
|
|
1611
|
+
* @public
|
|
1415
1612
|
* <p>The content summary.</p>
|
|
1416
1613
|
*/
|
|
1417
1614
|
contentSummary?: ContentSummary;
|
|
@@ -1421,15 +1618,18 @@ export interface GetContentSummaryResponse {
|
|
|
1421
1618
|
*/
|
|
1422
1619
|
export interface ListContentsRequest {
|
|
1423
1620
|
/**
|
|
1621
|
+
* @public
|
|
1424
1622
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1425
1623
|
* response in the next request to retrieve the next set of results.</p>
|
|
1426
1624
|
*/
|
|
1427
1625
|
nextToken?: string;
|
|
1428
1626
|
/**
|
|
1627
|
+
* @public
|
|
1429
1628
|
* <p>The maximum number of results to return per page.</p>
|
|
1430
1629
|
*/
|
|
1431
1630
|
maxResults?: number;
|
|
1432
1631
|
/**
|
|
1632
|
+
* @public
|
|
1433
1633
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1434
1634
|
*/
|
|
1435
1635
|
knowledgeBaseId: string | undefined;
|
|
@@ -1439,10 +1639,12 @@ export interface ListContentsRequest {
|
|
|
1439
1639
|
*/
|
|
1440
1640
|
export interface ListContentsResponse {
|
|
1441
1641
|
/**
|
|
1642
|
+
* @public
|
|
1442
1643
|
* <p>Information about the content.</p>
|
|
1443
1644
|
*/
|
|
1444
1645
|
contentSummaries: ContentSummary[] | undefined;
|
|
1445
1646
|
/**
|
|
1647
|
+
* @public
|
|
1446
1648
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1447
1649
|
*/
|
|
1448
1650
|
nextToken?: string;
|
|
@@ -1465,14 +1667,17 @@ export declare class PreconditionFailedException extends __BaseException {
|
|
|
1465
1667
|
*/
|
|
1466
1668
|
export interface UpdateContentRequest {
|
|
1467
1669
|
/**
|
|
1670
|
+
* @public
|
|
1468
1671
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN</p>
|
|
1469
1672
|
*/
|
|
1470
1673
|
knowledgeBaseId: string | undefined;
|
|
1471
1674
|
/**
|
|
1675
|
+
* @public
|
|
1472
1676
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1473
1677
|
*/
|
|
1474
1678
|
contentId: string | undefined;
|
|
1475
1679
|
/**
|
|
1680
|
+
* @public
|
|
1476
1681
|
* <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call
|
|
1477
1682
|
* to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or
|
|
1478
1683
|
* <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure
|
|
@@ -1481,26 +1686,31 @@ export interface UpdateContentRequest {
|
|
|
1481
1686
|
*/
|
|
1482
1687
|
revisionId?: string;
|
|
1483
1688
|
/**
|
|
1689
|
+
* @public
|
|
1484
1690
|
* <p>The title of the content.</p>
|
|
1485
1691
|
*/
|
|
1486
1692
|
title?: string;
|
|
1487
1693
|
/**
|
|
1694
|
+
* @public
|
|
1488
1695
|
* <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
|
|
1489
1696
|
* overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
|
|
1490
1697
|
* exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
|
|
1491
1698
|
*/
|
|
1492
1699
|
overrideLinkOutUri?: string;
|
|
1493
1700
|
/**
|
|
1701
|
+
* @public
|
|
1494
1702
|
* <p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>
|
|
1495
1703
|
*/
|
|
1496
1704
|
removeOverrideLinkOutUri?: boolean;
|
|
1497
1705
|
/**
|
|
1706
|
+
* @public
|
|
1498
1707
|
* <p>A key/value map to store attributes without affecting tagging or recommendations. For
|
|
1499
1708
|
* example, when synchronizing data between an external system and Wisdom, you can store an
|
|
1500
1709
|
* external version identifier as metadata to utilize for determining drift.</p>
|
|
1501
1710
|
*/
|
|
1502
1711
|
metadata?: Record<string, string>;
|
|
1503
1712
|
/**
|
|
1713
|
+
* @public
|
|
1504
1714
|
* <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>.
|
|
1505
1715
|
* </p>
|
|
1506
1716
|
*/
|
|
@@ -1511,6 +1721,7 @@ export interface UpdateContentRequest {
|
|
|
1511
1721
|
*/
|
|
1512
1722
|
export interface UpdateContentResponse {
|
|
1513
1723
|
/**
|
|
1724
|
+
* @public
|
|
1514
1725
|
* <p>The content.</p>
|
|
1515
1726
|
*/
|
|
1516
1727
|
content?: ContentData;
|
|
@@ -1533,6 +1744,7 @@ export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof Knowledg
|
|
|
1533
1744
|
*/
|
|
1534
1745
|
export interface RenderingConfiguration {
|
|
1535
1746
|
/**
|
|
1747
|
+
* @public
|
|
1536
1748
|
* <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
|
|
1537
1749
|
* This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
|
|
1538
1750
|
* and Zendesk, the variable must be one of the following:</p>
|
|
@@ -1567,12 +1779,16 @@ export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | So
|
|
|
1567
1779
|
*/
|
|
1568
1780
|
export declare namespace SourceConfiguration {
|
|
1569
1781
|
/**
|
|
1782
|
+
* @public
|
|
1570
1783
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
1571
1784
|
*/
|
|
1572
1785
|
interface AppIntegrationsMember {
|
|
1573
1786
|
appIntegrations: AppIntegrationsConfiguration;
|
|
1574
1787
|
$unknown?: never;
|
|
1575
1788
|
}
|
|
1789
|
+
/**
|
|
1790
|
+
* @public
|
|
1791
|
+
*/
|
|
1576
1792
|
interface $UnknownMember {
|
|
1577
1793
|
appIntegrations?: never;
|
|
1578
1794
|
$unknown: [string, any];
|
|
@@ -1588,6 +1804,7 @@ export declare namespace SourceConfiguration {
|
|
|
1588
1804
|
*/
|
|
1589
1805
|
export interface CreateKnowledgeBaseRequest {
|
|
1590
1806
|
/**
|
|
1807
|
+
* @public
|
|
1591
1808
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1592
1809
|
* request. If not provided, the Amazon Web Services
|
|
1593
1810
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -1595,33 +1812,40 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
1595
1812
|
*/
|
|
1596
1813
|
clientToken?: string;
|
|
1597
1814
|
/**
|
|
1815
|
+
* @public
|
|
1598
1816
|
* <p>The name of the knowledge base.</p>
|
|
1599
1817
|
*/
|
|
1600
1818
|
name: string | undefined;
|
|
1601
1819
|
/**
|
|
1820
|
+
* @public
|
|
1602
1821
|
* <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.
|
|
1603
1822
|
* EXTERNAL knowledge bases support integrations with third-party systems whose content is
|
|
1604
1823
|
* synchronized automatically. </p>
|
|
1605
1824
|
*/
|
|
1606
1825
|
knowledgeBaseType: KnowledgeBaseType | string | undefined;
|
|
1607
1826
|
/**
|
|
1827
|
+
* @public
|
|
1608
1828
|
* <p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge
|
|
1609
1829
|
* bases.</p>
|
|
1610
1830
|
*/
|
|
1611
1831
|
sourceConfiguration?: SourceConfiguration;
|
|
1612
1832
|
/**
|
|
1833
|
+
* @public
|
|
1613
1834
|
* <p>Information about how to render the content.</p>
|
|
1614
1835
|
*/
|
|
1615
1836
|
renderingConfiguration?: RenderingConfiguration;
|
|
1616
1837
|
/**
|
|
1838
|
+
* @public
|
|
1617
1839
|
* <p>The KMS key used for encryption.</p>
|
|
1618
1840
|
*/
|
|
1619
1841
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1620
1842
|
/**
|
|
1843
|
+
* @public
|
|
1621
1844
|
* <p>The description.</p>
|
|
1622
1845
|
*/
|
|
1623
1846
|
description?: string;
|
|
1624
1847
|
/**
|
|
1848
|
+
* @public
|
|
1625
1849
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1626
1850
|
*/
|
|
1627
1851
|
tags?: Record<string, string>;
|
|
@@ -1648,47 +1872,58 @@ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof Know
|
|
|
1648
1872
|
*/
|
|
1649
1873
|
export interface KnowledgeBaseData {
|
|
1650
1874
|
/**
|
|
1875
|
+
* @public
|
|
1651
1876
|
* <p>The identifier of the knowledge base.</p>
|
|
1652
1877
|
*/
|
|
1653
1878
|
knowledgeBaseId: string | undefined;
|
|
1654
1879
|
/**
|
|
1880
|
+
* @public
|
|
1655
1881
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1656
1882
|
*/
|
|
1657
1883
|
knowledgeBaseArn: string | undefined;
|
|
1658
1884
|
/**
|
|
1885
|
+
* @public
|
|
1659
1886
|
* <p>The name of the knowledge base.</p>
|
|
1660
1887
|
*/
|
|
1661
1888
|
name: string | undefined;
|
|
1662
1889
|
/**
|
|
1890
|
+
* @public
|
|
1663
1891
|
* <p>The type of knowledge base.</p>
|
|
1664
1892
|
*/
|
|
1665
1893
|
knowledgeBaseType: KnowledgeBaseType | string | undefined;
|
|
1666
1894
|
/**
|
|
1895
|
+
* @public
|
|
1667
1896
|
* <p>The status of the knowledge base.</p>
|
|
1668
1897
|
*/
|
|
1669
1898
|
status: KnowledgeBaseStatus | string | undefined;
|
|
1670
1899
|
/**
|
|
1900
|
+
* @public
|
|
1671
1901
|
* <p>An epoch timestamp indicating the most recent content modification inside the knowledge
|
|
1672
1902
|
* base. If no content exists in a knowledge base, this value is unset.</p>
|
|
1673
1903
|
*/
|
|
1674
1904
|
lastContentModificationTime?: Date;
|
|
1675
1905
|
/**
|
|
1906
|
+
* @public
|
|
1676
1907
|
* <p>Source configuration information about the knowledge base.</p>
|
|
1677
1908
|
*/
|
|
1678
1909
|
sourceConfiguration?: SourceConfiguration;
|
|
1679
1910
|
/**
|
|
1911
|
+
* @public
|
|
1680
1912
|
* <p>Information about how to render the content.</p>
|
|
1681
1913
|
*/
|
|
1682
1914
|
renderingConfiguration?: RenderingConfiguration;
|
|
1683
1915
|
/**
|
|
1916
|
+
* @public
|
|
1684
1917
|
* <p>The KMS key used for encryption.</p>
|
|
1685
1918
|
*/
|
|
1686
1919
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1687
1920
|
/**
|
|
1921
|
+
* @public
|
|
1688
1922
|
* <p>The description.</p>
|
|
1689
1923
|
*/
|
|
1690
1924
|
description?: string;
|
|
1691
1925
|
/**
|
|
1926
|
+
* @public
|
|
1692
1927
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1693
1928
|
*/
|
|
1694
1929
|
tags?: Record<string, string>;
|
|
@@ -1698,6 +1933,7 @@ export interface KnowledgeBaseData {
|
|
|
1698
1933
|
*/
|
|
1699
1934
|
export interface CreateKnowledgeBaseResponse {
|
|
1700
1935
|
/**
|
|
1936
|
+
* @public
|
|
1701
1937
|
* <p>The knowledge base.</p>
|
|
1702
1938
|
*/
|
|
1703
1939
|
knowledgeBase?: KnowledgeBaseData;
|
|
@@ -1707,6 +1943,7 @@ export interface CreateKnowledgeBaseResponse {
|
|
|
1707
1943
|
*/
|
|
1708
1944
|
export interface DeleteKnowledgeBaseRequest {
|
|
1709
1945
|
/**
|
|
1946
|
+
* @public
|
|
1710
1947
|
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1711
1948
|
*/
|
|
1712
1949
|
knowledgeBaseId: string | undefined;
|
|
@@ -1721,6 +1958,7 @@ export interface DeleteKnowledgeBaseResponse {
|
|
|
1721
1958
|
*/
|
|
1722
1959
|
export interface GetKnowledgeBaseRequest {
|
|
1723
1960
|
/**
|
|
1961
|
+
* @public
|
|
1724
1962
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1725
1963
|
*/
|
|
1726
1964
|
knowledgeBaseId: string | undefined;
|
|
@@ -1730,6 +1968,7 @@ export interface GetKnowledgeBaseRequest {
|
|
|
1730
1968
|
*/
|
|
1731
1969
|
export interface GetKnowledgeBaseResponse {
|
|
1732
1970
|
/**
|
|
1971
|
+
* @public
|
|
1733
1972
|
* <p>The knowledge base.</p>
|
|
1734
1973
|
*/
|
|
1735
1974
|
knowledgeBase?: KnowledgeBaseData;
|
|
@@ -1739,11 +1978,13 @@ export interface GetKnowledgeBaseResponse {
|
|
|
1739
1978
|
*/
|
|
1740
1979
|
export interface ListKnowledgeBasesRequest {
|
|
1741
1980
|
/**
|
|
1981
|
+
* @public
|
|
1742
1982
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1743
1983
|
* response in the next request to retrieve the next set of results.</p>
|
|
1744
1984
|
*/
|
|
1745
1985
|
nextToken?: string;
|
|
1746
1986
|
/**
|
|
1987
|
+
* @public
|
|
1747
1988
|
* <p>The maximum number of results to return per page.</p>
|
|
1748
1989
|
*/
|
|
1749
1990
|
maxResults?: number;
|
|
@@ -1754,42 +1995,52 @@ export interface ListKnowledgeBasesRequest {
|
|
|
1754
1995
|
*/
|
|
1755
1996
|
export interface KnowledgeBaseSummary {
|
|
1756
1997
|
/**
|
|
1998
|
+
* @public
|
|
1757
1999
|
* <p>The identifier of the knowledge base.</p>
|
|
1758
2000
|
*/
|
|
1759
2001
|
knowledgeBaseId: string | undefined;
|
|
1760
2002
|
/**
|
|
2003
|
+
* @public
|
|
1761
2004
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1762
2005
|
*/
|
|
1763
2006
|
knowledgeBaseArn: string | undefined;
|
|
1764
2007
|
/**
|
|
2008
|
+
* @public
|
|
1765
2009
|
* <p>The name of the knowledge base.</p>
|
|
1766
2010
|
*/
|
|
1767
2011
|
name: string | undefined;
|
|
1768
2012
|
/**
|
|
2013
|
+
* @public
|
|
1769
2014
|
* <p>The type of knowledge base.</p>
|
|
1770
2015
|
*/
|
|
1771
2016
|
knowledgeBaseType: KnowledgeBaseType | string | undefined;
|
|
1772
2017
|
/**
|
|
2018
|
+
* @public
|
|
1773
2019
|
* <p>The status of the knowledge base summary.</p>
|
|
1774
2020
|
*/
|
|
1775
2021
|
status: KnowledgeBaseStatus | string | undefined;
|
|
1776
2022
|
/**
|
|
2023
|
+
* @public
|
|
1777
2024
|
* <p>Configuration information about the external data source.</p>
|
|
1778
2025
|
*/
|
|
1779
2026
|
sourceConfiguration?: SourceConfiguration;
|
|
1780
2027
|
/**
|
|
2028
|
+
* @public
|
|
1781
2029
|
* <p>Information about how to render the content.</p>
|
|
1782
2030
|
*/
|
|
1783
2031
|
renderingConfiguration?: RenderingConfiguration;
|
|
1784
2032
|
/**
|
|
2033
|
+
* @public
|
|
1785
2034
|
* <p>The KMS key used for encryption.</p>
|
|
1786
2035
|
*/
|
|
1787
2036
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1788
2037
|
/**
|
|
2038
|
+
* @public
|
|
1789
2039
|
* <p>The description of the knowledge base.</p>
|
|
1790
2040
|
*/
|
|
1791
2041
|
description?: string;
|
|
1792
2042
|
/**
|
|
2043
|
+
* @public
|
|
1793
2044
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1794
2045
|
*/
|
|
1795
2046
|
tags?: Record<string, string>;
|
|
@@ -1799,10 +2050,12 @@ export interface KnowledgeBaseSummary {
|
|
|
1799
2050
|
*/
|
|
1800
2051
|
export interface ListKnowledgeBasesResponse {
|
|
1801
2052
|
/**
|
|
2053
|
+
* @public
|
|
1802
2054
|
* <p>Information about the knowledge bases.</p>
|
|
1803
2055
|
*/
|
|
1804
2056
|
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
1805
2057
|
/**
|
|
2058
|
+
* @public
|
|
1806
2059
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1807
2060
|
*/
|
|
1808
2061
|
nextToken?: string;
|
|
@@ -1812,6 +2065,7 @@ export interface ListKnowledgeBasesResponse {
|
|
|
1812
2065
|
*/
|
|
1813
2066
|
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
1814
2067
|
/**
|
|
2068
|
+
* @public
|
|
1815
2069
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1816
2070
|
*/
|
|
1817
2071
|
knowledgeBaseId: string | undefined;
|
|
@@ -1826,19 +2080,23 @@ export interface RemoveKnowledgeBaseTemplateUriResponse {
|
|
|
1826
2080
|
*/
|
|
1827
2081
|
export interface SearchContentRequest {
|
|
1828
2082
|
/**
|
|
2083
|
+
* @public
|
|
1829
2084
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1830
2085
|
* response in the next request to retrieve the next set of results.</p>
|
|
1831
2086
|
*/
|
|
1832
2087
|
nextToken?: string;
|
|
1833
2088
|
/**
|
|
2089
|
+
* @public
|
|
1834
2090
|
* <p>The maximum number of results to return per page.</p>
|
|
1835
2091
|
*/
|
|
1836
2092
|
maxResults?: number;
|
|
1837
2093
|
/**
|
|
2094
|
+
* @public
|
|
1838
2095
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1839
2096
|
*/
|
|
1840
2097
|
knowledgeBaseId: string | undefined;
|
|
1841
2098
|
/**
|
|
2099
|
+
* @public
|
|
1842
2100
|
* <p>The search expression to filter results.</p>
|
|
1843
2101
|
*/
|
|
1844
2102
|
searchExpression: SearchExpression | undefined;
|
|
@@ -1848,10 +2106,12 @@ export interface SearchContentRequest {
|
|
|
1848
2106
|
*/
|
|
1849
2107
|
export interface SearchContentResponse {
|
|
1850
2108
|
/**
|
|
2109
|
+
* @public
|
|
1851
2110
|
* <p>Summary information about the content.</p>
|
|
1852
2111
|
*/
|
|
1853
2112
|
contentSummaries: ContentSummary[] | undefined;
|
|
1854
2113
|
/**
|
|
2114
|
+
* @public
|
|
1855
2115
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1856
2116
|
*/
|
|
1857
2117
|
nextToken?: string;
|
|
@@ -1861,10 +2121,12 @@ export interface SearchContentResponse {
|
|
|
1861
2121
|
*/
|
|
1862
2122
|
export interface StartContentUploadRequest {
|
|
1863
2123
|
/**
|
|
2124
|
+
* @public
|
|
1864
2125
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1865
2126
|
*/
|
|
1866
2127
|
knowledgeBaseId: string | undefined;
|
|
1867
2128
|
/**
|
|
2129
|
+
* @public
|
|
1868
2130
|
* <p>The type of content to upload.</p>
|
|
1869
2131
|
*/
|
|
1870
2132
|
contentType: string | undefined;
|
|
@@ -1874,18 +2136,22 @@ export interface StartContentUploadRequest {
|
|
|
1874
2136
|
*/
|
|
1875
2137
|
export interface StartContentUploadResponse {
|
|
1876
2138
|
/**
|
|
2139
|
+
* @public
|
|
1877
2140
|
* <p>The identifier of the upload.</p>
|
|
1878
2141
|
*/
|
|
1879
2142
|
uploadId: string | undefined;
|
|
1880
2143
|
/**
|
|
2144
|
+
* @public
|
|
1881
2145
|
* <p>The URL of the upload.</p>
|
|
1882
2146
|
*/
|
|
1883
2147
|
url: string | undefined;
|
|
1884
2148
|
/**
|
|
2149
|
+
* @public
|
|
1885
2150
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
1886
2151
|
*/
|
|
1887
2152
|
urlExpiry: Date | undefined;
|
|
1888
2153
|
/**
|
|
2154
|
+
* @public
|
|
1889
2155
|
* <p>The headers to include in the upload.</p>
|
|
1890
2156
|
*/
|
|
1891
2157
|
headersToInclude: Record<string, string> | undefined;
|
|
@@ -1895,10 +2161,12 @@ export interface StartContentUploadResponse {
|
|
|
1895
2161
|
*/
|
|
1896
2162
|
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
1897
2163
|
/**
|
|
2164
|
+
* @public
|
|
1898
2165
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1899
2166
|
*/
|
|
1900
2167
|
knowledgeBaseId: string | undefined;
|
|
1901
2168
|
/**
|
|
2169
|
+
* @public
|
|
1902
2170
|
* <p>The template URI to update.</p>
|
|
1903
2171
|
*/
|
|
1904
2172
|
templateUri: string | undefined;
|
|
@@ -1908,6 +2176,7 @@ export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
|
1908
2176
|
*/
|
|
1909
2177
|
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
1910
2178
|
/**
|
|
2179
|
+
* @public
|
|
1911
2180
|
* <p>The knowledge base to update.</p>
|
|
1912
2181
|
*/
|
|
1913
2182
|
knowledgeBase?: KnowledgeBaseData;
|
|
@@ -1917,6 +2186,7 @@ export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
|
1917
2186
|
*/
|
|
1918
2187
|
export interface ListTagsForResourceRequest {
|
|
1919
2188
|
/**
|
|
2189
|
+
* @public
|
|
1920
2190
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1921
2191
|
*/
|
|
1922
2192
|
resourceArn: string | undefined;
|
|
@@ -1926,6 +2196,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1926
2196
|
*/
|
|
1927
2197
|
export interface ListTagsForResourceResponse {
|
|
1928
2198
|
/**
|
|
2199
|
+
* @public
|
|
1929
2200
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1930
2201
|
*/
|
|
1931
2202
|
tags?: Record<string, string>;
|
|
@@ -1935,10 +2206,12 @@ export interface ListTagsForResourceResponse {
|
|
|
1935
2206
|
*/
|
|
1936
2207
|
export interface TagResourceRequest {
|
|
1937
2208
|
/**
|
|
2209
|
+
* @public
|
|
1938
2210
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1939
2211
|
*/
|
|
1940
2212
|
resourceArn: string | undefined;
|
|
1941
2213
|
/**
|
|
2214
|
+
* @public
|
|
1942
2215
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1943
2216
|
*/
|
|
1944
2217
|
tags: Record<string, string> | undefined;
|
|
@@ -1956,6 +2229,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1956
2229
|
readonly name: "TooManyTagsException";
|
|
1957
2230
|
readonly $fault: "client";
|
|
1958
2231
|
/**
|
|
2232
|
+
* @public
|
|
1959
2233
|
* <p>The specified resource name.</p>
|
|
1960
2234
|
*/
|
|
1961
2235
|
resourceName?: string;
|
|
@@ -1969,10 +2243,12 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
1969
2243
|
*/
|
|
1970
2244
|
export interface UntagResourceRequest {
|
|
1971
2245
|
/**
|
|
2246
|
+
* @public
|
|
1972
2247
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1973
2248
|
*/
|
|
1974
2249
|
resourceArn: string | undefined;
|
|
1975
2250
|
/**
|
|
2251
|
+
* @public
|
|
1976
2252
|
* <p>The tag keys.</p>
|
|
1977
2253
|
*/
|
|
1978
2254
|
tagKeys: string[] | undefined;
|