/
docs-2.json
1121 lines (1121 loc) · 56.3 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use the Amazon Connect Wisdom APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.</p>",
"operations": {
"CreateAssistant": "<p>Creates an Amazon Connect Wisdom assistant.</p>",
"CreateAssistantAssociation": "<p>Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.</p>",
"CreateContent": "<p>Creates Wisdom content. Before to calling this API, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html\">StartContentUpload</a> to upload an asset.</p>",
"CreateKnowledgeBase": "<p>Creates a knowledge base.</p> <note> <p>When using this API, you cannot reuse <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html\">Amazon AppIntegrations</a> DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an <code>InvalidRequestException</code> error. </p> <pre><code> <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note> </code></pre>",
"CreateSession": "<p>Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.</p>",
"DeleteAssistant": "<p>Deletes an assistant.</p>",
"DeleteAssistantAssociation": "<p>Deletes an assistant association.</p>",
"DeleteContent": "<p>Deletes the content.</p>",
"DeleteKnowledgeBase": "<p>Deletes the knowledge base.</p> <note> <p>When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html\">Amazon AppIntegrations</a> DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html\">DeleteDataIntegration</a> and <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html\">CreateDataIntegration</a> in the <i>Amazon AppIntegrations API Reference</i>.</p> </note>",
"GetAssistant": "<p>Retrieves information about an assistant.</p>",
"GetAssistantAssociation": "<p>Retrieves information about an assistant association.</p>",
"GetContent": "<p>Retrieves content, including a pre-signed URL to download the content.</p>",
"GetContentSummary": "<p>Retrieves summary information about the content.</p>",
"GetKnowledgeBase": "<p>Retrieves information about the knowledge base.</p>",
"GetRecommendations": "<p>Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html\">NotifyRecommendationsReceived</a>. This API supports long-polling behavior with the <code>waitTimeSeconds</code> parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html\">QueryAssistant</a>.</p>",
"GetSession": "<p>Retrieves information for a specified session.</p>",
"ListAssistantAssociations": "<p>Lists information about assistant associations.</p>",
"ListAssistants": "<p>Lists information about assistants.</p>",
"ListContents": "<p>Lists the content.</p>",
"ListKnowledgeBases": "<p>Lists the knowledge bases.</p>",
"ListTagsForResource": "<p>Lists the tags for the specified resource.</p>",
"NotifyRecommendationsReceived": "<p>Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling behavior and avoiding duplicate recommendations.</p>",
"PutFeedback": "<p>Submits feedback to Wisdom. The feedback is used to improve future recommendations from <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a> or results from <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html\">QueryAssistant</a>. Feedback can be resubmitted up to 6 hours after submission. </p>",
"QueryAssistant": "<p>Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a>. </p>",
"RemoveKnowledgeBaseTemplateUri": "<p>Removes a URI template from a knowledge base.</p>",
"SearchContent": "<p>Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.</p>",
"SearchSessions": "<p>Searches for sessions.</p>",
"StartContentUpload": "<p>Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html\">CreateContent</a> to finalize the content creation process or <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html\">UpdateContent</a> to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.</p>",
"TagResource": "<p>Adds the specified tags to the specified resource.</p>",
"UntagResource": "<p>Removes the specified tags from the specified resource.</p>",
"UpdateContent": "<p>Updates information about the content.</p>",
"UpdateKnowledgeBaseTemplateUri": "<p>Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in <code>${variable}</code> format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an <code>Id</code> value, and you can set the template URI to <code>https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view</code>. </p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You do not have sufficient access to perform this action.</p>",
"refs": {
}
},
"AppIntegrationsConfiguration": {
"base": "<p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>",
"refs": {
"SourceConfiguration$appIntegrations": "<p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"AssistantAssociationData$assistantArn": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
"AssistantAssociationData$assistantAssociationArn": "<p>The Amazon Resource Name (ARN) of the assistant association.</p>",
"AssistantAssociationSummary$assistantArn": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
"AssistantAssociationSummary$assistantAssociationArn": "<p>The Amazon Resource Name (ARN) of the assistant association.</p>",
"AssistantData$assistantArn": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
"AssistantSummary$assistantArn": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
"ContentData$contentArn": "<p>The Amazon Resource Name (ARN) of the content.</p>",
"ContentData$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"ContentReference$contentArn": "<p>The Amazon Resource Name (ARN) of the content.</p>",
"ContentReference$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"ContentSummary$contentArn": "<p>The Amazon Resource Name (ARN) of the content.</p>",
"ContentSummary$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"KnowledgeBaseAssociationData$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"KnowledgeBaseData$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"KnowledgeBaseSummary$knowledgeBaseArn": "<p>The Amazon Resource Name (ARN) of the knowledge base.</p>",
"ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"SessionData$sessionArn": "<p>The Amazon Resource Name (ARN) of the session.</p>",
"SessionSummary$assistantArn": "<p>The Amazon Resource Name (ARN) of the Wisdom assistant.</p>",
"SessionSummary$sessionArn": "<p>The Amazon Resource Name (ARN) of the session.</p>",
"TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
},
"AssistantAssociationData": {
"base": "<p>Information about the assistant association.</p>",
"refs": {
"CreateAssistantAssociationResponse$assistantAssociation": "<p>The assistant association.</p>",
"GetAssistantAssociationResponse$assistantAssociation": "<p>The assistant association.</p>"
}
},
"AssistantAssociationInputData": {
"base": "<p>The data that is input into Wisdom as a result of the assistant association.</p>",
"refs": {
"CreateAssistantAssociationRequest$association": "<p>The identifier of the associated resource.</p>"
}
},
"AssistantAssociationOutputData": {
"base": "<p>The data that is output as a result of the assistant association.</p>",
"refs": {
"AssistantAssociationData$associationData": "<p>A union type that currently has a single argument, the knowledge base ID.</p>",
"AssistantAssociationSummary$associationData": "<p>The association data.</p>"
}
},
"AssistantAssociationSummary": {
"base": "<p>Summary information about the assistant association.</p>",
"refs": {
"AssistantAssociationSummaryList$member": null
}
},
"AssistantAssociationSummaryList": {
"base": null,
"refs": {
"ListAssistantAssociationsResponse$assistantAssociationSummaries": "<p>Summary information about assistant associations.</p>"
}
},
"AssistantData": {
"base": "<p>The assistant data.</p>",
"refs": {
"CreateAssistantResponse$assistant": "<p>Information about the assistant.</p>",
"GetAssistantResponse$assistant": "<p>Information about the assistant.</p>"
}
},
"AssistantList": {
"base": null,
"refs": {
"ListAssistantsResponse$assistantSummaries": "<p>Information about the assistants.</p>"
}
},
"AssistantStatus": {
"base": null,
"refs": {
"AssistantData$status": "<p>The status of the assistant.</p>",
"AssistantSummary$status": "<p>The status of the assistant.</p>"
}
},
"AssistantSummary": {
"base": "<p>Summary information about the assistant.</p>",
"refs": {
"AssistantList$member": null
}
},
"AssistantType": {
"base": null,
"refs": {
"AssistantData$type": "<p>The type of assistant.</p>",
"AssistantSummary$type": "<p>The type of the assistant.</p>",
"CreateAssistantRequest$type": "<p>The type of assistant.</p>"
}
},
"AssociationType": {
"base": null,
"refs": {
"AssistantAssociationData$associationType": "<p>The type of association.</p>",
"AssistantAssociationSummary$associationType": "<p>The type of association.</p>",
"CreateAssistantAssociationRequest$associationType": "<p>The type of association.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"UpdateContentRequest$removeOverrideLinkOutUri": "<p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>"
}
},
"ClientToken": {
"base": null,
"refs": {
"CreateAssistantAssociationRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateAssistantRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateSessionRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
},
"ConflictException": {
"base": "<p>The request could not be processed because of conflict in the current state of the resource. For example, if you're using a <code>Create</code> API (such as <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.</p>",
"refs": {
}
},
"ContentData": {
"base": "<p>Information about the content.</p>",
"refs": {
"CreateContentResponse$content": "<p>The content.</p>",
"GetContentResponse$content": "<p>The content.</p>",
"UpdateContentResponse$content": "<p>The content.</p>"
}
},
"ContentMetadata": {
"base": null,
"refs": {
"ContentData$metadata": "<p>A key/value map to store attributes without affecting tagging or recommendations. 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>",
"ContentSummary$metadata": "<p>A key/value map to store attributes without affecting tagging or recommendations. 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>",
"CreateContentRequest$metadata": "<p>A key/value map to store attributes without affecting tagging or recommendations. 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>",
"UpdateContentRequest$metadata": "<p>A key/value map to store attributes without affecting tagging or recommendations. 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>"
}
},
"ContentReference": {
"base": "<p>Reference information about the content.</p>",
"refs": {
"Document$contentReference": "<p>A reference to the content resource.</p>"
}
},
"ContentStatus": {
"base": null,
"refs": {
"ContentData$status": "<p>The status of the content.</p>",
"ContentSummary$status": "<p>The status of the content.</p>"
}
},
"ContentSummary": {
"base": "<p>Summary information about the content.</p>",
"refs": {
"ContentSummaryList$member": null,
"GetContentSummaryResponse$contentSummary": "<p>The content summary.</p>"
}
},
"ContentSummaryList": {
"base": null,
"refs": {
"ListContentsResponse$contentSummaries": "<p>Information about the content.</p>",
"SearchContentResponse$contentSummaries": "<p>Summary information about the content.</p>"
}
},
"ContentTitle": {
"base": null,
"refs": {
"ContentData$title": "<p>The title of the content.</p>",
"ContentSummary$title": "<p>The title of the content.</p>",
"CreateContentRequest$title": "<p>The title of the content. If not set, the title is equal to the name.</p>",
"UpdateContentRequest$title": "<p>The title of the content.</p>"
}
},
"ContentType": {
"base": null,
"refs": {
"ContentData$contentType": "<p>The media type of the content.</p>",
"ContentSummary$contentType": "<p>The media type of the content.</p>",
"StartContentUploadRequest$contentType": "<p>The type of content to upload.</p>"
}
},
"CreateAssistantAssociationRequest": {
"base": null,
"refs": {
}
},
"CreateAssistantAssociationResponse": {
"base": null,
"refs": {
}
},
"CreateAssistantRequest": {
"base": null,
"refs": {
}
},
"CreateAssistantResponse": {
"base": null,
"refs": {
}
},
"CreateContentRequest": {
"base": null,
"refs": {
}
},
"CreateContentResponse": {
"base": null,
"refs": {
}
},
"CreateKnowledgeBaseRequest": {
"base": null,
"refs": {
}
},
"CreateKnowledgeBaseResponse": {
"base": null,
"refs": {
}
},
"CreateSessionRequest": {
"base": null,
"refs": {
}
},
"CreateSessionResponse": {
"base": null,
"refs": {
}
},
"DeleteAssistantAssociationRequest": {
"base": null,
"refs": {
}
},
"DeleteAssistantAssociationResponse": {
"base": null,
"refs": {
}
},
"DeleteAssistantRequest": {
"base": null,
"refs": {
}
},
"DeleteAssistantResponse": {
"base": null,
"refs": {
}
},
"DeleteContentRequest": {
"base": null,
"refs": {
}
},
"DeleteContentResponse": {
"base": null,
"refs": {
}
},
"DeleteKnowledgeBaseRequest": {
"base": null,
"refs": {
}
},
"DeleteKnowledgeBaseResponse": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"AssistantData$description": "<p>The description.</p>",
"AssistantSummary$description": "<p>The description of the assistant.</p>",
"CreateAssistantRequest$description": "<p>The description of the assistant.</p>",
"CreateKnowledgeBaseRequest$description": "<p>The description.</p>",
"CreateSessionRequest$description": "<p>The description.</p>",
"KnowledgeBaseData$description": "<p>The description.</p>",
"KnowledgeBaseSummary$description": "<p>The description of the knowledge base.</p>",
"SessionData$description": "<p>The description of the session.</p>"
}
},
"Document": {
"base": "<p>The document.</p>",
"refs": {
"RecommendationData$document": "<p>The recommended document.</p>",
"ResultData$document": "<p>The document.</p>"
}
},
"DocumentText": {
"base": "<p>The text of the document.</p>",
"refs": {
"Document$excerpt": "<p>The excerpt from the document.</p>",
"Document$title": "<p>The title of the document.</p>"
}
},
"FeedbackData": {
"base": "<p>The feedback to submit to Wisdom.</p>",
"refs": {
"PutFeedbackRequest$feedback": "<p>The feedback.</p>",
"PutFeedbackResponse$feedback": "<p>The feedback.</p>"
}
},
"Filter": {
"base": "<p>A search filter.</p>",
"refs": {
"FilterList$member": null
}
},
"FilterField": {
"base": null,
"refs": {
"Filter$field": "<p>The field on which to filter.</p>"
}
},
"FilterList": {
"base": null,
"refs": {
"SearchExpression$filters": "<p>The search expression filters.</p>"
}
},
"FilterOperator": {
"base": null,
"refs": {
"Filter$operator": "<p>The operator to use for comparing the field’s value with the provided value.</p>"
}
},
"GenericArn": {
"base": null,
"refs": {
"AppIntegrationsConfiguration$appIntegrationArn": "<p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>"
}
},
"GetAssistantAssociationRequest": {
"base": null,
"refs": {
}
},
"GetAssistantAssociationResponse": {
"base": null,
"refs": {
}
},
"GetAssistantRequest": {
"base": null,
"refs": {
}
},
"GetAssistantResponse": {
"base": null,
"refs": {
}
},
"GetContentRequest": {
"base": null,
"refs": {
}
},
"GetContentResponse": {
"base": null,
"refs": {
}
},
"GetContentSummaryRequest": {
"base": null,
"refs": {
}
},
"GetContentSummaryResponse": {
"base": null,
"refs": {
}
},
"GetKnowledgeBaseRequest": {
"base": null,
"refs": {
}
},
"GetKnowledgeBaseResponse": {
"base": null,
"refs": {
}
},
"GetRecommendationsRequest": {
"base": null,
"refs": {
}
},
"GetRecommendationsResponse": {
"base": null,
"refs": {
}
},
"GetSessionRequest": {
"base": null,
"refs": {
}
},
"GetSessionResponse": {
"base": null,
"refs": {
}
},
"Headers": {
"base": null,
"refs": {
"StartContentUploadResponse$headersToInclude": "<p>The headers to include in the upload.</p>"
}
},
"Highlight": {
"base": "<p>Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.</p>",
"refs": {
"Highlights$member": null
}
},
"HighlightOffset": {
"base": null,
"refs": {
"Highlight$beginOffsetInclusive": "<p>The offset for the start of the highlight.</p>",
"Highlight$endOffsetExclusive": "<p>The offset for the end of the highlight.</p>"
}
},
"Highlights": {
"base": null,
"refs": {
"DocumentText$highlights": "<p>Highlights in the document text.</p>"
}
},
"KnowledgeBaseAssociationData": {
"base": "<p>Association information about the knowledge base.</p>",
"refs": {
"AssistantAssociationOutputData$knowledgeBaseAssociation": "<p>The knowledge base where output data is sent.</p>"
}
},
"KnowledgeBaseData": {
"base": "<p>Information about the knowledge base.</p>",
"refs": {
"CreateKnowledgeBaseResponse$knowledgeBase": "<p>The knowledge base.</p>",
"GetKnowledgeBaseResponse$knowledgeBase": "<p>The knowledge base.</p>",
"UpdateKnowledgeBaseTemplateUriResponse$knowledgeBase": "<p>The knowledge base to update.</p>"
}
},
"KnowledgeBaseList": {
"base": null,
"refs": {
"ListKnowledgeBasesResponse$knowledgeBaseSummaries": "<p>Information about the knowledge bases.</p>"
}
},
"KnowledgeBaseStatus": {
"base": null,
"refs": {
"KnowledgeBaseData$status": "<p>The status of the knowledge base.</p>",
"KnowledgeBaseSummary$status": "<p>The status of the knowledge base summary.</p>"
}
},
"KnowledgeBaseSummary": {
"base": "<p>Summary information about the knowledge base.</p>",
"refs": {
"KnowledgeBaseList$member": null
}
},
"KnowledgeBaseType": {
"base": null,
"refs": {
"CreateKnowledgeBaseRequest$knowledgeBaseType": "<p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically. </p>",
"KnowledgeBaseData$knowledgeBaseType": "<p>The type of knowledge base.</p>",
"KnowledgeBaseSummary$knowledgeBaseType": "<p>The type of knowledge base.</p>"
}
},
"ListAssistantAssociationsRequest": {
"base": null,
"refs": {
}
},
"ListAssistantAssociationsResponse": {
"base": null,
"refs": {
}
},
"ListAssistantsRequest": {
"base": null,
"refs": {
}
},
"ListAssistantsResponse": {
"base": null,
"refs": {
}
},
"ListContentsRequest": {
"base": null,
"refs": {
}
},
"ListContentsResponse": {
"base": null,
"refs": {
}
},
"ListKnowledgeBasesRequest": {
"base": null,
"refs": {
}
},
"ListKnowledgeBasesResponse": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"GetRecommendationsRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"ListAssistantAssociationsRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"ListAssistantsRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"ListContentsRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"ListKnowledgeBasesRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"QueryAssistantRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"SearchContentRequest$maxResults": "<p>The maximum number of results to return per page.</p>",
"SearchSessionsRequest$maxResults": "<p>The maximum number of results to return per page.</p>"
}
},
"Name": {
"base": null,
"refs": {
"AssistantData$name": "<p>The name.</p>",
"AssistantSummary$name": "<p>The name of the assistant.</p>",
"ContentData$name": "<p>The name of the content.</p>",
"ContentSummary$name": "<p>The name of the content.</p>",
"CreateAssistantRequest$name": "<p>The name of the assistant.</p>",
"CreateContentRequest$name": "<p>The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html\">SearchContent</a> API.</p>",
"CreateKnowledgeBaseRequest$name": "<p>The name of the knowledge base.</p>",
"CreateSessionRequest$name": "<p>The name of the session.</p>",
"KnowledgeBaseData$name": "<p>The name of the knowledge base.</p>",
"KnowledgeBaseSummary$name": "<p>The name of the knowledge base.</p>",
"SessionData$name": "<p>The name of the session.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"ListAssistantAssociationsRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"ListAssistantAssociationsResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"ListAssistantsRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"ListAssistantsResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"ListContentsRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"ListContentsResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"QueryAssistantRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"QueryAssistantResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"SearchContentRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"SearchContentResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"SearchSessionsRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"SearchSessionsResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>"
}
},
"NonEmptyString": {
"base": null,
"refs": {
"ContentData$revisionId": "<p>The identifier of the content revision.</p>",
"ContentMetadata$key": null,
"ContentMetadata$value": null,
"ContentSummary$revisionId": "<p>The identifier of the revision of the content.</p>",
"CreateContentRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateContentRequest$uploadId": "<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>",
"CreateKnowledgeBaseRequest$clientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"Filter$value": "<p>The desired field value on which to filter.</p>",
"Headers$key": null,
"Headers$value": null,
"ListKnowledgeBasesRequest$nextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"ListKnowledgeBasesResponse$nextToken": "<p>If there are additional results, this is the token for the next set of results.</p>",
"ObjectFieldsList$member": null,
"ServerSideEncryptionConfiguration$kmsKeyId": "<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 (KeyId)</a>.</p>",
"StartContentUploadResponse$uploadId": "<p>The identifier of the upload.</p>",
"UpdateContentRequest$revisionId": "<p>The <code>revisionId</code> of the content resource to update, taken from an earlier call to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a <code>PreconditionFailedException</code>.</p>",
"UpdateContentRequest$uploadId": "<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>"
}
},
"NotifyRecommendationsReceivedError": {
"base": "<p>An error occurred when creating a recommendation.</p>",
"refs": {
"NotifyRecommendationsReceivedErrorList$member": null
}
},
"NotifyRecommendationsReceivedErrorList": {
"base": null,
"refs": {
"NotifyRecommendationsReceivedResponse$errors": "<p>The identifiers of recommendations that are causing errors.</p>"
}
},
"NotifyRecommendationsReceivedErrorMessage": {
"base": null,
"refs": {
"NotifyRecommendationsReceivedError$message": "<p>A recommendation is causing an error.</p>"
}
},
"NotifyRecommendationsReceivedRequest": {
"base": null,
"refs": {
}
},
"NotifyRecommendationsReceivedResponse": {
"base": null,
"refs": {
}
},
"ObjectFieldsList": {
"base": null,
"refs": {
"AppIntegrationsConfiguration$objectFields": "<p>The fields from the source that are made available to your agents in Wisdom. </p> <ul> <li> <p> For <a href=\"https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm\"> Salesforce</a>, you must include at least <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>, <code>PublishStatus</code>, and <code>IsDeleted</code>. </p> </li> <li> <p>For <a href=\"https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api\"> ServiceNow</a>, you must include at least <code>number</code>, <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>, and <code>active</code>. </p> </li> </ul> <p>Make sure to include additional fields. These fields are indexed and used to source recommendations. </p>"
}
},
"PreconditionFailedException": {
"base": "<p>The provided <code>revisionId</code> does not match, indicating the content has been modified since it was last read.</p>",
"refs": {
}
},
"PutFeedbackRequest": {
"base": null,
"refs": {
}
},
"PutFeedbackResponse": {
"base": null,
"refs": {
}
},
"QueryAssistantRequest": {
"base": null,
"refs": {
}
},
"QueryAssistantResponse": {
"base": null,
"refs": {
}
},
"QueryRecommendationTriggerData": {
"base": "<p>Data associated with the QUERY RecommendationTriggerType.</p>",
"refs": {
"RecommendationTriggerData$query": "<p>Data associated with the QUERY RecommendationTriggerType.</p>"
}
},
"QueryResultsList": {
"base": null,
"refs": {
"QueryAssistantResponse$results": "<p>The results of the query.</p>"
}
},
"QueryText": {
"base": null,
"refs": {
"QueryAssistantRequest$queryText": "<p>The text to search for.</p>",
"QueryRecommendationTriggerData$text": "<p>The text associated with the recommendation trigger.</p>"
}
},
"RecommendationData": {
"base": "<p>Information about the recommendation.</p>",
"refs": {
"RecommendationList$member": null
}
},
"RecommendationIdList": {
"base": null,
"refs": {
"NotifyRecommendationsReceivedRequest$recommendationIds": "<p>The identifiers of the recommendations.</p>",
"NotifyRecommendationsReceivedResponse$recommendationIds": "<p>The identifiers of the recommendations.</p>",
"RecommendationTrigger$recommendationIds": "<p>The identifiers of the recommendations.</p>"
}
},
"RecommendationList": {
"base": null,
"refs": {
"GetRecommendationsResponse$recommendations": "<p>The recommendations.</p>"
}
},
"RecommendationSourceType": {
"base": null,
"refs": {
"RecommendationTrigger$source": "<p>The source of the recommendation trigger.</p> <ul> <li> <p>ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.</p> </li> <li> <p>RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.</p> </li> </ul>"
}
},
"RecommendationTrigger": {
"base": "<p>A recommendation trigger provides context on the event that produced the referenced recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a single RecommendationTrigger.</p>",
"refs": {
"RecommendationTriggerList$member": null
}
},
"RecommendationTriggerData": {
"base": "<p>A union type containing information related to the trigger.</p>",
"refs": {
"RecommendationTrigger$data": "<p>A union type containing information related to the trigger.</p>"
}
},
"RecommendationTriggerList": {
"base": null,
"refs": {
"GetRecommendationsResponse$triggers": "<p>The triggers corresponding to recommendations.</p>"
}
},
"RecommendationTriggerType": {
"base": null,
"refs": {
"RecommendationTrigger$type": "<p>The type of recommendation trigger.</p>"
}
},
"RecommendationType": {
"base": null,
"refs": {
"RecommendationData$type": "<p>The type of recommendation.</p>"
}
},
"Relevance": {
"base": null,
"refs": {
"FeedbackData$relevance": "<p>The relevance of the target this feedback is for.</p>"
}
},
"RelevanceLevel": {
"base": null,
"refs": {
"RecommendationData$relevanceLevel": "<p>The relevance level of the recommendation.</p>"
}
},
"RelevanceScore": {
"base": null,
"refs": {
"RecommendationData$relevanceScore": "<p>The relevance score of the recommendation.</p>",
"ResultData$relevanceScore": "<p>The relevance score of the results.</p>"
}
},
"RemoveKnowledgeBaseTemplateUriRequest": {
"base": null,
"refs": {
}
},
"RemoveKnowledgeBaseTemplateUriResponse": {
"base": null,
"refs": {
}
},
"RenderingConfiguration": {
"base": "<p>Information about how to render the content.</p>",
"refs": {
"CreateKnowledgeBaseRequest$renderingConfiguration": "<p>Information about how to render the content.</p>",
"KnowledgeBaseData$renderingConfiguration": "<p>Information about how to render the content.</p>",
"KnowledgeBaseSummary$renderingConfiguration": "<p>Information about how to render the content.</p>"
}
},
"ResourceNotFoundException": {
"base": "<p>The specified resource does not exist.</p>",
"refs": {
}
},
"ResultData": {
"base": "<p>Information about the result.</p>",
"refs": {
"QueryResultsList$member": null
}
},
"SearchContentRequest": {
"base": null,
"refs": {
}
},
"SearchContentResponse": {
"base": null,
"refs": {
}
},
"SearchExpression": {
"base": "<p>The search expression.</p>",
"refs": {
"SearchContentRequest$searchExpression": "<p>The search expression to filter results.</p>",
"SearchSessionsRequest$searchExpression": "<p>The search expression to filter results.</p>"
}
},
"SearchSessionsRequest": {
"base": null,
"refs": {
}
},
"SearchSessionsResponse": {
"base": null,
"refs": {
}
},
"SensitiveString": {
"base": null,
"refs": {
"DocumentText$text": "<p>Text in the document.</p>"
}
},
"ServerSideEncryptionConfiguration": {
"base": "<p>The KMS key used for encryption.</p>",
"refs": {
"AssistantData$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>",
"AssistantSummary$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>",
"CreateAssistantRequest$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>",
"CreateKnowledgeBaseRequest$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>",
"KnowledgeBaseData$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>",
"KnowledgeBaseSummary$serverSideEncryptionConfiguration": "<p>The KMS key used for encryption.</p>"
}
},
"ServiceQuotaExceededException": {
"base": "<p>You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.</p>",
"refs": {
}
},
"SessionData": {
"base": "<p>Information about the session.</p>",
"refs": {
"CreateSessionResponse$session": "<p>The session.</p>",
"GetSessionResponse$session": "<p>The session.</p>"
}
},
"SessionSummaries": {
"base": null,
"refs": {
"SearchSessionsResponse$sessionSummaries": "<p>Summary information about the sessions.</p>"
}
},
"SessionSummary": {
"base": "<p>Summary information about the session.</p>",
"refs": {
"SessionSummaries$member": null
}
},
"SourceConfiguration": {
"base": "<p>Configuration information about the external data source.</p>",
"refs": {
"CreateKnowledgeBaseRequest$sourceConfiguration": "<p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.</p>",
"KnowledgeBaseData$sourceConfiguration": "<p>Source configuration information about the knowledge base.</p>",
"KnowledgeBaseSummary$sourceConfiguration": "<p>Configuration information about the external data source.</p>"
}
},
"StartContentUploadRequest": {
"base": null,
"refs": {
}
},
"StartContentUploadResponse": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"AccessDeniedException$message": null,
"ConflictException$message": null,
"NotifyRecommendationsReceivedError$recommendationId": "<p>The identifier of the recommendation that is in error.</p>",
"PreconditionFailedException$message": null,
"PutFeedbackRequest$targetId": "<p>The identifier of a recommendation. or The identifier of the result data.</p>",
"RecommendationData$recommendationId": "<p>The identifier of the recommendation.</p>",
"RecommendationIdList$member": null,
"ResourceNotFoundException$message": null,
"ResourceNotFoundException$resourceName": "<p>The specified resource name.</p>",
"ServiceQuotaExceededException$message": null,
"TooManyTagsException$message": null,
"TooManyTagsException$resourceName": "<p>The specified resource name.</p>",
"ValidationException$message": null
}
},
"SyntheticTimestamp_epoch_seconds": {
"base": null,
"refs": {
"ContentData$urlExpiry": "<p>The expiration time of the URL as an epoch timestamp.</p>",
"KnowledgeBaseData$lastContentModificationTime": "<p>An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.</p>",
"StartContentUploadResponse$urlExpiry": "<p>The expiration time of the URL as an epoch timestamp.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"TagKeyList$member": null,
"Tags$key": null
}
},
"TagKeyList": {
"base": null,
"refs": {
"UntagResourceRequest$tagKeys": "<p>The tag keys.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tags$value": null
}
},
"Tags": {
"base": null,
"refs": {
"AssistantAssociationData$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"AssistantAssociationSummary$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"AssistantData$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"AssistantSummary$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"ContentData$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"ContentSummary$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"CreateAssistantAssociationRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"CreateAssistantRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"CreateContentRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"CreateKnowledgeBaseRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"CreateSessionRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"KnowledgeBaseData$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"KnowledgeBaseSummary$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"ListTagsForResourceResponse$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"SessionData$tags": "<p>The tags used to organize, track, or control access for this resource.</p>",
"TagResourceRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>"
}
},
"TargetType": {
"base": null,
"refs": {
"PutFeedbackRequest$targetType": "<p>The type of the targetId for which The feedback. is targeted.</p>",
"PutFeedbackResponse$targetType": "<p>The type of the targetId for which The feedback. is targeted.</p>"
}
},
"TooManyTagsException": {
"base": "<p>Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.</p>",
"refs": {
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,