aws-sdk-qconnect 1.3.0 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/types.rbs ADDED
@@ -0,0 +1,1165 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::QConnect
9
+ module Types
10
+
11
+ class AccessDeniedException
12
+ attr_accessor message: ::String
13
+ SENSITIVE: []
14
+ end
15
+
16
+ class AppIntegrationsConfiguration
17
+ attr_accessor app_integration_arn: ::String
18
+ attr_accessor object_fields: ::Array[::String]
19
+ SENSITIVE: []
20
+ end
21
+
22
+ class AssistantAssociationData
23
+ attr_accessor assistant_arn: ::String
24
+ attr_accessor assistant_association_arn: ::String
25
+ attr_accessor assistant_association_id: ::String
26
+ attr_accessor assistant_id: ::String
27
+ attr_accessor association_data: Types::AssistantAssociationOutputData
28
+ attr_accessor association_type: ("KNOWLEDGE_BASE")
29
+ attr_accessor tags: ::Hash[::String, ::String]
30
+ SENSITIVE: []
31
+ end
32
+
33
+ class AssistantAssociationInputData
34
+ attr_accessor knowledge_base_id: ::String
35
+ attr_accessor unknown: untyped
36
+ SENSITIVE: []
37
+
38
+ class KnowledgeBaseId < AssistantAssociationInputData
39
+ end
40
+ class Unknown < AssistantAssociationInputData
41
+ end
42
+ end
43
+
44
+ class AssistantAssociationOutputData
45
+ attr_accessor knowledge_base_association: Types::KnowledgeBaseAssociationData
46
+ attr_accessor unknown: untyped
47
+ SENSITIVE: []
48
+
49
+ class KnowledgeBaseAssociation < AssistantAssociationOutputData
50
+ end
51
+ class Unknown < AssistantAssociationOutputData
52
+ end
53
+ end
54
+
55
+ class AssistantAssociationSummary
56
+ attr_accessor assistant_arn: ::String
57
+ attr_accessor assistant_association_arn: ::String
58
+ attr_accessor assistant_association_id: ::String
59
+ attr_accessor assistant_id: ::String
60
+ attr_accessor association_data: Types::AssistantAssociationOutputData
61
+ attr_accessor association_type: ("KNOWLEDGE_BASE")
62
+ attr_accessor tags: ::Hash[::String, ::String]
63
+ SENSITIVE: []
64
+ end
65
+
66
+ class AssistantCapabilityConfiguration
67
+ attr_accessor type: ("V1" | "V2")
68
+ SENSITIVE: []
69
+ end
70
+
71
+ class AssistantData
72
+ attr_accessor assistant_arn: ::String
73
+ attr_accessor assistant_id: ::String
74
+ attr_accessor capability_configuration: Types::AssistantCapabilityConfiguration
75
+ attr_accessor description: ::String
76
+ attr_accessor integration_configuration: Types::AssistantIntegrationConfiguration
77
+ attr_accessor name: ::String
78
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
79
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
80
+ attr_accessor tags: ::Hash[::String, ::String]
81
+ attr_accessor type: ("AGENT")
82
+ SENSITIVE: []
83
+ end
84
+
85
+ class AssistantIntegrationConfiguration
86
+ attr_accessor topic_integration_arn: ::String
87
+ SENSITIVE: []
88
+ end
89
+
90
+ class AssistantSummary
91
+ attr_accessor assistant_arn: ::String
92
+ attr_accessor assistant_id: ::String
93
+ attr_accessor capability_configuration: Types::AssistantCapabilityConfiguration
94
+ attr_accessor description: ::String
95
+ attr_accessor integration_configuration: Types::AssistantIntegrationConfiguration
96
+ attr_accessor name: ::String
97
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
98
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
99
+ attr_accessor tags: ::Hash[::String, ::String]
100
+ attr_accessor type: ("AGENT")
101
+ SENSITIVE: []
102
+ end
103
+
104
+ class Configuration
105
+ attr_accessor connect_configuration: Types::ConnectConfiguration
106
+ attr_accessor unknown: untyped
107
+ SENSITIVE: []
108
+
109
+ class ConnectConfiguration < Configuration
110
+ end
111
+ class Unknown < Configuration
112
+ end
113
+ end
114
+
115
+ class ConflictException
116
+ attr_accessor message: ::String
117
+ SENSITIVE: []
118
+ end
119
+
120
+ class ConnectConfiguration
121
+ attr_accessor instance_id: ::String
122
+ SENSITIVE: []
123
+ end
124
+
125
+ class ContentData
126
+ attr_accessor content_arn: ::String
127
+ attr_accessor content_id: ::String
128
+ attr_accessor content_type: ::String
129
+ attr_accessor knowledge_base_arn: ::String
130
+ attr_accessor knowledge_base_id: ::String
131
+ attr_accessor link_out_uri: ::String
132
+ attr_accessor metadata: ::Hash[::String, ::String]
133
+ attr_accessor name: ::String
134
+ attr_accessor revision_id: ::String
135
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED" | "UPDATE_FAILED")
136
+ attr_accessor tags: ::Hash[::String, ::String]
137
+ attr_accessor title: ::String
138
+ attr_accessor url: ::String
139
+ attr_accessor url_expiry: ::Time
140
+ SENSITIVE: [:url]
141
+ end
142
+
143
+ class ContentDataDetails
144
+ attr_accessor ranking_data: Types::RankingData
145
+ attr_accessor text_data: Types::TextData
146
+ SENSITIVE: []
147
+ end
148
+
149
+ class ContentFeedbackData
150
+ attr_accessor generative_content_feedback_data: Types::GenerativeContentFeedbackData
151
+ attr_accessor unknown: untyped
152
+ SENSITIVE: []
153
+
154
+ class GenerativeContentFeedbackData < ContentFeedbackData
155
+ end
156
+ class Unknown < ContentFeedbackData
157
+ end
158
+ end
159
+
160
+ class ContentReference
161
+ attr_accessor content_arn: ::String
162
+ attr_accessor content_id: ::String
163
+ attr_accessor knowledge_base_arn: ::String
164
+ attr_accessor knowledge_base_id: ::String
165
+ SENSITIVE: []
166
+ end
167
+
168
+ class ContentSummary
169
+ attr_accessor content_arn: ::String
170
+ attr_accessor content_id: ::String
171
+ attr_accessor content_type: ::String
172
+ attr_accessor knowledge_base_arn: ::String
173
+ attr_accessor knowledge_base_id: ::String
174
+ attr_accessor metadata: ::Hash[::String, ::String]
175
+ attr_accessor name: ::String
176
+ attr_accessor revision_id: ::String
177
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED" | "UPDATE_FAILED")
178
+ attr_accessor tags: ::Hash[::String, ::String]
179
+ attr_accessor title: ::String
180
+ SENSITIVE: []
181
+ end
182
+
183
+ class CreateAssistantAssociationRequest
184
+ attr_accessor assistant_id: ::String
185
+ attr_accessor association: Types::AssistantAssociationInputData
186
+ attr_accessor association_type: ("KNOWLEDGE_BASE")
187
+ attr_accessor client_token: ::String
188
+ attr_accessor tags: ::Hash[::String, ::String]
189
+ SENSITIVE: []
190
+ end
191
+
192
+ class CreateAssistantAssociationResponse
193
+ attr_accessor assistant_association: Types::AssistantAssociationData
194
+ SENSITIVE: []
195
+ end
196
+
197
+ class CreateAssistantRequest
198
+ attr_accessor client_token: ::String
199
+ attr_accessor description: ::String
200
+ attr_accessor name: ::String
201
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
202
+ attr_accessor tags: ::Hash[::String, ::String]
203
+ attr_accessor type: ("AGENT")
204
+ SENSITIVE: []
205
+ end
206
+
207
+ class CreateAssistantResponse
208
+ attr_accessor assistant: Types::AssistantData
209
+ SENSITIVE: []
210
+ end
211
+
212
+ class CreateContentRequest
213
+ attr_accessor client_token: ::String
214
+ attr_accessor knowledge_base_id: ::String
215
+ attr_accessor metadata: ::Hash[::String, ::String]
216
+ attr_accessor name: ::String
217
+ attr_accessor override_link_out_uri: ::String
218
+ attr_accessor tags: ::Hash[::String, ::String]
219
+ attr_accessor title: ::String
220
+ attr_accessor upload_id: ::String
221
+ SENSITIVE: []
222
+ end
223
+
224
+ class CreateContentResponse
225
+ attr_accessor content: Types::ContentData
226
+ SENSITIVE: []
227
+ end
228
+
229
+ class CreateKnowledgeBaseRequest
230
+ attr_accessor client_token: ::String
231
+ attr_accessor description: ::String
232
+ attr_accessor knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES")
233
+ attr_accessor name: ::String
234
+ attr_accessor rendering_configuration: Types::RenderingConfiguration
235
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
236
+ attr_accessor source_configuration: Types::SourceConfiguration
237
+ attr_accessor tags: ::Hash[::String, ::String]
238
+ SENSITIVE: []
239
+ end
240
+
241
+ class CreateKnowledgeBaseResponse
242
+ attr_accessor knowledge_base: Types::KnowledgeBaseData
243
+ SENSITIVE: []
244
+ end
245
+
246
+ class CreateQuickResponseRequest
247
+ attr_accessor channels: ::Array[::String]
248
+ attr_accessor client_token: ::String
249
+ attr_accessor content: Types::QuickResponseDataProvider
250
+ attr_accessor content_type: ::String
251
+ attr_accessor description: ::String
252
+ attr_accessor grouping_configuration: Types::GroupingConfiguration
253
+ attr_accessor is_active: bool
254
+ attr_accessor knowledge_base_id: ::String
255
+ attr_accessor language: ::String
256
+ attr_accessor name: ::String
257
+ attr_accessor shortcut_key: ::String
258
+ attr_accessor tags: ::Hash[::String, ::String]
259
+ SENSITIVE: []
260
+ end
261
+
262
+ class CreateQuickResponseResponse
263
+ attr_accessor quick_response: Types::QuickResponseData
264
+ SENSITIVE: []
265
+ end
266
+
267
+ class CreateSessionRequest
268
+ attr_accessor assistant_id: ::String
269
+ attr_accessor client_token: ::String
270
+ attr_accessor description: ::String
271
+ attr_accessor name: ::String
272
+ attr_accessor tags: ::Hash[::String, ::String]
273
+ SENSITIVE: []
274
+ end
275
+
276
+ class CreateSessionResponse
277
+ attr_accessor session: Types::SessionData
278
+ SENSITIVE: []
279
+ end
280
+
281
+ class DataDetails
282
+ attr_accessor content_data: Types::ContentDataDetails
283
+ attr_accessor generative_data: Types::GenerativeDataDetails
284
+ attr_accessor source_content_data: Types::SourceContentDataDetails
285
+ attr_accessor unknown: untyped
286
+ SENSITIVE: []
287
+
288
+ class ContentData < DataDetails
289
+ end
290
+ class GenerativeData < DataDetails
291
+ end
292
+ class SourceContentData < DataDetails
293
+ end
294
+ class Unknown < DataDetails
295
+ end
296
+ end
297
+
298
+ class DataReference
299
+ attr_accessor content_reference: Types::ContentReference
300
+ attr_accessor generative_reference: Types::GenerativeReference
301
+ attr_accessor unknown: untyped
302
+ SENSITIVE: []
303
+
304
+ class ContentReference < DataReference
305
+ end
306
+ class GenerativeReference < DataReference
307
+ end
308
+ class Unknown < DataReference
309
+ end
310
+ end
311
+
312
+ class DataSummary
313
+ attr_accessor details: Types::DataDetails
314
+ attr_accessor reference: Types::DataReference
315
+ SENSITIVE: []
316
+ end
317
+
318
+ class DeleteAssistantAssociationRequest
319
+ attr_accessor assistant_association_id: ::String
320
+ attr_accessor assistant_id: ::String
321
+ SENSITIVE: []
322
+ end
323
+
324
+ class DeleteAssistantAssociationResponse < Aws::EmptyStructure
325
+ end
326
+
327
+ class DeleteAssistantRequest
328
+ attr_accessor assistant_id: ::String
329
+ SENSITIVE: []
330
+ end
331
+
332
+ class DeleteAssistantResponse < Aws::EmptyStructure
333
+ end
334
+
335
+ class DeleteContentRequest
336
+ attr_accessor content_id: ::String
337
+ attr_accessor knowledge_base_id: ::String
338
+ SENSITIVE: []
339
+ end
340
+
341
+ class DeleteContentResponse < Aws::EmptyStructure
342
+ end
343
+
344
+ class DeleteImportJobRequest
345
+ attr_accessor import_job_id: ::String
346
+ attr_accessor knowledge_base_id: ::String
347
+ SENSITIVE: []
348
+ end
349
+
350
+ class DeleteImportJobResponse < Aws::EmptyStructure
351
+ end
352
+
353
+ class DeleteKnowledgeBaseRequest
354
+ attr_accessor knowledge_base_id: ::String
355
+ SENSITIVE: []
356
+ end
357
+
358
+ class DeleteKnowledgeBaseResponse < Aws::EmptyStructure
359
+ end
360
+
361
+ class DeleteQuickResponseRequest
362
+ attr_accessor knowledge_base_id: ::String
363
+ attr_accessor quick_response_id: ::String
364
+ SENSITIVE: []
365
+ end
366
+
367
+ class DeleteQuickResponseResponse < Aws::EmptyStructure
368
+ end
369
+
370
+ class Document
371
+ attr_accessor content_reference: Types::ContentReference
372
+ attr_accessor excerpt: Types::DocumentText
373
+ attr_accessor title: Types::DocumentText
374
+ SENSITIVE: []
375
+ end
376
+
377
+ class DocumentText
378
+ attr_accessor highlights: ::Array[Types::Highlight]
379
+ attr_accessor text: ::String
380
+ SENSITIVE: [:text]
381
+ end
382
+
383
+ class ExternalSourceConfiguration
384
+ attr_accessor configuration: Types::Configuration
385
+ attr_accessor source: ("AMAZON_CONNECT")
386
+ SENSITIVE: []
387
+ end
388
+
389
+ class Filter
390
+ attr_accessor field: ("NAME")
391
+ attr_accessor operator: ("EQUALS")
392
+ attr_accessor value: ::String
393
+ SENSITIVE: []
394
+ end
395
+
396
+ class GenerativeContentFeedbackData
397
+ attr_accessor relevance: ("HELPFUL" | "NOT_HELPFUL")
398
+ SENSITIVE: []
399
+ end
400
+
401
+ class GenerativeDataDetails
402
+ attr_accessor completion: ::String
403
+ attr_accessor ranking_data: Types::RankingData
404
+ attr_accessor references: ::Array[Types::DataSummary]
405
+ SENSITIVE: [:completion]
406
+ end
407
+
408
+ class GenerativeReference
409
+ attr_accessor generation_id: ::String
410
+ attr_accessor model_id: ::String
411
+ SENSITIVE: []
412
+ end
413
+
414
+ class GetAssistantAssociationRequest
415
+ attr_accessor assistant_association_id: ::String
416
+ attr_accessor assistant_id: ::String
417
+ SENSITIVE: []
418
+ end
419
+
420
+ class GetAssistantAssociationResponse
421
+ attr_accessor assistant_association: Types::AssistantAssociationData
422
+ SENSITIVE: []
423
+ end
424
+
425
+ class GetAssistantRequest
426
+ attr_accessor assistant_id: ::String
427
+ SENSITIVE: []
428
+ end
429
+
430
+ class GetAssistantResponse
431
+ attr_accessor assistant: Types::AssistantData
432
+ SENSITIVE: []
433
+ end
434
+
435
+ class GetContentRequest
436
+ attr_accessor content_id: ::String
437
+ attr_accessor knowledge_base_id: ::String
438
+ SENSITIVE: []
439
+ end
440
+
441
+ class GetContentResponse
442
+ attr_accessor content: Types::ContentData
443
+ SENSITIVE: []
444
+ end
445
+
446
+ class GetContentSummaryRequest
447
+ attr_accessor content_id: ::String
448
+ attr_accessor knowledge_base_id: ::String
449
+ SENSITIVE: []
450
+ end
451
+
452
+ class GetContentSummaryResponse
453
+ attr_accessor content_summary: Types::ContentSummary
454
+ SENSITIVE: []
455
+ end
456
+
457
+ class GetImportJobRequest
458
+ attr_accessor import_job_id: ::String
459
+ attr_accessor knowledge_base_id: ::String
460
+ SENSITIVE: []
461
+ end
462
+
463
+ class GetImportJobResponse
464
+ attr_accessor import_job: Types::ImportJobData
465
+ SENSITIVE: []
466
+ end
467
+
468
+ class GetKnowledgeBaseRequest
469
+ attr_accessor knowledge_base_id: ::String
470
+ SENSITIVE: []
471
+ end
472
+
473
+ class GetKnowledgeBaseResponse
474
+ attr_accessor knowledge_base: Types::KnowledgeBaseData
475
+ SENSITIVE: []
476
+ end
477
+
478
+ class GetQuickResponseRequest
479
+ attr_accessor knowledge_base_id: ::String
480
+ attr_accessor quick_response_id: ::String
481
+ SENSITIVE: []
482
+ end
483
+
484
+ class GetQuickResponseResponse
485
+ attr_accessor quick_response: Types::QuickResponseData
486
+ SENSITIVE: []
487
+ end
488
+
489
+ class GetRecommendationsRequest
490
+ attr_accessor assistant_id: ::String
491
+ attr_accessor max_results: ::Integer
492
+ attr_accessor session_id: ::String
493
+ attr_accessor wait_time_seconds: ::Integer
494
+ SENSITIVE: []
495
+ end
496
+
497
+ class GetRecommendationsResponse
498
+ attr_accessor recommendations: ::Array[Types::RecommendationData]
499
+ attr_accessor triggers: ::Array[Types::RecommendationTrigger]
500
+ SENSITIVE: []
501
+ end
502
+
503
+ class GetSessionRequest
504
+ attr_accessor assistant_id: ::String
505
+ attr_accessor session_id: ::String
506
+ SENSITIVE: []
507
+ end
508
+
509
+ class GetSessionResponse
510
+ attr_accessor session: Types::SessionData
511
+ SENSITIVE: []
512
+ end
513
+
514
+ class GroupingConfiguration
515
+ attr_accessor criteria: ::String
516
+ attr_accessor values: ::Array[::String]
517
+ SENSITIVE: [:criteria]
518
+ end
519
+
520
+ class Highlight
521
+ attr_accessor begin_offset_inclusive: ::Integer
522
+ attr_accessor end_offset_exclusive: ::Integer
523
+ SENSITIVE: []
524
+ end
525
+
526
+ class ImportJobData
527
+ attr_accessor created_time: ::Time
528
+ attr_accessor external_source_configuration: Types::ExternalSourceConfiguration
529
+ attr_accessor failed_record_report: ::String
530
+ attr_accessor import_job_id: ::String
531
+ attr_accessor import_job_type: ("QUICK_RESPONSES")
532
+ attr_accessor knowledge_base_arn: ::String
533
+ attr_accessor knowledge_base_id: ::String
534
+ attr_accessor last_modified_time: ::Time
535
+ attr_accessor metadata: ::Hash[::String, ::String]
536
+ attr_accessor status: ("START_IN_PROGRESS" | "FAILED" | "COMPLETE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
537
+ attr_accessor upload_id: ::String
538
+ attr_accessor url: ::String
539
+ attr_accessor url_expiry: ::Time
540
+ SENSITIVE: [:failed_record_report, :url]
541
+ end
542
+
543
+ class ImportJobSummary
544
+ attr_accessor created_time: ::Time
545
+ attr_accessor external_source_configuration: Types::ExternalSourceConfiguration
546
+ attr_accessor import_job_id: ::String
547
+ attr_accessor import_job_type: ("QUICK_RESPONSES")
548
+ attr_accessor knowledge_base_arn: ::String
549
+ attr_accessor knowledge_base_id: ::String
550
+ attr_accessor last_modified_time: ::Time
551
+ attr_accessor metadata: ::Hash[::String, ::String]
552
+ attr_accessor status: ("START_IN_PROGRESS" | "FAILED" | "COMPLETE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
553
+ attr_accessor upload_id: ::String
554
+ SENSITIVE: []
555
+ end
556
+
557
+ class KnowledgeBaseAssociationData
558
+ attr_accessor knowledge_base_arn: ::String
559
+ attr_accessor knowledge_base_id: ::String
560
+ SENSITIVE: []
561
+ end
562
+
563
+ class KnowledgeBaseData
564
+ attr_accessor description: ::String
565
+ attr_accessor knowledge_base_arn: ::String
566
+ attr_accessor knowledge_base_id: ::String
567
+ attr_accessor knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES")
568
+ attr_accessor last_content_modification_time: ::Time
569
+ attr_accessor name: ::String
570
+ attr_accessor rendering_configuration: Types::RenderingConfiguration
571
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
572
+ attr_accessor source_configuration: Types::SourceConfiguration
573
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
574
+ attr_accessor tags: ::Hash[::String, ::String]
575
+ SENSITIVE: []
576
+ end
577
+
578
+ class KnowledgeBaseSummary
579
+ attr_accessor description: ::String
580
+ attr_accessor knowledge_base_arn: ::String
581
+ attr_accessor knowledge_base_id: ::String
582
+ attr_accessor knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES")
583
+ attr_accessor name: ::String
584
+ attr_accessor rendering_configuration: Types::RenderingConfiguration
585
+ attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
586
+ attr_accessor source_configuration: Types::SourceConfiguration
587
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "ACTIVE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED")
588
+ attr_accessor tags: ::Hash[::String, ::String]
589
+ SENSITIVE: []
590
+ end
591
+
592
+ class ListAssistantAssociationsRequest
593
+ attr_accessor assistant_id: ::String
594
+ attr_accessor max_results: ::Integer
595
+ attr_accessor next_token: ::String
596
+ SENSITIVE: []
597
+ end
598
+
599
+ class ListAssistantAssociationsResponse
600
+ attr_accessor assistant_association_summaries: ::Array[Types::AssistantAssociationSummary]
601
+ attr_accessor next_token: ::String
602
+ SENSITIVE: []
603
+ end
604
+
605
+ class ListAssistantsRequest
606
+ attr_accessor max_results: ::Integer
607
+ attr_accessor next_token: ::String
608
+ SENSITIVE: []
609
+ end
610
+
611
+ class ListAssistantsResponse
612
+ attr_accessor assistant_summaries: ::Array[Types::AssistantSummary]
613
+ attr_accessor next_token: ::String
614
+ SENSITIVE: []
615
+ end
616
+
617
+ class ListContentsRequest
618
+ attr_accessor knowledge_base_id: ::String
619
+ attr_accessor max_results: ::Integer
620
+ attr_accessor next_token: ::String
621
+ SENSITIVE: []
622
+ end
623
+
624
+ class ListContentsResponse
625
+ attr_accessor content_summaries: ::Array[Types::ContentSummary]
626
+ attr_accessor next_token: ::String
627
+ SENSITIVE: []
628
+ end
629
+
630
+ class ListImportJobsRequest
631
+ attr_accessor knowledge_base_id: ::String
632
+ attr_accessor max_results: ::Integer
633
+ attr_accessor next_token: ::String
634
+ SENSITIVE: []
635
+ end
636
+
637
+ class ListImportJobsResponse
638
+ attr_accessor import_job_summaries: ::Array[Types::ImportJobSummary]
639
+ attr_accessor next_token: ::String
640
+ SENSITIVE: []
641
+ end
642
+
643
+ class ListKnowledgeBasesRequest
644
+ attr_accessor max_results: ::Integer
645
+ attr_accessor next_token: ::String
646
+ SENSITIVE: []
647
+ end
648
+
649
+ class ListKnowledgeBasesResponse
650
+ attr_accessor knowledge_base_summaries: ::Array[Types::KnowledgeBaseSummary]
651
+ attr_accessor next_token: ::String
652
+ SENSITIVE: []
653
+ end
654
+
655
+ class ListQuickResponsesRequest
656
+ attr_accessor knowledge_base_id: ::String
657
+ attr_accessor max_results: ::Integer
658
+ attr_accessor next_token: ::String
659
+ SENSITIVE: []
660
+ end
661
+
662
+ class ListQuickResponsesResponse
663
+ attr_accessor next_token: ::String
664
+ attr_accessor quick_response_summaries: ::Array[Types::QuickResponseSummary]
665
+ SENSITIVE: []
666
+ end
667
+
668
+ class ListTagsForResourceRequest
669
+ attr_accessor resource_arn: ::String
670
+ SENSITIVE: []
671
+ end
672
+
673
+ class ListTagsForResourceResponse
674
+ attr_accessor tags: ::Hash[::String, ::String]
675
+ SENSITIVE: []
676
+ end
677
+
678
+ class NotifyRecommendationsReceivedError
679
+ attr_accessor message: ::String
680
+ attr_accessor recommendation_id: ::String
681
+ SENSITIVE: []
682
+ end
683
+
684
+ class NotifyRecommendationsReceivedRequest
685
+ attr_accessor assistant_id: ::String
686
+ attr_accessor recommendation_ids: ::Array[::String]
687
+ attr_accessor session_id: ::String
688
+ SENSITIVE: []
689
+ end
690
+
691
+ class NotifyRecommendationsReceivedResponse
692
+ attr_accessor errors: ::Array[Types::NotifyRecommendationsReceivedError]
693
+ attr_accessor recommendation_ids: ::Array[::String]
694
+ SENSITIVE: []
695
+ end
696
+
697
+ class PreconditionFailedException
698
+ attr_accessor message: ::String
699
+ SENSITIVE: []
700
+ end
701
+
702
+ class PutFeedbackRequest
703
+ attr_accessor assistant_id: ::String
704
+ attr_accessor content_feedback: Types::ContentFeedbackData
705
+ attr_accessor target_id: ::String
706
+ attr_accessor target_type: ("RECOMMENDATION" | "RESULT")
707
+ SENSITIVE: []
708
+ end
709
+
710
+ class PutFeedbackResponse
711
+ attr_accessor assistant_arn: ::String
712
+ attr_accessor assistant_id: ::String
713
+ attr_accessor content_feedback: Types::ContentFeedbackData
714
+ attr_accessor target_id: ::String
715
+ attr_accessor target_type: ("RECOMMENDATION" | "RESULT")
716
+ SENSITIVE: []
717
+ end
718
+
719
+ class QueryAssistantRequest
720
+ attr_accessor assistant_id: ::String
721
+ attr_accessor max_results: ::Integer
722
+ attr_accessor next_token: ::String
723
+ attr_accessor query_condition: ::Array[Types::QueryCondition]
724
+ attr_accessor query_text: ::String
725
+ attr_accessor session_id: ::String
726
+ SENSITIVE: [:query_text]
727
+ end
728
+
729
+ class QueryAssistantResponse
730
+ attr_accessor next_token: ::String
731
+ attr_accessor results: ::Array[Types::ResultData]
732
+ SENSITIVE: []
733
+ end
734
+
735
+ class QueryCondition
736
+ attr_accessor single: Types::QueryConditionItem
737
+ attr_accessor unknown: untyped
738
+ SENSITIVE: []
739
+
740
+ class Single < QueryCondition
741
+ end
742
+ class Unknown < QueryCondition
743
+ end
744
+ end
745
+
746
+ class QueryConditionItem
747
+ attr_accessor comparator: ("EQUALS")
748
+ attr_accessor field: ("RESULT_TYPE")
749
+ attr_accessor value: ::String
750
+ SENSITIVE: []
751
+ end
752
+
753
+ class QueryRecommendationTriggerData
754
+ attr_accessor text: ::String
755
+ SENSITIVE: [:text]
756
+ end
757
+
758
+ class QuickResponseContentProvider
759
+ attr_accessor content: ::String
760
+ attr_accessor unknown: untyped
761
+ SENSITIVE: [:content]
762
+
763
+ class Content < QuickResponseContentProvider
764
+ end
765
+ class Unknown < QuickResponseContentProvider
766
+ end
767
+ end
768
+
769
+ class QuickResponseContents
770
+ attr_accessor markdown: Types::QuickResponseContentProvider
771
+ attr_accessor plain_text: Types::QuickResponseContentProvider
772
+ SENSITIVE: []
773
+ end
774
+
775
+ class QuickResponseData
776
+ attr_accessor channels: ::Array[::String]
777
+ attr_accessor content_type: ::String
778
+ attr_accessor contents: Types::QuickResponseContents
779
+ attr_accessor created_time: ::Time
780
+ attr_accessor description: ::String
781
+ attr_accessor grouping_configuration: Types::GroupingConfiguration
782
+ attr_accessor is_active: bool
783
+ attr_accessor knowledge_base_arn: ::String
784
+ attr_accessor knowledge_base_id: ::String
785
+ attr_accessor language: ::String
786
+ attr_accessor last_modified_by: ::String
787
+ attr_accessor last_modified_time: ::Time
788
+ attr_accessor name: ::String
789
+ attr_accessor quick_response_arn: ::String
790
+ attr_accessor quick_response_id: ::String
791
+ attr_accessor shortcut_key: ::String
792
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "CREATED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED")
793
+ attr_accessor tags: ::Hash[::String, ::String]
794
+ SENSITIVE: []
795
+ end
796
+
797
+ class QuickResponseDataProvider
798
+ attr_accessor content: ::String
799
+ attr_accessor unknown: untyped
800
+ SENSITIVE: [:content]
801
+
802
+ class Content < QuickResponseDataProvider
803
+ end
804
+ class Unknown < QuickResponseDataProvider
805
+ end
806
+ end
807
+
808
+ class QuickResponseFilterField
809
+ attr_accessor include_no_existence: bool
810
+ attr_accessor name: ::String
811
+ attr_accessor operator: ("EQUALS" | "PREFIX")
812
+ attr_accessor values: ::Array[::String]
813
+ SENSITIVE: []
814
+ end
815
+
816
+ class QuickResponseOrderField
817
+ attr_accessor name: ::String
818
+ attr_accessor order: ("ASC" | "DESC")
819
+ SENSITIVE: []
820
+ end
821
+
822
+ class QuickResponseQueryField
823
+ attr_accessor allow_fuzziness: bool
824
+ attr_accessor name: ::String
825
+ attr_accessor operator: ("CONTAINS" | "CONTAINS_AND_PREFIX")
826
+ attr_accessor priority: ("HIGH" | "MEDIUM" | "LOW")
827
+ attr_accessor values: ::Array[::String]
828
+ SENSITIVE: []
829
+ end
830
+
831
+ class QuickResponseSearchExpression
832
+ attr_accessor filters: ::Array[Types::QuickResponseFilterField]
833
+ attr_accessor order_on_field: Types::QuickResponseOrderField
834
+ attr_accessor queries: ::Array[Types::QuickResponseQueryField]
835
+ SENSITIVE: []
836
+ end
837
+
838
+ class QuickResponseSearchResultData
839
+ attr_accessor attributes_interpolated: ::Array[::String]
840
+ attr_accessor attributes_not_interpolated: ::Array[::String]
841
+ attr_accessor channels: ::Array[::String]
842
+ attr_accessor content_type: ::String
843
+ attr_accessor contents: Types::QuickResponseContents
844
+ attr_accessor created_time: ::Time
845
+ attr_accessor description: ::String
846
+ attr_accessor grouping_configuration: Types::GroupingConfiguration
847
+ attr_accessor is_active: bool
848
+ attr_accessor knowledge_base_arn: ::String
849
+ attr_accessor knowledge_base_id: ::String
850
+ attr_accessor language: ::String
851
+ attr_accessor last_modified_by: ::String
852
+ attr_accessor last_modified_time: ::Time
853
+ attr_accessor name: ::String
854
+ attr_accessor quick_response_arn: ::String
855
+ attr_accessor quick_response_id: ::String
856
+ attr_accessor shortcut_key: ::String
857
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "CREATED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED")
858
+ attr_accessor tags: ::Hash[::String, ::String]
859
+ SENSITIVE: [:attributes_interpolated, :attributes_not_interpolated]
860
+ end
861
+
862
+ class QuickResponseSummary
863
+ attr_accessor channels: ::Array[::String]
864
+ attr_accessor content_type: ::String
865
+ attr_accessor created_time: ::Time
866
+ attr_accessor description: ::String
867
+ attr_accessor is_active: bool
868
+ attr_accessor knowledge_base_arn: ::String
869
+ attr_accessor knowledge_base_id: ::String
870
+ attr_accessor last_modified_by: ::String
871
+ attr_accessor last_modified_time: ::Time
872
+ attr_accessor name: ::String
873
+ attr_accessor quick_response_arn: ::String
874
+ attr_accessor quick_response_id: ::String
875
+ attr_accessor status: ("CREATE_IN_PROGRESS" | "CREATE_FAILED" | "CREATED" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETED" | "UPDATE_IN_PROGRESS" | "UPDATE_FAILED")
876
+ attr_accessor tags: ::Hash[::String, ::String]
877
+ SENSITIVE: []
878
+ end
879
+
880
+ class RankingData
881
+ attr_accessor relevance_level: ("HIGH" | "MEDIUM" | "LOW")
882
+ attr_accessor relevance_score: ::Float
883
+ SENSITIVE: []
884
+ end
885
+
886
+ class RecommendationData
887
+ attr_accessor data: Types::DataSummary
888
+ attr_accessor document: Types::Document
889
+ attr_accessor recommendation_id: ::String
890
+ attr_accessor relevance_level: ("HIGH" | "MEDIUM" | "LOW")
891
+ attr_accessor relevance_score: ::Float
892
+ attr_accessor type: ("KNOWLEDGE_CONTENT" | "GENERATIVE_RESPONSE" | "GENERATIVE_ANSWER")
893
+ SENSITIVE: []
894
+ end
895
+
896
+ class RecommendationTrigger
897
+ attr_accessor data: Types::RecommendationTriggerData
898
+ attr_accessor id: ::String
899
+ attr_accessor recommendation_ids: ::Array[::String]
900
+ attr_accessor source: ("ISSUE_DETECTION" | "RULE_EVALUATION" | "OTHER")
901
+ attr_accessor type: ("QUERY" | "GENERATIVE")
902
+ SENSITIVE: []
903
+ end
904
+
905
+ class RecommendationTriggerData
906
+ attr_accessor query: Types::QueryRecommendationTriggerData
907
+ attr_accessor unknown: untyped
908
+ SENSITIVE: []
909
+
910
+ class Query < RecommendationTriggerData
911
+ end
912
+ class Unknown < RecommendationTriggerData
913
+ end
914
+ end
915
+
916
+ class RemoveKnowledgeBaseTemplateUriRequest
917
+ attr_accessor knowledge_base_id: ::String
918
+ SENSITIVE: []
919
+ end
920
+
921
+ class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure
922
+ end
923
+
924
+ class RenderingConfiguration
925
+ attr_accessor template_uri: ::String
926
+ SENSITIVE: []
927
+ end
928
+
929
+ class RequestTimeoutException
930
+ attr_accessor message: ::String
931
+ SENSITIVE: []
932
+ end
933
+
934
+ class ResourceNotFoundException
935
+ attr_accessor message: ::String
936
+ attr_accessor resource_name: ::String
937
+ SENSITIVE: []
938
+ end
939
+
940
+ class ResultData
941
+ attr_accessor data: Types::DataSummary
942
+ attr_accessor document: Types::Document
943
+ attr_accessor relevance_score: ::Float
944
+ attr_accessor result_id: ::String
945
+ attr_accessor type: ("KNOWLEDGE_CONTENT" | "GENERATIVE_ANSWER")
946
+ SENSITIVE: []
947
+ end
948
+
949
+ class SearchContentRequest
950
+ attr_accessor knowledge_base_id: ::String
951
+ attr_accessor max_results: ::Integer
952
+ attr_accessor next_token: ::String
953
+ attr_accessor search_expression: Types::SearchExpression
954
+ SENSITIVE: []
955
+ end
956
+
957
+ class SearchContentResponse
958
+ attr_accessor content_summaries: ::Array[Types::ContentSummary]
959
+ attr_accessor next_token: ::String
960
+ SENSITIVE: []
961
+ end
962
+
963
+ class SearchExpression
964
+ attr_accessor filters: ::Array[Types::Filter]
965
+ SENSITIVE: []
966
+ end
967
+
968
+ class SearchQuickResponsesRequest
969
+ attr_accessor attributes: ::Hash[::String, ::String]
970
+ attr_accessor knowledge_base_id: ::String
971
+ attr_accessor max_results: ::Integer
972
+ attr_accessor next_token: ::String
973
+ attr_accessor search_expression: Types::QuickResponseSearchExpression
974
+ SENSITIVE: [:attributes]
975
+ end
976
+
977
+ class SearchQuickResponsesResponse
978
+ attr_accessor next_token: ::String
979
+ attr_accessor results: ::Array[Types::QuickResponseSearchResultData]
980
+ SENSITIVE: []
981
+ end
982
+
983
+ class SearchSessionsRequest
984
+ attr_accessor assistant_id: ::String
985
+ attr_accessor max_results: ::Integer
986
+ attr_accessor next_token: ::String
987
+ attr_accessor search_expression: Types::SearchExpression
988
+ SENSITIVE: []
989
+ end
990
+
991
+ class SearchSessionsResponse
992
+ attr_accessor next_token: ::String
993
+ attr_accessor session_summaries: ::Array[Types::SessionSummary]
994
+ SENSITIVE: []
995
+ end
996
+
997
+ class ServerSideEncryptionConfiguration
998
+ attr_accessor kms_key_id: ::String
999
+ SENSITIVE: []
1000
+ end
1001
+
1002
+ class ServiceQuotaExceededException
1003
+ attr_accessor message: ::String
1004
+ SENSITIVE: []
1005
+ end
1006
+
1007
+ class SessionData
1008
+ attr_accessor description: ::String
1009
+ attr_accessor integration_configuration: Types::SessionIntegrationConfiguration
1010
+ attr_accessor name: ::String
1011
+ attr_accessor session_arn: ::String
1012
+ attr_accessor session_id: ::String
1013
+ attr_accessor tags: ::Hash[::String, ::String]
1014
+ SENSITIVE: []
1015
+ end
1016
+
1017
+ class SessionIntegrationConfiguration
1018
+ attr_accessor topic_integration_arn: ::String
1019
+ SENSITIVE: []
1020
+ end
1021
+
1022
+ class SessionSummary
1023
+ attr_accessor assistant_arn: ::String
1024
+ attr_accessor assistant_id: ::String
1025
+ attr_accessor session_arn: ::String
1026
+ attr_accessor session_id: ::String
1027
+ SENSITIVE: []
1028
+ end
1029
+
1030
+ class SourceConfiguration
1031
+ attr_accessor app_integrations: Types::AppIntegrationsConfiguration
1032
+ attr_accessor unknown: untyped
1033
+ SENSITIVE: []
1034
+
1035
+ class AppIntegrations < SourceConfiguration
1036
+ end
1037
+ class Unknown < SourceConfiguration
1038
+ end
1039
+ end
1040
+
1041
+ class SourceContentDataDetails
1042
+ attr_accessor id: ::String
1043
+ attr_accessor ranking_data: Types::RankingData
1044
+ attr_accessor text_data: Types::TextData
1045
+ attr_accessor type: ("KNOWLEDGE_CONTENT")
1046
+ SENSITIVE: []
1047
+ end
1048
+
1049
+ class StartContentUploadRequest
1050
+ attr_accessor content_type: ::String
1051
+ attr_accessor knowledge_base_id: ::String
1052
+ attr_accessor presigned_url_time_to_live: ::Integer
1053
+ SENSITIVE: []
1054
+ end
1055
+
1056
+ class StartContentUploadResponse
1057
+ attr_accessor headers_to_include: ::Hash[::String, ::String]
1058
+ attr_accessor upload_id: ::String
1059
+ attr_accessor url: ::String
1060
+ attr_accessor url_expiry: ::Time
1061
+ SENSITIVE: [:url]
1062
+ end
1063
+
1064
+ class StartImportJobRequest
1065
+ attr_accessor client_token: ::String
1066
+ attr_accessor external_source_configuration: Types::ExternalSourceConfiguration
1067
+ attr_accessor import_job_type: ("QUICK_RESPONSES")
1068
+ attr_accessor knowledge_base_id: ::String
1069
+ attr_accessor metadata: ::Hash[::String, ::String]
1070
+ attr_accessor upload_id: ::String
1071
+ SENSITIVE: []
1072
+ end
1073
+
1074
+ class StartImportJobResponse
1075
+ attr_accessor import_job: Types::ImportJobData
1076
+ SENSITIVE: []
1077
+ end
1078
+
1079
+ class TagResourceRequest
1080
+ attr_accessor resource_arn: ::String
1081
+ attr_accessor tags: ::Hash[::String, ::String]
1082
+ SENSITIVE: []
1083
+ end
1084
+
1085
+ class TagResourceResponse < Aws::EmptyStructure
1086
+ end
1087
+
1088
+ class TextData
1089
+ attr_accessor excerpt: Types::DocumentText
1090
+ attr_accessor title: Types::DocumentText
1091
+ SENSITIVE: []
1092
+ end
1093
+
1094
+ class TooManyTagsException
1095
+ attr_accessor message: ::String
1096
+ attr_accessor resource_name: ::String
1097
+ SENSITIVE: []
1098
+ end
1099
+
1100
+ class UntagResourceRequest
1101
+ attr_accessor resource_arn: ::String
1102
+ attr_accessor tag_keys: ::Array[::String]
1103
+ SENSITIVE: []
1104
+ end
1105
+
1106
+ class UntagResourceResponse < Aws::EmptyStructure
1107
+ end
1108
+
1109
+ class UpdateContentRequest
1110
+ attr_accessor content_id: ::String
1111
+ attr_accessor knowledge_base_id: ::String
1112
+ attr_accessor metadata: ::Hash[::String, ::String]
1113
+ attr_accessor override_link_out_uri: ::String
1114
+ attr_accessor remove_override_link_out_uri: bool
1115
+ attr_accessor revision_id: ::String
1116
+ attr_accessor title: ::String
1117
+ attr_accessor upload_id: ::String
1118
+ SENSITIVE: []
1119
+ end
1120
+
1121
+ class UpdateContentResponse
1122
+ attr_accessor content: Types::ContentData
1123
+ SENSITIVE: []
1124
+ end
1125
+
1126
+ class UpdateKnowledgeBaseTemplateUriRequest
1127
+ attr_accessor knowledge_base_id: ::String
1128
+ attr_accessor template_uri: ::String
1129
+ SENSITIVE: []
1130
+ end
1131
+
1132
+ class UpdateKnowledgeBaseTemplateUriResponse
1133
+ attr_accessor knowledge_base: Types::KnowledgeBaseData
1134
+ SENSITIVE: []
1135
+ end
1136
+
1137
+ class UpdateQuickResponseRequest
1138
+ attr_accessor channels: ::Array[::String]
1139
+ attr_accessor content: Types::QuickResponseDataProvider
1140
+ attr_accessor content_type: ::String
1141
+ attr_accessor description: ::String
1142
+ attr_accessor grouping_configuration: Types::GroupingConfiguration
1143
+ attr_accessor is_active: bool
1144
+ attr_accessor knowledge_base_id: ::String
1145
+ attr_accessor language: ::String
1146
+ attr_accessor name: ::String
1147
+ attr_accessor quick_response_id: ::String
1148
+ attr_accessor remove_description: bool
1149
+ attr_accessor remove_grouping_configuration: bool
1150
+ attr_accessor remove_shortcut_key: bool
1151
+ attr_accessor shortcut_key: ::String
1152
+ SENSITIVE: []
1153
+ end
1154
+
1155
+ class UpdateQuickResponseResponse
1156
+ attr_accessor quick_response: Types::QuickResponseData
1157
+ SENSITIVE: []
1158
+ end
1159
+
1160
+ class ValidationException
1161
+ attr_accessor message: ::String
1162
+ SENSITIVE: []
1163
+ end
1164
+ end
1165
+ end