aws-sdk-qconnect 1.4.0 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/client.rbs ADDED
@@ -0,0 +1,762 @@
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
9
+ module QConnect
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?stub_responses: untyped,
52
+ ?token_provider: untyped,
53
+ ?use_dualstack_endpoint: bool,
54
+ ?use_fips_endpoint: bool,
55
+ ?validate_params: bool,
56
+ ?endpoint_provider: untyped,
57
+ ?http_proxy: String,
58
+ ?http_open_timeout: (Float | Integer),
59
+ ?http_read_timeout: (Float | Integer),
60
+ ?http_idle_timeout: (Float | Integer),
61
+ ?http_continue_timeout: (Float | Integer),
62
+ ?ssl_timeout: (Float | Integer | nil),
63
+ ?http_wire_trace: bool,
64
+ ?ssl_verify_peer: bool,
65
+ ?ssl_ca_bundle: String,
66
+ ?ssl_ca_directory: String,
67
+ ?ssl_ca_store: String,
68
+ ?on_chunk_received: Proc,
69
+ ?on_chunk_sent: Proc,
70
+ ?raise_response_errors: bool
71
+ ) -> instance
72
+ | (?Hash[Symbol, untyped]) -> instance
73
+
74
+
75
+ interface _CreateAssistantResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAssistantResponse]
77
+ def assistant: () -> Types::AssistantData
78
+ end
79
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_assistant-instance_method
80
+ def create_assistant: (
81
+ ?client_token: ::String,
82
+ ?description: ::String,
83
+ name: ::String,
84
+ ?server_side_encryption_configuration: {
85
+ kms_key_id: ::String?
86
+ },
87
+ ?tags: Hash[::String, ::String],
88
+ type: ("AGENT")
89
+ ) -> _CreateAssistantResponseSuccess
90
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAssistantResponseSuccess
91
+
92
+ interface _CreateAssistantAssociationResponseSuccess
93
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAssistantAssociationResponse]
94
+ def assistant_association: () -> Types::AssistantAssociationData
95
+ end
96
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_assistant_association-instance_method
97
+ def create_assistant_association: (
98
+ assistant_id: ::String,
99
+ association: {
100
+ knowledge_base_id: ::String?
101
+ },
102
+ association_type: ("KNOWLEDGE_BASE"),
103
+ ?client_token: ::String,
104
+ ?tags: Hash[::String, ::String]
105
+ ) -> _CreateAssistantAssociationResponseSuccess
106
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAssistantAssociationResponseSuccess
107
+
108
+ interface _CreateContentResponseSuccess
109
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateContentResponse]
110
+ def content: () -> Types::ContentData
111
+ end
112
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_content-instance_method
113
+ def create_content: (
114
+ ?client_token: ::String,
115
+ knowledge_base_id: ::String,
116
+ ?metadata: Hash[::String, ::String],
117
+ name: ::String,
118
+ ?override_link_out_uri: ::String,
119
+ ?tags: Hash[::String, ::String],
120
+ ?title: ::String,
121
+ upload_id: ::String
122
+ ) -> _CreateContentResponseSuccess
123
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateContentResponseSuccess
124
+
125
+ interface _CreateKnowledgeBaseResponseSuccess
126
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateKnowledgeBaseResponse]
127
+ def knowledge_base: () -> Types::KnowledgeBaseData
128
+ end
129
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_knowledge_base-instance_method
130
+ def create_knowledge_base: (
131
+ ?client_token: ::String,
132
+ ?description: ::String,
133
+ knowledge_base_type: ("EXTERNAL" | "CUSTOM" | "QUICK_RESPONSES"),
134
+ name: ::String,
135
+ ?rendering_configuration: {
136
+ template_uri: ::String?
137
+ },
138
+ ?server_side_encryption_configuration: {
139
+ kms_key_id: ::String?
140
+ },
141
+ ?source_configuration: {
142
+ app_integrations: {
143
+ app_integration_arn: ::String,
144
+ object_fields: Array[::String]?
145
+ }?
146
+ },
147
+ ?tags: Hash[::String, ::String]
148
+ ) -> _CreateKnowledgeBaseResponseSuccess
149
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKnowledgeBaseResponseSuccess
150
+
151
+ interface _CreateQuickResponseResponseSuccess
152
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateQuickResponseResponse]
153
+ def quick_response: () -> Types::QuickResponseData
154
+ end
155
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_quick_response-instance_method
156
+ def create_quick_response: (
157
+ ?channels: Array[::String],
158
+ ?client_token: ::String,
159
+ content: {
160
+ content: ::String?
161
+ },
162
+ ?content_type: ::String,
163
+ ?description: ::String,
164
+ ?grouping_configuration: {
165
+ criteria: ::String?,
166
+ values: Array[::String]?
167
+ },
168
+ ?is_active: bool,
169
+ knowledge_base_id: ::String,
170
+ ?language: ::String,
171
+ name: ::String,
172
+ ?shortcut_key: ::String,
173
+ ?tags: Hash[::String, ::String]
174
+ ) -> _CreateQuickResponseResponseSuccess
175
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateQuickResponseResponseSuccess
176
+
177
+ interface _CreateSessionResponseSuccess
178
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateSessionResponse]
179
+ def session: () -> Types::SessionData
180
+ end
181
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#create_session-instance_method
182
+ def create_session: (
183
+ assistant_id: ::String,
184
+ ?client_token: ::String,
185
+ ?description: ::String,
186
+ name: ::String,
187
+ ?tag_filter: {
188
+ and_conditions: Array[
189
+ {
190
+ key: ::String,
191
+ value: ::String?
192
+ },
193
+ ]?,
194
+ or_conditions: Array[
195
+ {
196
+ and_conditions: Array[
197
+ {
198
+ key: ::String,
199
+ value: ::String?
200
+ },
201
+ ]?,
202
+ tag_condition: {
203
+ key: ::String,
204
+ value: ::String?
205
+ }?
206
+ },
207
+ ]?,
208
+ tag_condition: {
209
+ key: ::String,
210
+ value: ::String?
211
+ }?
212
+ },
213
+ ?tags: Hash[::String, ::String]
214
+ ) -> _CreateSessionResponseSuccess
215
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSessionResponseSuccess
216
+
217
+ interface _DeleteAssistantResponseSuccess
218
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAssistantResponse]
219
+ end
220
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_assistant-instance_method
221
+ def delete_assistant: (
222
+ assistant_id: ::String
223
+ ) -> _DeleteAssistantResponseSuccess
224
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAssistantResponseSuccess
225
+
226
+ interface _DeleteAssistantAssociationResponseSuccess
227
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAssistantAssociationResponse]
228
+ end
229
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_assistant_association-instance_method
230
+ def delete_assistant_association: (
231
+ assistant_association_id: ::String,
232
+ assistant_id: ::String
233
+ ) -> _DeleteAssistantAssociationResponseSuccess
234
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAssistantAssociationResponseSuccess
235
+
236
+ interface _DeleteContentResponseSuccess
237
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteContentResponse]
238
+ end
239
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_content-instance_method
240
+ def delete_content: (
241
+ content_id: ::String,
242
+ knowledge_base_id: ::String
243
+ ) -> _DeleteContentResponseSuccess
244
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContentResponseSuccess
245
+
246
+ interface _DeleteImportJobResponseSuccess
247
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteImportJobResponse]
248
+ end
249
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_import_job-instance_method
250
+ def delete_import_job: (
251
+ import_job_id: ::String,
252
+ knowledge_base_id: ::String
253
+ ) -> _DeleteImportJobResponseSuccess
254
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteImportJobResponseSuccess
255
+
256
+ interface _DeleteKnowledgeBaseResponseSuccess
257
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteKnowledgeBaseResponse]
258
+ end
259
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_knowledge_base-instance_method
260
+ def delete_knowledge_base: (
261
+ knowledge_base_id: ::String
262
+ ) -> _DeleteKnowledgeBaseResponseSuccess
263
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKnowledgeBaseResponseSuccess
264
+
265
+ interface _DeleteQuickResponseResponseSuccess
266
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteQuickResponseResponse]
267
+ end
268
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_quick_response-instance_method
269
+ def delete_quick_response: (
270
+ knowledge_base_id: ::String,
271
+ quick_response_id: ::String
272
+ ) -> _DeleteQuickResponseResponseSuccess
273
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteQuickResponseResponseSuccess
274
+
275
+ interface _GetAssistantResponseSuccess
276
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAssistantResponse]
277
+ def assistant: () -> Types::AssistantData
278
+ end
279
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_assistant-instance_method
280
+ def get_assistant: (
281
+ assistant_id: ::String
282
+ ) -> _GetAssistantResponseSuccess
283
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAssistantResponseSuccess
284
+
285
+ interface _GetAssistantAssociationResponseSuccess
286
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAssistantAssociationResponse]
287
+ def assistant_association: () -> Types::AssistantAssociationData
288
+ end
289
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_assistant_association-instance_method
290
+ def get_assistant_association: (
291
+ assistant_association_id: ::String,
292
+ assistant_id: ::String
293
+ ) -> _GetAssistantAssociationResponseSuccess
294
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAssistantAssociationResponseSuccess
295
+
296
+ interface _GetContentResponseSuccess
297
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetContentResponse]
298
+ def content: () -> Types::ContentData
299
+ end
300
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_content-instance_method
301
+ def get_content: (
302
+ content_id: ::String,
303
+ knowledge_base_id: ::String
304
+ ) -> _GetContentResponseSuccess
305
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentResponseSuccess
306
+
307
+ interface _GetContentSummaryResponseSuccess
308
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetContentSummaryResponse]
309
+ def content_summary: () -> Types::ContentSummary
310
+ end
311
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_content_summary-instance_method
312
+ def get_content_summary: (
313
+ content_id: ::String,
314
+ knowledge_base_id: ::String
315
+ ) -> _GetContentSummaryResponseSuccess
316
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentSummaryResponseSuccess
317
+
318
+ interface _GetImportJobResponseSuccess
319
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetImportJobResponse]
320
+ def import_job: () -> Types::ImportJobData
321
+ end
322
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_import_job-instance_method
323
+ def get_import_job: (
324
+ import_job_id: ::String,
325
+ knowledge_base_id: ::String
326
+ ) -> _GetImportJobResponseSuccess
327
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetImportJobResponseSuccess
328
+
329
+ interface _GetKnowledgeBaseResponseSuccess
330
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetKnowledgeBaseResponse]
331
+ def knowledge_base: () -> Types::KnowledgeBaseData
332
+ end
333
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_knowledge_base-instance_method
334
+ def get_knowledge_base: (
335
+ knowledge_base_id: ::String
336
+ ) -> _GetKnowledgeBaseResponseSuccess
337
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKnowledgeBaseResponseSuccess
338
+
339
+ interface _GetQuickResponseResponseSuccess
340
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetQuickResponseResponse]
341
+ def quick_response: () -> Types::QuickResponseData
342
+ end
343
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_quick_response-instance_method
344
+ def get_quick_response: (
345
+ knowledge_base_id: ::String,
346
+ quick_response_id: ::String
347
+ ) -> _GetQuickResponseResponseSuccess
348
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQuickResponseResponseSuccess
349
+
350
+ interface _GetRecommendationsResponseSuccess
351
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetRecommendationsResponse]
352
+ def recommendations: () -> ::Array[Types::RecommendationData]
353
+ def triggers: () -> ::Array[Types::RecommendationTrigger]
354
+ end
355
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_recommendations-instance_method
356
+ def get_recommendations: (
357
+ assistant_id: ::String,
358
+ ?max_results: ::Integer,
359
+ session_id: ::String,
360
+ ?wait_time_seconds: ::Integer
361
+ ) -> _GetRecommendationsResponseSuccess
362
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecommendationsResponseSuccess
363
+
364
+ interface _GetSessionResponseSuccess
365
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetSessionResponse]
366
+ def session: () -> Types::SessionData
367
+ end
368
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_session-instance_method
369
+ def get_session: (
370
+ assistant_id: ::String,
371
+ session_id: ::String
372
+ ) -> _GetSessionResponseSuccess
373
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSessionResponseSuccess
374
+
375
+ interface _ListAssistantAssociationsResponseSuccess
376
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAssistantAssociationsResponse]
377
+ def assistant_association_summaries: () -> ::Array[Types::AssistantAssociationSummary]
378
+ def next_token: () -> ::String
379
+ end
380
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistant_associations-instance_method
381
+ def list_assistant_associations: (
382
+ assistant_id: ::String,
383
+ ?max_results: ::Integer,
384
+ ?next_token: ::String
385
+ ) -> _ListAssistantAssociationsResponseSuccess
386
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantAssociationsResponseSuccess
387
+
388
+ interface _ListAssistantsResponseSuccess
389
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAssistantsResponse]
390
+ def assistant_summaries: () -> ::Array[Types::AssistantSummary]
391
+ def next_token: () -> ::String
392
+ end
393
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistants-instance_method
394
+ def list_assistants: (
395
+ ?max_results: ::Integer,
396
+ ?next_token: ::String
397
+ ) -> _ListAssistantsResponseSuccess
398
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantsResponseSuccess
399
+
400
+ interface _ListContentsResponseSuccess
401
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListContentsResponse]
402
+ def content_summaries: () -> ::Array[Types::ContentSummary]
403
+ def next_token: () -> ::String
404
+ end
405
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_contents-instance_method
406
+ def list_contents: (
407
+ knowledge_base_id: ::String,
408
+ ?max_results: ::Integer,
409
+ ?next_token: ::String
410
+ ) -> _ListContentsResponseSuccess
411
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContentsResponseSuccess
412
+
413
+ interface _ListImportJobsResponseSuccess
414
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListImportJobsResponse]
415
+ def import_job_summaries: () -> ::Array[Types::ImportJobSummary]
416
+ def next_token: () -> ::String
417
+ end
418
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_import_jobs-instance_method
419
+ def list_import_jobs: (
420
+ knowledge_base_id: ::String,
421
+ ?max_results: ::Integer,
422
+ ?next_token: ::String
423
+ ) -> _ListImportJobsResponseSuccess
424
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListImportJobsResponseSuccess
425
+
426
+ interface _ListKnowledgeBasesResponseSuccess
427
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListKnowledgeBasesResponse]
428
+ def knowledge_base_summaries: () -> ::Array[Types::KnowledgeBaseSummary]
429
+ def next_token: () -> ::String
430
+ end
431
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_knowledge_bases-instance_method
432
+ def list_knowledge_bases: (
433
+ ?max_results: ::Integer,
434
+ ?next_token: ::String
435
+ ) -> _ListKnowledgeBasesResponseSuccess
436
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKnowledgeBasesResponseSuccess
437
+
438
+ interface _ListQuickResponsesResponseSuccess
439
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListQuickResponsesResponse]
440
+ def next_token: () -> ::String
441
+ def quick_response_summaries: () -> ::Array[Types::QuickResponseSummary]
442
+ end
443
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_quick_responses-instance_method
444
+ def list_quick_responses: (
445
+ knowledge_base_id: ::String,
446
+ ?max_results: ::Integer,
447
+ ?next_token: ::String
448
+ ) -> _ListQuickResponsesResponseSuccess
449
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQuickResponsesResponseSuccess
450
+
451
+ interface _ListTagsForResourceResponseSuccess
452
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
453
+ def tags: () -> ::Hash[::String, ::String]
454
+ end
455
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_tags_for_resource-instance_method
456
+ def list_tags_for_resource: (
457
+ resource_arn: ::String
458
+ ) -> _ListTagsForResourceResponseSuccess
459
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
460
+
461
+ interface _NotifyRecommendationsReceivedResponseSuccess
462
+ include ::Seahorse::Client::_ResponseSuccess[Types::NotifyRecommendationsReceivedResponse]
463
+ def errors: () -> ::Array[Types::NotifyRecommendationsReceivedError]
464
+ def recommendation_ids: () -> ::Array[::String]
465
+ end
466
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#notify_recommendations_received-instance_method
467
+ def notify_recommendations_received: (
468
+ assistant_id: ::String,
469
+ recommendation_ids: Array[::String],
470
+ session_id: ::String
471
+ ) -> _NotifyRecommendationsReceivedResponseSuccess
472
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _NotifyRecommendationsReceivedResponseSuccess
473
+
474
+ interface _PutFeedbackResponseSuccess
475
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutFeedbackResponse]
476
+ def assistant_arn: () -> ::String
477
+ def assistant_id: () -> ::String
478
+ def content_feedback: () -> Types::ContentFeedbackData
479
+ def target_id: () -> ::String
480
+ def target_type: () -> ("RECOMMENDATION" | "RESULT")
481
+ end
482
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#put_feedback-instance_method
483
+ def put_feedback: (
484
+ assistant_id: ::String,
485
+ content_feedback: {
486
+ generative_content_feedback_data: {
487
+ relevance: ("HELPFUL" | "NOT_HELPFUL")
488
+ }?
489
+ },
490
+ target_id: ::String,
491
+ target_type: ("RECOMMENDATION" | "RESULT")
492
+ ) -> _PutFeedbackResponseSuccess
493
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutFeedbackResponseSuccess
494
+
495
+ interface _QueryAssistantResponseSuccess
496
+ include ::Seahorse::Client::_ResponseSuccess[Types::QueryAssistantResponse]
497
+ def next_token: () -> ::String
498
+ def results: () -> ::Array[Types::ResultData]
499
+ end
500
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#query_assistant-instance_method
501
+ def query_assistant: (
502
+ assistant_id: ::String,
503
+ ?max_results: ::Integer,
504
+ ?next_token: ::String,
505
+ ?query_condition: Array[
506
+ {
507
+ single: {
508
+ comparator: ("EQUALS"),
509
+ field: ("RESULT_TYPE"),
510
+ value: ::String
511
+ }?
512
+ },
513
+ ],
514
+ query_text: ::String,
515
+ ?session_id: ::String
516
+ ) -> _QueryAssistantResponseSuccess
517
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryAssistantResponseSuccess
518
+
519
+ interface _RemoveKnowledgeBaseTemplateUriResponseSuccess
520
+ include ::Seahorse::Client::_ResponseSuccess[Types::RemoveKnowledgeBaseTemplateUriResponse]
521
+ end
522
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#remove_knowledge_base_template_uri-instance_method
523
+ def remove_knowledge_base_template_uri: (
524
+ knowledge_base_id: ::String
525
+ ) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
526
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
527
+
528
+ interface _SearchContentResponseSuccess
529
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchContentResponse]
530
+ def content_summaries: () -> ::Array[Types::ContentSummary]
531
+ def next_token: () -> ::String
532
+ end
533
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_content-instance_method
534
+ def search_content: (
535
+ knowledge_base_id: ::String,
536
+ ?max_results: ::Integer,
537
+ ?next_token: ::String,
538
+ search_expression: {
539
+ filters: Array[
540
+ {
541
+ field: ("NAME"),
542
+ operator: ("EQUALS"),
543
+ value: ::String
544
+ },
545
+ ]
546
+ }
547
+ ) -> _SearchContentResponseSuccess
548
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchContentResponseSuccess
549
+
550
+ interface _SearchQuickResponsesResponseSuccess
551
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchQuickResponsesResponse]
552
+ def next_token: () -> ::String
553
+ def results: () -> ::Array[Types::QuickResponseSearchResultData]
554
+ end
555
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_quick_responses-instance_method
556
+ def search_quick_responses: (
557
+ ?attributes: Hash[::String, ::String],
558
+ knowledge_base_id: ::String,
559
+ ?max_results: ::Integer,
560
+ ?next_token: ::String,
561
+ search_expression: {
562
+ filters: Array[
563
+ {
564
+ include_no_existence: bool?,
565
+ name: ::String,
566
+ operator: ("EQUALS" | "PREFIX"),
567
+ values: Array[::String]?
568
+ },
569
+ ]?,
570
+ order_on_field: {
571
+ name: ::String,
572
+ order: ("ASC" | "DESC")?
573
+ }?,
574
+ queries: Array[
575
+ {
576
+ allow_fuzziness: bool?,
577
+ name: ::String,
578
+ operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
579
+ priority: ("HIGH" | "MEDIUM" | "LOW")?,
580
+ values: Array[::String]
581
+ },
582
+ ]?
583
+ }
584
+ ) -> _SearchQuickResponsesResponseSuccess
585
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchQuickResponsesResponseSuccess
586
+
587
+ interface _SearchSessionsResponseSuccess
588
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchSessionsResponse]
589
+ def next_token: () -> ::String
590
+ def session_summaries: () -> ::Array[Types::SessionSummary]
591
+ end
592
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_sessions-instance_method
593
+ def search_sessions: (
594
+ assistant_id: ::String,
595
+ ?max_results: ::Integer,
596
+ ?next_token: ::String,
597
+ search_expression: {
598
+ filters: Array[
599
+ {
600
+ field: ("NAME"),
601
+ operator: ("EQUALS"),
602
+ value: ::String
603
+ },
604
+ ]
605
+ }
606
+ ) -> _SearchSessionsResponseSuccess
607
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchSessionsResponseSuccess
608
+
609
+ interface _StartContentUploadResponseSuccess
610
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartContentUploadResponse]
611
+ def headers_to_include: () -> ::Hash[::String, ::String]
612
+ def upload_id: () -> ::String
613
+ def url: () -> ::String
614
+ def url_expiry: () -> ::Time
615
+ end
616
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_content_upload-instance_method
617
+ def start_content_upload: (
618
+ content_type: ::String,
619
+ knowledge_base_id: ::String,
620
+ ?presigned_url_time_to_live: ::Integer
621
+ ) -> _StartContentUploadResponseSuccess
622
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContentUploadResponseSuccess
623
+
624
+ interface _StartImportJobResponseSuccess
625
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartImportJobResponse]
626
+ def import_job: () -> Types::ImportJobData
627
+ end
628
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_import_job-instance_method
629
+ def start_import_job: (
630
+ ?client_token: ::String,
631
+ ?external_source_configuration: {
632
+ configuration: {
633
+ connect_configuration: {
634
+ instance_id: ::String?
635
+ }?
636
+ },
637
+ source: ("AMAZON_CONNECT")
638
+ },
639
+ import_job_type: ("QUICK_RESPONSES"),
640
+ knowledge_base_id: ::String,
641
+ ?metadata: Hash[::String, ::String],
642
+ upload_id: ::String
643
+ ) -> _StartImportJobResponseSuccess
644
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartImportJobResponseSuccess
645
+
646
+ interface _TagResourceResponseSuccess
647
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
648
+ end
649
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#tag_resource-instance_method
650
+ def tag_resource: (
651
+ resource_arn: ::String,
652
+ tags: Hash[::String, ::String]
653
+ ) -> _TagResourceResponseSuccess
654
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
655
+
656
+ interface _UntagResourceResponseSuccess
657
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
658
+ end
659
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#untag_resource-instance_method
660
+ def untag_resource: (
661
+ resource_arn: ::String,
662
+ tag_keys: Array[::String]
663
+ ) -> _UntagResourceResponseSuccess
664
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
665
+
666
+ interface _UpdateContentResponseSuccess
667
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateContentResponse]
668
+ def content: () -> Types::ContentData
669
+ end
670
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_content-instance_method
671
+ def update_content: (
672
+ content_id: ::String,
673
+ knowledge_base_id: ::String,
674
+ ?metadata: Hash[::String, ::String],
675
+ ?override_link_out_uri: ::String,
676
+ ?remove_override_link_out_uri: bool,
677
+ ?revision_id: ::String,
678
+ ?title: ::String,
679
+ ?upload_id: ::String
680
+ ) -> _UpdateContentResponseSuccess
681
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContentResponseSuccess
682
+
683
+ interface _UpdateKnowledgeBaseTemplateUriResponseSuccess
684
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateKnowledgeBaseTemplateUriResponse]
685
+ def knowledge_base: () -> Types::KnowledgeBaseData
686
+ end
687
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_knowledge_base_template_uri-instance_method
688
+ def update_knowledge_base_template_uri: (
689
+ knowledge_base_id: ::String,
690
+ template_uri: ::String
691
+ ) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
692
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
693
+
694
+ interface _UpdateQuickResponseResponseSuccess
695
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateQuickResponseResponse]
696
+ def quick_response: () -> Types::QuickResponseData
697
+ end
698
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_quick_response-instance_method
699
+ def update_quick_response: (
700
+ ?channels: Array[::String],
701
+ ?content: {
702
+ content: ::String?
703
+ },
704
+ ?content_type: ::String,
705
+ ?description: ::String,
706
+ ?grouping_configuration: {
707
+ criteria: ::String?,
708
+ values: Array[::String]?
709
+ },
710
+ ?is_active: bool,
711
+ knowledge_base_id: ::String,
712
+ ?language: ::String,
713
+ ?name: ::String,
714
+ quick_response_id: ::String,
715
+ ?remove_description: bool,
716
+ ?remove_grouping_configuration: bool,
717
+ ?remove_shortcut_key: bool,
718
+ ?shortcut_key: ::String
719
+ ) -> _UpdateQuickResponseResponseSuccess
720
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateQuickResponseResponseSuccess
721
+
722
+ interface _UpdateSessionResponseSuccess
723
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateSessionResponse]
724
+ def session: () -> Types::SessionData
725
+ end
726
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_session-instance_method
727
+ def update_session: (
728
+ assistant_id: ::String,
729
+ ?description: ::String,
730
+ session_id: ::String,
731
+ ?tag_filter: {
732
+ and_conditions: Array[
733
+ {
734
+ key: ::String,
735
+ value: ::String?
736
+ },
737
+ ]?,
738
+ or_conditions: Array[
739
+ {
740
+ and_conditions: Array[
741
+ {
742
+ key: ::String,
743
+ value: ::String?
744
+ },
745
+ ]?,
746
+ tag_condition: {
747
+ key: ::String,
748
+ value: ::String?
749
+ }?
750
+ },
751
+ ]?,
752
+ tag_condition: {
753
+ key: ::String,
754
+ value: ::String?
755
+ }?
756
+ }
757
+ ) -> _UpdateSessionResponseSuccess
758
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateSessionResponseSuccess
759
+ end
760
+ end
761
+ end
762
+