@aws-sdk/client-wisdom 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/dist-types/Wisdom.d.ts +34 -2
  2. package/dist-types/WisdomClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAssistantCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateContentCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateSessionCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteAssistantCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteContentCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +16 -0
  12. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +16 -0
  13. package/dist-types/commands/GetAssistantCommand.d.ts +16 -0
  14. package/dist-types/commands/GetContentCommand.d.ts +16 -0
  15. package/dist-types/commands/GetContentSummaryCommand.d.ts +16 -0
  16. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +16 -0
  17. package/dist-types/commands/GetRecommendationsCommand.d.ts +16 -0
  18. package/dist-types/commands/GetSessionCommand.d.ts +16 -0
  19. package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +16 -0
  20. package/dist-types/commands/ListAssistantsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListContentsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +16 -0
  25. package/dist-types/commands/QueryAssistantCommand.d.ts +16 -0
  26. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +16 -0
  27. package/dist-types/commands/SearchContentCommand.d.ts +16 -0
  28. package/dist-types/commands/SearchSessionsCommand.d.ts +16 -0
  29. package/dist-types/commands/StartContentUploadCommand.d.ts +16 -0
  30. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateContentCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +18 -2
  34. package/dist-types/models/WisdomServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +271 -1
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/dist-types/pagination/ListAssistantAssociationsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListAssistantsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListContentsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +3 -0
  41. package/dist-types/pagination/QueryAssistantPaginator.d.ts +3 -0
  42. package/dist-types/pagination/SearchContentPaginator.d.ts +3 -0
  43. package/dist-types/pagination/SearchSessionsPaginator.d.ts +3 -0
  44. package/package.json +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { WisdomServiceException as __BaseException } from "./WisdomServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,7 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
14
  }
14
15
  /**
16
+ * @public
15
17
  * <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
16
18
  */
17
19
  export interface AppIntegrationsConfiguration {
@@ -71,6 +73,7 @@ export interface AppIntegrationsConfiguration {
71
73
  objectFields?: string[];
72
74
  }
73
75
  /**
76
+ * @public
74
77
  * <p>The request could not be processed because of conflict in the current state of the
75
78
  * resource. For example, if you're using a <code>Create</code> API (such as
76
79
  * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
@@ -85,9 +88,13 @@ export declare class ConflictException extends __BaseException {
85
88
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
86
89
  }
87
90
  /**
91
+ * @public
88
92
  * <p>The data that is input into Wisdom as a result of the assistant association.</p>
89
93
  */
90
94
  export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
95
+ /**
96
+ * @public
97
+ */
91
98
  export declare namespace AssistantAssociationInputData {
92
99
  /**
93
100
  * <p>The identifier of the knowledge base.</p>
@@ -106,9 +113,15 @@ export declare namespace AssistantAssociationInputData {
106
113
  }
107
114
  const visit: <T>(value: AssistantAssociationInputData, visitor: Visitor<T>) => T;
108
115
  }
116
+ /**
117
+ * @public
118
+ */
109
119
  export declare enum AssociationType {
110
120
  KNOWLEDGE_BASE = "KNOWLEDGE_BASE"
111
121
  }
122
+ /**
123
+ * @public
124
+ */
112
125
  export interface CreateAssistantAssociationRequest {
113
126
  /**
114
127
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -135,6 +148,7 @@ export interface CreateAssistantAssociationRequest {
135
148
  tags?: Record<string, string>;
136
149
  }
137
150
  /**
151
+ * @public
138
152
  * <p>Association information about the knowledge base.</p>
139
153
  */
140
154
  export interface KnowledgeBaseAssociationData {
@@ -148,9 +162,13 @@ export interface KnowledgeBaseAssociationData {
148
162
  knowledgeBaseArn?: string;
149
163
  }
150
164
  /**
165
+ * @public
151
166
  * <p>The data that is output as a result of the assistant association.</p>
152
167
  */
153
168
  export type AssistantAssociationOutputData = AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
169
+ /**
170
+ * @public
171
+ */
154
172
  export declare namespace AssistantAssociationOutputData {
155
173
  /**
156
174
  * <p>The knowledge base where output data is sent.</p>
@@ -170,6 +188,7 @@ export declare namespace AssistantAssociationOutputData {
170
188
  const visit: <T>(value: AssistantAssociationOutputData, visitor: Visitor<T>) => T;
171
189
  }
172
190
  /**
191
+ * @public
173
192
  * <p>Information about the assistant association.</p>
174
193
  */
175
194
  export interface AssistantAssociationData {
@@ -202,6 +221,9 @@ export interface AssistantAssociationData {
202
221
  */
203
222
  tags?: Record<string, string>;
204
223
  }
224
+ /**
225
+ * @public
226
+ */
205
227
  export interface CreateAssistantAssociationResponse {
206
228
  /**
207
229
  * <p>The assistant association.</p>
@@ -209,6 +231,7 @@ export interface CreateAssistantAssociationResponse {
209
231
  assistantAssociation?: AssistantAssociationData;
210
232
  }
211
233
  /**
234
+ * @public
212
235
  * <p>The specified resource does not exist.</p>
213
236
  */
214
237
  export declare class ResourceNotFoundException extends __BaseException {
@@ -224,6 +247,7 @@ export declare class ResourceNotFoundException extends __BaseException {
224
247
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
225
248
  }
226
249
  /**
250
+ * @public
227
251
  * <p>You've exceeded your service quota. To perform the requested action, remove some of the
228
252
  * relevant resources, or use service quotas to request a service quota increase.</p>
229
253
  */
@@ -236,6 +260,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
236
260
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
237
261
  }
238
262
  /**
263
+ * @public
239
264
  * <p>The input fails to satisfy the constraints specified by a service.</p>
240
265
  */
241
266
  export declare class ValidationException extends __BaseException {
@@ -246,6 +271,9 @@ export declare class ValidationException extends __BaseException {
246
271
  */
247
272
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
248
273
  }
274
+ /**
275
+ * @public
276
+ */
249
277
  export interface DeleteAssistantAssociationRequest {
250
278
  /**
251
279
  * <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -256,8 +284,14 @@ export interface DeleteAssistantAssociationRequest {
256
284
  */
257
285
  assistantId: string | undefined;
258
286
  }
287
+ /**
288
+ * @public
289
+ */
259
290
  export interface DeleteAssistantAssociationResponse {
260
291
  }
292
+ /**
293
+ * @public
294
+ */
261
295
  export interface GetAssistantAssociationRequest {
262
296
  /**
263
297
  * <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -268,12 +302,18 @@ export interface GetAssistantAssociationRequest {
268
302
  */
269
303
  assistantId: string | undefined;
270
304
  }
305
+ /**
306
+ * @public
307
+ */
271
308
  export interface GetAssistantAssociationResponse {
272
309
  /**
273
310
  * <p>The assistant association.</p>
274
311
  */
275
312
  assistantAssociation?: AssistantAssociationData;
276
313
  }
314
+ /**
315
+ * @public
316
+ */
277
317
  export interface ListAssistantAssociationsRequest {
278
318
  /**
279
319
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -290,6 +330,7 @@ export interface ListAssistantAssociationsRequest {
290
330
  assistantId: string | undefined;
291
331
  }
292
332
  /**
333
+ * @public
293
334
  * <p>Summary information about the assistant association.</p>
294
335
  */
295
336
  export interface AssistantAssociationSummary {
@@ -322,6 +363,9 @@ export interface AssistantAssociationSummary {
322
363
  */
323
364
  tags?: Record<string, string>;
324
365
  }
366
+ /**
367
+ * @public
368
+ */
325
369
  export interface ListAssistantAssociationsResponse {
326
370
  /**
327
371
  * <p>Summary information about assistant associations.</p>
@@ -333,6 +377,7 @@ export interface ListAssistantAssociationsResponse {
333
377
  nextToken?: string;
334
378
  }
335
379
  /**
380
+ * @public
336
381
  * <p>The KMS key used for encryption.</p>
337
382
  */
338
383
  export interface ServerSideEncryptionConfiguration {
@@ -342,9 +387,15 @@ export interface ServerSideEncryptionConfiguration {
342
387
  */
343
388
  kmsKeyId?: string;
344
389
  }
390
+ /**
391
+ * @public
392
+ */
345
393
  export declare enum AssistantType {
346
394
  AGENT = "AGENT"
347
395
  }
396
+ /**
397
+ * @public
398
+ */
348
399
  export interface CreateAssistantRequest {
349
400
  /**
350
401
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
@@ -374,6 +425,9 @@ export interface CreateAssistantRequest {
374
425
  */
375
426
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
376
427
  }
428
+ /**
429
+ * @public
430
+ */
377
431
  export declare enum AssistantStatus {
378
432
  ACTIVE = "ACTIVE",
379
433
  CREATE_FAILED = "CREATE_FAILED",
@@ -383,6 +437,7 @@ export declare enum AssistantStatus {
383
437
  DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS"
384
438
  }
385
439
  /**
440
+ * @public
386
441
  * <p>The assistant data.</p>
387
442
  */
388
443
  export interface AssistantData {
@@ -419,32 +474,50 @@ export interface AssistantData {
419
474
  */
420
475
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
421
476
  }
477
+ /**
478
+ * @public
479
+ */
422
480
  export interface CreateAssistantResponse {
423
481
  /**
424
482
  * <p>Information about the assistant.</p>
425
483
  */
426
484
  assistant?: AssistantData;
427
485
  }
486
+ /**
487
+ * @public
488
+ */
428
489
  export interface DeleteAssistantRequest {
429
490
  /**
430
491
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
431
492
  */
432
493
  assistantId: string | undefined;
433
494
  }
495
+ /**
496
+ * @public
497
+ */
434
498
  export interface DeleteAssistantResponse {
435
499
  }
500
+ /**
501
+ * @public
502
+ */
436
503
  export interface GetAssistantRequest {
437
504
  /**
438
505
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
439
506
  */
440
507
  assistantId: string | undefined;
441
508
  }
509
+ /**
510
+ * @public
511
+ */
442
512
  export interface GetAssistantResponse {
443
513
  /**
444
514
  * <p>Information about the assistant.</p>
445
515
  */
446
516
  assistant?: AssistantData;
447
517
  }
518
+ /**
519
+ * @public
520
+ */
448
521
  export interface GetRecommendationsRequest {
449
522
  /**
450
523
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -467,6 +540,7 @@ export interface GetRecommendationsRequest {
467
540
  waitTimeSeconds?: number;
468
541
  }
469
542
  /**
543
+ * @public
470
544
  * <p>Reference information about the content.</p>
471
545
  */
472
546
  export interface ContentReference {
@@ -488,6 +562,7 @@ export interface ContentReference {
488
562
  contentId?: string;
489
563
  }
490
564
  /**
565
+ * @public
491
566
  * <p>Offset specification to describe highlighting of document excerpts for rendering search
492
567
  * results and recommendations.</p>
493
568
  */
@@ -502,6 +577,7 @@ export interface Highlight {
502
577
  endOffsetExclusive?: number;
503
578
  }
504
579
  /**
580
+ * @public
505
581
  * <p>The text of the document.</p>
506
582
  */
507
583
  export interface DocumentText {
@@ -515,6 +591,7 @@ export interface DocumentText {
515
591
  highlights?: Highlight[];
516
592
  }
517
593
  /**
594
+ * @public
518
595
  * <p>The document.</p>
519
596
  */
520
597
  export interface Document {
@@ -531,15 +608,22 @@ export interface Document {
531
608
  */
532
609
  excerpt?: DocumentText;
533
610
  }
611
+ /**
612
+ * @public
613
+ */
534
614
  export declare enum RelevanceLevel {
535
615
  HIGH = "HIGH",
536
616
  LOW = "LOW",
537
617
  MEDIUM = "MEDIUM"
538
618
  }
619
+ /**
620
+ * @public
621
+ */
539
622
  export declare enum RecommendationType {
540
623
  KNOWLEDGE_CONTENT = "KNOWLEDGE_CONTENT"
541
624
  }
542
625
  /**
626
+ * @public
543
627
  * <p>Information about the recommendation.</p>
544
628
  */
545
629
  export interface RecommendationData {
@@ -565,6 +649,7 @@ export interface RecommendationData {
565
649
  type?: RecommendationType | string;
566
650
  }
567
651
  /**
652
+ * @public
568
653
  * <p>Data associated with the QUERY RecommendationTriggerType.</p>
569
654
  */
570
655
  export interface QueryRecommendationTriggerData {
@@ -574,9 +659,13 @@ export interface QueryRecommendationTriggerData {
574
659
  text?: string;
575
660
  }
576
661
  /**
662
+ * @public
577
663
  * <p>A union type containing information related to the trigger.</p>
578
664
  */
579
665
  export type RecommendationTriggerData = RecommendationTriggerData.QueryMember | RecommendationTriggerData.$UnknownMember;
666
+ /**
667
+ * @public
668
+ */
580
669
  export declare namespace RecommendationTriggerData {
581
670
  /**
582
671
  * <p>Data associated with the QUERY RecommendationTriggerType.</p>
@@ -595,15 +684,22 @@ export declare namespace RecommendationTriggerData {
595
684
  }
596
685
  const visit: <T>(value: RecommendationTriggerData, visitor: Visitor<T>) => T;
597
686
  }
687
+ /**
688
+ * @public
689
+ */
598
690
  export declare enum RecommendationSourceType {
599
691
  ISSUE_DETECTION = "ISSUE_DETECTION",
600
692
  OTHER = "OTHER",
601
693
  RULE_EVALUATION = "RULE_EVALUATION"
602
694
  }
695
+ /**
696
+ * @public
697
+ */
603
698
  export declare enum RecommendationTriggerType {
604
699
  QUERY = "QUERY"
605
700
  }
606
701
  /**
702
+ * @public
607
703
  * <p>A recommendation trigger provides context on the event that produced the referenced
608
704
  * recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a
609
705
  * single RecommendationTrigger.</p>
@@ -640,6 +736,9 @@ export interface RecommendationTrigger {
640
736
  */
641
737
  recommendationIds: string[] | undefined;
642
738
  }
739
+ /**
740
+ * @public
741
+ */
643
742
  export interface GetRecommendationsResponse {
644
743
  /**
645
744
  * <p>The recommendations.</p>
@@ -650,6 +749,9 @@ export interface GetRecommendationsResponse {
650
749
  */
651
750
  triggers?: RecommendationTrigger[];
652
751
  }
752
+ /**
753
+ * @public
754
+ */
653
755
  export interface ListAssistantsRequest {
654
756
  /**
655
757
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -662,6 +764,7 @@ export interface ListAssistantsRequest {
662
764
  maxResults?: number;
663
765
  }
664
766
  /**
767
+ * @public
665
768
  * <p>Summary information about the assistant.</p>
666
769
  */
667
770
  export interface AssistantSummary {
@@ -698,6 +801,9 @@ export interface AssistantSummary {
698
801
  */
699
802
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
700
803
  }
804
+ /**
805
+ * @public
806
+ */
701
807
  export interface ListAssistantsResponse {
702
808
  /**
703
809
  * <p>Information about the assistants.</p>
@@ -708,6 +814,9 @@ export interface ListAssistantsResponse {
708
814
  */
709
815
  nextToken?: string;
710
816
  }
817
+ /**
818
+ * @public
819
+ */
711
820
  export interface NotifyRecommendationsReceivedRequest {
712
821
  /**
713
822
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -723,6 +832,7 @@ export interface NotifyRecommendationsReceivedRequest {
723
832
  recommendationIds: string[] | undefined;
724
833
  }
725
834
  /**
835
+ * @public
726
836
  * <p>An error occurred when creating a recommendation.</p>
727
837
  */
728
838
  export interface NotifyRecommendationsReceivedError {
@@ -735,6 +845,9 @@ export interface NotifyRecommendationsReceivedError {
735
845
  */
736
846
  message?: string;
737
847
  }
848
+ /**
849
+ * @public
850
+ */
738
851
  export interface NotifyRecommendationsReceivedResponse {
739
852
  /**
740
853
  * <p>The identifiers of the recommendations.</p>
@@ -745,6 +858,9 @@ export interface NotifyRecommendationsReceivedResponse {
745
858
  */
746
859
  errors?: NotifyRecommendationsReceivedError[];
747
860
  }
861
+ /**
862
+ * @public
863
+ */
748
864
  export interface QueryAssistantRequest {
749
865
  /**
750
866
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -765,6 +881,7 @@ export interface QueryAssistantRequest {
765
881
  maxResults?: number;
766
882
  }
767
883
  /**
884
+ * @public
768
885
  * <p>Information about the result.</p>
769
886
  */
770
887
  export interface ResultData {
@@ -781,6 +898,9 @@ export interface ResultData {
781
898
  */
782
899
  relevanceScore?: number;
783
900
  }
901
+ /**
902
+ * @public
903
+ */
784
904
  export interface QueryAssistantResponse {
785
905
  /**
786
906
  * <p>The results of the query.</p>
@@ -791,13 +911,20 @@ export interface QueryAssistantResponse {
791
911
  */
792
912
  nextToken?: string;
793
913
  }
914
+ /**
915
+ * @public
916
+ */
794
917
  export declare enum FilterField {
795
918
  NAME = "NAME"
796
919
  }
920
+ /**
921
+ * @public
922
+ */
797
923
  export declare enum FilterOperator {
798
924
  EQUALS = "EQUALS"
799
925
  }
800
926
  /**
927
+ * @public
801
928
  * <p>A search filter.</p>
802
929
  */
803
930
  export interface Filter {
@@ -815,6 +942,7 @@ export interface Filter {
815
942
  value: string | undefined;
816
943
  }
817
944
  /**
945
+ * @public
818
946
  * <p>The search expression.</p>
819
947
  */
820
948
  export interface SearchExpression {
@@ -823,6 +951,9 @@ export interface SearchExpression {
823
951
  */
824
952
  filters: Filter[] | undefined;
825
953
  }
954
+ /**
955
+ * @public
956
+ */
826
957
  export interface SearchSessionsRequest {
827
958
  /**
828
959
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -843,6 +974,7 @@ export interface SearchSessionsRequest {
843
974
  searchExpression: SearchExpression | undefined;
844
975
  }
845
976
  /**
977
+ * @public
846
978
  * <p>Summary information about the session.</p>
847
979
  */
848
980
  export interface SessionSummary {
@@ -863,6 +995,9 @@ export interface SessionSummary {
863
995
  */
864
996
  assistantArn: string | undefined;
865
997
  }
998
+ /**
999
+ * @public
1000
+ */
866
1001
  export interface SearchSessionsResponse {
867
1002
  /**
868
1003
  * <p>Summary information about the sessions.</p>
@@ -873,6 +1008,9 @@ export interface SearchSessionsResponse {
873
1008
  */
874
1009
  nextToken?: string;
875
1010
  }
1011
+ /**
1012
+ * @public
1013
+ */
876
1014
  export interface CreateSessionRequest {
877
1015
  /**
878
1016
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
@@ -899,6 +1037,7 @@ export interface CreateSessionRequest {
899
1037
  tags?: Record<string, string>;
900
1038
  }
901
1039
  /**
1040
+ * @public
902
1041
  * <p>Information about the session.</p>
903
1042
  */
904
1043
  export interface SessionData {
@@ -923,12 +1062,18 @@ export interface SessionData {
923
1062
  */
924
1063
  tags?: Record<string, string>;
925
1064
  }
1065
+ /**
1066
+ * @public
1067
+ */
926
1068
  export interface CreateSessionResponse {
927
1069
  /**
928
1070
  * <p>The session.</p>
929
1071
  */
930
1072
  session?: SessionData;
931
1073
  }
1074
+ /**
1075
+ * @public
1076
+ */
932
1077
  export interface GetSessionRequest {
933
1078
  /**
934
1079
  * <p>The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -939,12 +1084,18 @@ export interface GetSessionRequest {
939
1084
  */
940
1085
  sessionId: string | undefined;
941
1086
  }
1087
+ /**
1088
+ * @public
1089
+ */
942
1090
  export interface GetSessionResponse {
943
1091
  /**
944
1092
  * <p>The session.</p>
945
1093
  */
946
1094
  session?: SessionData;
947
1095
  }
1096
+ /**
1097
+ * @public
1098
+ */
948
1099
  export interface CreateContentRequest {
949
1100
  /**
950
1101
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -986,6 +1137,9 @@ export interface CreateContentRequest {
986
1137
  */
987
1138
  tags?: Record<string, string>;
988
1139
  }
1140
+ /**
1141
+ * @public
1142
+ */
989
1143
  export declare enum ContentStatus {
990
1144
  ACTIVE = "ACTIVE",
991
1145
  CREATE_FAILED = "CREATE_FAILED",
@@ -996,6 +1150,7 @@ export declare enum ContentStatus {
996
1150
  UPDATE_FAILED = "UPDATE_FAILED"
997
1151
  }
998
1152
  /**
1153
+ * @public
999
1154
  * <p>Information about the content.</p>
1000
1155
  */
1001
1156
  export interface ContentData {
@@ -1057,12 +1212,18 @@ export interface ContentData {
1057
1212
  */
1058
1213
  urlExpiry: Date | undefined;
1059
1214
  }
1215
+ /**
1216
+ * @public
1217
+ */
1060
1218
  export interface CreateContentResponse {
1061
1219
  /**
1062
1220
  * <p>The content.</p>
1063
1221
  */
1064
1222
  content?: ContentData;
1065
1223
  }
1224
+ /**
1225
+ * @public
1226
+ */
1066
1227
  export interface DeleteContentRequest {
1067
1228
  /**
1068
1229
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -1073,8 +1234,14 @@ export interface DeleteContentRequest {
1073
1234
  */
1074
1235
  contentId: string | undefined;
1075
1236
  }
1237
+ /**
1238
+ * @public
1239
+ */
1076
1240
  export interface DeleteContentResponse {
1077
1241
  }
1242
+ /**
1243
+ * @public
1244
+ */
1078
1245
  export interface GetContentRequest {
1079
1246
  /**
1080
1247
  * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -1085,12 +1252,18 @@ export interface GetContentRequest {
1085
1252
  */
1086
1253
  knowledgeBaseId: string | undefined;
1087
1254
  }
1255
+ /**
1256
+ * @public
1257
+ */
1088
1258
  export interface GetContentResponse {
1089
1259
  /**
1090
1260
  * <p>The content.</p>
1091
1261
  */
1092
1262
  content?: ContentData;
1093
1263
  }
1264
+ /**
1265
+ * @public
1266
+ */
1094
1267
  export interface GetContentSummaryRequest {
1095
1268
  /**
1096
1269
  * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -1102,6 +1275,7 @@ export interface GetContentSummaryRequest {
1102
1275
  knowledgeBaseId: string | undefined;
1103
1276
  }
1104
1277
  /**
1278
+ * @public
1105
1279
  * <p>Summary information about the content.</p>
1106
1280
  */
1107
1281
  export interface ContentSummary {
@@ -1151,12 +1325,18 @@ export interface ContentSummary {
1151
1325
  */
1152
1326
  tags?: Record<string, string>;
1153
1327
  }
1328
+ /**
1329
+ * @public
1330
+ */
1154
1331
  export interface GetContentSummaryResponse {
1155
1332
  /**
1156
1333
  * <p>The content summary.</p>
1157
1334
  */
1158
1335
  contentSummary?: ContentSummary;
1159
1336
  }
1337
+ /**
1338
+ * @public
1339
+ */
1160
1340
  export interface ListContentsRequest {
1161
1341
  /**
1162
1342
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -1172,6 +1352,9 @@ export interface ListContentsRequest {
1172
1352
  */
1173
1353
  knowledgeBaseId: string | undefined;
1174
1354
  }
1355
+ /**
1356
+ * @public
1357
+ */
1175
1358
  export interface ListContentsResponse {
1176
1359
  /**
1177
1360
  * <p>Information about the content.</p>
@@ -1183,6 +1366,7 @@ export interface ListContentsResponse {
1183
1366
  nextToken?: string;
1184
1367
  }
1185
1368
  /**
1369
+ * @public
1186
1370
  * <p>The provided <code>revisionId</code> does not match, indicating the content has been
1187
1371
  * modified since it was last read.</p>
1188
1372
  */
@@ -1194,6 +1378,9 @@ export declare class PreconditionFailedException extends __BaseException {
1194
1378
  */
1195
1379
  constructor(opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>);
1196
1380
  }
1381
+ /**
1382
+ * @public
1383
+ */
1197
1384
  export interface UpdateContentRequest {
1198
1385
  /**
1199
1386
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN</p>
@@ -1237,22 +1424,29 @@ export interface UpdateContentRequest {
1237
1424
  */
1238
1425
  uploadId?: string;
1239
1426
  }
1427
+ /**
1428
+ * @public
1429
+ */
1240
1430
  export interface UpdateContentResponse {
1241
1431
  /**
1242
1432
  * <p>The content.</p>
1243
1433
  */
1244
1434
  content?: ContentData;
1245
1435
  }
1436
+ /**
1437
+ * @public
1438
+ */
1246
1439
  export declare enum KnowledgeBaseType {
1247
1440
  CUSTOM = "CUSTOM",
1248
1441
  EXTERNAL = "EXTERNAL"
1249
1442
  }
1250
1443
  /**
1444
+ * @public
1251
1445
  * <p>Information about how to render the content.</p>
1252
1446
  */
1253
1447
  export interface RenderingConfiguration {
1254
1448
  /**
1255
- * <p>A URI template containing exactly one variable in <code>${variableName} </code>format.
1449
+ * <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
1256
1450
  * This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
1257
1451
  * and Zendesk, the variable must be one of the following:</p>
1258
1452
  * <ul>
@@ -1277,9 +1471,13 @@ export interface RenderingConfiguration {
1277
1471
  templateUri?: string;
1278
1472
  }
1279
1473
  /**
1474
+ * @public
1280
1475
  * <p>Configuration information about the external data source.</p>
1281
1476
  */
1282
1477
  export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.$UnknownMember;
1478
+ /**
1479
+ * @public
1480
+ */
1283
1481
  export declare namespace SourceConfiguration {
1284
1482
  /**
1285
1483
  * <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
@@ -1298,6 +1496,9 @@ export declare namespace SourceConfiguration {
1298
1496
  }
1299
1497
  const visit: <T>(value: SourceConfiguration, visitor: Visitor<T>) => T;
1300
1498
  }
1499
+ /**
1500
+ * @public
1501
+ */
1301
1502
  export interface CreateKnowledgeBaseRequest {
1302
1503
  /**
1303
1504
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
@@ -1338,6 +1539,9 @@ export interface CreateKnowledgeBaseRequest {
1338
1539
  */
1339
1540
  tags?: Record<string, string>;
1340
1541
  }
1542
+ /**
1543
+ * @public
1544
+ */
1341
1545
  export declare enum KnowledgeBaseStatus {
1342
1546
  ACTIVE = "ACTIVE",
1343
1547
  CREATE_FAILED = "CREATE_FAILED",
@@ -1347,6 +1551,7 @@ export declare enum KnowledgeBaseStatus {
1347
1551
  DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS"
1348
1552
  }
1349
1553
  /**
1554
+ * @public
1350
1555
  * <p>Information about the knowledge base.</p>
1351
1556
  */
1352
1557
  export interface KnowledgeBaseData {
@@ -1396,32 +1601,50 @@ export interface KnowledgeBaseData {
1396
1601
  */
1397
1602
  tags?: Record<string, string>;
1398
1603
  }
1604
+ /**
1605
+ * @public
1606
+ */
1399
1607
  export interface CreateKnowledgeBaseResponse {
1400
1608
  /**
1401
1609
  * <p>The knowledge base.</p>
1402
1610
  */
1403
1611
  knowledgeBase?: KnowledgeBaseData;
1404
1612
  }
1613
+ /**
1614
+ * @public
1615
+ */
1405
1616
  export interface DeleteKnowledgeBaseRequest {
1406
1617
  /**
1407
1618
  * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1408
1619
  */
1409
1620
  knowledgeBaseId: string | undefined;
1410
1621
  }
1622
+ /**
1623
+ * @public
1624
+ */
1411
1625
  export interface DeleteKnowledgeBaseResponse {
1412
1626
  }
1627
+ /**
1628
+ * @public
1629
+ */
1413
1630
  export interface GetKnowledgeBaseRequest {
1414
1631
  /**
1415
1632
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1416
1633
  */
1417
1634
  knowledgeBaseId: string | undefined;
1418
1635
  }
1636
+ /**
1637
+ * @public
1638
+ */
1419
1639
  export interface GetKnowledgeBaseResponse {
1420
1640
  /**
1421
1641
  * <p>The knowledge base.</p>
1422
1642
  */
1423
1643
  knowledgeBase?: KnowledgeBaseData;
1424
1644
  }
1645
+ /**
1646
+ * @public
1647
+ */
1425
1648
  export interface ListKnowledgeBasesRequest {
1426
1649
  /**
1427
1650
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -1434,6 +1657,7 @@ export interface ListKnowledgeBasesRequest {
1434
1657
  maxResults?: number;
1435
1658
  }
1436
1659
  /**
1660
+ * @public
1437
1661
  * <p>Summary information about the knowledge base.</p>
1438
1662
  */
1439
1663
  export interface KnowledgeBaseSummary {
@@ -1478,6 +1702,9 @@ export interface KnowledgeBaseSummary {
1478
1702
  */
1479
1703
  tags?: Record<string, string>;
1480
1704
  }
1705
+ /**
1706
+ * @public
1707
+ */
1481
1708
  export interface ListKnowledgeBasesResponse {
1482
1709
  /**
1483
1710
  * <p>Information about the knowledge bases.</p>
@@ -1488,14 +1715,23 @@ export interface ListKnowledgeBasesResponse {
1488
1715
  */
1489
1716
  nextToken?: string;
1490
1717
  }
1718
+ /**
1719
+ * @public
1720
+ */
1491
1721
  export interface RemoveKnowledgeBaseTemplateUriRequest {
1492
1722
  /**
1493
1723
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1494
1724
  */
1495
1725
  knowledgeBaseId: string | undefined;
1496
1726
  }
1727
+ /**
1728
+ * @public
1729
+ */
1497
1730
  export interface RemoveKnowledgeBaseTemplateUriResponse {
1498
1731
  }
1732
+ /**
1733
+ * @public
1734
+ */
1499
1735
  export interface SearchContentRequest {
1500
1736
  /**
1501
1737
  * <p>The token for the next set of results. Use the value returned in the previous
@@ -1515,6 +1751,9 @@ export interface SearchContentRequest {
1515
1751
  */
1516
1752
  searchExpression: SearchExpression | undefined;
1517
1753
  }
1754
+ /**
1755
+ * @public
1756
+ */
1518
1757
  export interface SearchContentResponse {
1519
1758
  /**
1520
1759
  * <p>Summary information about the content.</p>
@@ -1525,6 +1764,9 @@ export interface SearchContentResponse {
1525
1764
  */
1526
1765
  nextToken?: string;
1527
1766
  }
1767
+ /**
1768
+ * @public
1769
+ */
1528
1770
  export interface StartContentUploadRequest {
1529
1771
  /**
1530
1772
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -1535,6 +1777,9 @@ export interface StartContentUploadRequest {
1535
1777
  */
1536
1778
  contentType: string | undefined;
1537
1779
  }
1780
+ /**
1781
+ * @public
1782
+ */
1538
1783
  export interface StartContentUploadResponse {
1539
1784
  /**
1540
1785
  * <p>The identifier of the upload.</p>
@@ -1553,6 +1798,9 @@ export interface StartContentUploadResponse {
1553
1798
  */
1554
1799
  headersToInclude: Record<string, string> | undefined;
1555
1800
  }
1801
+ /**
1802
+ * @public
1803
+ */
1556
1804
  export interface UpdateKnowledgeBaseTemplateUriRequest {
1557
1805
  /**
1558
1806
  * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
@@ -1563,24 +1811,36 @@ export interface UpdateKnowledgeBaseTemplateUriRequest {
1563
1811
  */
1564
1812
  templateUri: string | undefined;
1565
1813
  }
1814
+ /**
1815
+ * @public
1816
+ */
1566
1817
  export interface UpdateKnowledgeBaseTemplateUriResponse {
1567
1818
  /**
1568
1819
  * <p>The knowledge base to update.</p>
1569
1820
  */
1570
1821
  knowledgeBase?: KnowledgeBaseData;
1571
1822
  }
1823
+ /**
1824
+ * @public
1825
+ */
1572
1826
  export interface ListTagsForResourceRequest {
1573
1827
  /**
1574
1828
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
1575
1829
  */
1576
1830
  resourceArn: string | undefined;
1577
1831
  }
1832
+ /**
1833
+ * @public
1834
+ */
1578
1835
  export interface ListTagsForResourceResponse {
1579
1836
  /**
1580
1837
  * <p>The tags used to organize, track, or control access for this resource.</p>
1581
1838
  */
1582
1839
  tags?: Record<string, string>;
1583
1840
  }
1841
+ /**
1842
+ * @public
1843
+ */
1584
1844
  export interface TagResourceRequest {
1585
1845
  /**
1586
1846
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
@@ -1591,9 +1851,13 @@ export interface TagResourceRequest {
1591
1851
  */
1592
1852
  tags: Record<string, string> | undefined;
1593
1853
  }
1854
+ /**
1855
+ * @public
1856
+ */
1594
1857
  export interface TagResourceResponse {
1595
1858
  }
1596
1859
  /**
1860
+ * @public
1597
1861
  * <p>Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.</p>
1598
1862
  */
1599
1863
  export declare class TooManyTagsException extends __BaseException {
@@ -1608,6 +1872,9 @@ export declare class TooManyTagsException extends __BaseException {
1608
1872
  */
1609
1873
  constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
1610
1874
  }
1875
+ /**
1876
+ * @public
1877
+ */
1611
1878
  export interface UntagResourceRequest {
1612
1879
  /**
1613
1880
  * <p>The Amazon Resource Name (ARN) of the resource.</p>
@@ -1618,6 +1885,9 @@ export interface UntagResourceRequest {
1618
1885
  */
1619
1886
  tagKeys: string[] | undefined;
1620
1887
  }
1888
+ /**
1889
+ * @public
1890
+ */
1621
1891
  export interface UntagResourceResponse {
1622
1892
  }
1623
1893
  /**