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/client.rbs ADDED
@@ -0,0 +1,698 @@
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
+ ?tags: Hash[::String, ::String]
188
+ ) -> _CreateSessionResponseSuccess
189
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateSessionResponseSuccess
190
+
191
+ interface _DeleteAssistantResponseSuccess
192
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAssistantResponse]
193
+ end
194
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_assistant-instance_method
195
+ def delete_assistant: (
196
+ assistant_id: ::String
197
+ ) -> _DeleteAssistantResponseSuccess
198
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAssistantResponseSuccess
199
+
200
+ interface _DeleteAssistantAssociationResponseSuccess
201
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAssistantAssociationResponse]
202
+ end
203
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_assistant_association-instance_method
204
+ def delete_assistant_association: (
205
+ assistant_association_id: ::String,
206
+ assistant_id: ::String
207
+ ) -> _DeleteAssistantAssociationResponseSuccess
208
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAssistantAssociationResponseSuccess
209
+
210
+ interface _DeleteContentResponseSuccess
211
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteContentResponse]
212
+ end
213
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_content-instance_method
214
+ def delete_content: (
215
+ content_id: ::String,
216
+ knowledge_base_id: ::String
217
+ ) -> _DeleteContentResponseSuccess
218
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteContentResponseSuccess
219
+
220
+ interface _DeleteImportJobResponseSuccess
221
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteImportJobResponse]
222
+ end
223
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_import_job-instance_method
224
+ def delete_import_job: (
225
+ import_job_id: ::String,
226
+ knowledge_base_id: ::String
227
+ ) -> _DeleteImportJobResponseSuccess
228
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteImportJobResponseSuccess
229
+
230
+ interface _DeleteKnowledgeBaseResponseSuccess
231
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteKnowledgeBaseResponse]
232
+ end
233
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_knowledge_base-instance_method
234
+ def delete_knowledge_base: (
235
+ knowledge_base_id: ::String
236
+ ) -> _DeleteKnowledgeBaseResponseSuccess
237
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKnowledgeBaseResponseSuccess
238
+
239
+ interface _DeleteQuickResponseResponseSuccess
240
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteQuickResponseResponse]
241
+ end
242
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#delete_quick_response-instance_method
243
+ def delete_quick_response: (
244
+ knowledge_base_id: ::String,
245
+ quick_response_id: ::String
246
+ ) -> _DeleteQuickResponseResponseSuccess
247
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteQuickResponseResponseSuccess
248
+
249
+ interface _GetAssistantResponseSuccess
250
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAssistantResponse]
251
+ def assistant: () -> Types::AssistantData
252
+ end
253
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_assistant-instance_method
254
+ def get_assistant: (
255
+ assistant_id: ::String
256
+ ) -> _GetAssistantResponseSuccess
257
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAssistantResponseSuccess
258
+
259
+ interface _GetAssistantAssociationResponseSuccess
260
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAssistantAssociationResponse]
261
+ def assistant_association: () -> Types::AssistantAssociationData
262
+ end
263
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_assistant_association-instance_method
264
+ def get_assistant_association: (
265
+ assistant_association_id: ::String,
266
+ assistant_id: ::String
267
+ ) -> _GetAssistantAssociationResponseSuccess
268
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAssistantAssociationResponseSuccess
269
+
270
+ interface _GetContentResponseSuccess
271
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetContentResponse]
272
+ def content: () -> Types::ContentData
273
+ end
274
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_content-instance_method
275
+ def get_content: (
276
+ content_id: ::String,
277
+ knowledge_base_id: ::String
278
+ ) -> _GetContentResponseSuccess
279
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentResponseSuccess
280
+
281
+ interface _GetContentSummaryResponseSuccess
282
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetContentSummaryResponse]
283
+ def content_summary: () -> Types::ContentSummary
284
+ end
285
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_content_summary-instance_method
286
+ def get_content_summary: (
287
+ content_id: ::String,
288
+ knowledge_base_id: ::String
289
+ ) -> _GetContentSummaryResponseSuccess
290
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentSummaryResponseSuccess
291
+
292
+ interface _GetImportJobResponseSuccess
293
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetImportJobResponse]
294
+ def import_job: () -> Types::ImportJobData
295
+ end
296
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_import_job-instance_method
297
+ def get_import_job: (
298
+ import_job_id: ::String,
299
+ knowledge_base_id: ::String
300
+ ) -> _GetImportJobResponseSuccess
301
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetImportJobResponseSuccess
302
+
303
+ interface _GetKnowledgeBaseResponseSuccess
304
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetKnowledgeBaseResponse]
305
+ def knowledge_base: () -> Types::KnowledgeBaseData
306
+ end
307
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_knowledge_base-instance_method
308
+ def get_knowledge_base: (
309
+ knowledge_base_id: ::String
310
+ ) -> _GetKnowledgeBaseResponseSuccess
311
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKnowledgeBaseResponseSuccess
312
+
313
+ interface _GetQuickResponseResponseSuccess
314
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetQuickResponseResponse]
315
+ def quick_response: () -> Types::QuickResponseData
316
+ end
317
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_quick_response-instance_method
318
+ def get_quick_response: (
319
+ knowledge_base_id: ::String,
320
+ quick_response_id: ::String
321
+ ) -> _GetQuickResponseResponseSuccess
322
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetQuickResponseResponseSuccess
323
+
324
+ interface _GetRecommendationsResponseSuccess
325
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetRecommendationsResponse]
326
+ def recommendations: () -> ::Array[Types::RecommendationData]
327
+ def triggers: () -> ::Array[Types::RecommendationTrigger]
328
+ end
329
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_recommendations-instance_method
330
+ def get_recommendations: (
331
+ assistant_id: ::String,
332
+ ?max_results: ::Integer,
333
+ session_id: ::String,
334
+ ?wait_time_seconds: ::Integer
335
+ ) -> _GetRecommendationsResponseSuccess
336
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetRecommendationsResponseSuccess
337
+
338
+ interface _GetSessionResponseSuccess
339
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetSessionResponse]
340
+ def session: () -> Types::SessionData
341
+ end
342
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#get_session-instance_method
343
+ def get_session: (
344
+ assistant_id: ::String,
345
+ session_id: ::String
346
+ ) -> _GetSessionResponseSuccess
347
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSessionResponseSuccess
348
+
349
+ interface _ListAssistantAssociationsResponseSuccess
350
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAssistantAssociationsResponse]
351
+ def assistant_association_summaries: () -> ::Array[Types::AssistantAssociationSummary]
352
+ def next_token: () -> ::String
353
+ end
354
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistant_associations-instance_method
355
+ def list_assistant_associations: (
356
+ assistant_id: ::String,
357
+ ?max_results: ::Integer,
358
+ ?next_token: ::String
359
+ ) -> _ListAssistantAssociationsResponseSuccess
360
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantAssociationsResponseSuccess
361
+
362
+ interface _ListAssistantsResponseSuccess
363
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAssistantsResponse]
364
+ def assistant_summaries: () -> ::Array[Types::AssistantSummary]
365
+ def next_token: () -> ::String
366
+ end
367
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_assistants-instance_method
368
+ def list_assistants: (
369
+ ?max_results: ::Integer,
370
+ ?next_token: ::String
371
+ ) -> _ListAssistantsResponseSuccess
372
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAssistantsResponseSuccess
373
+
374
+ interface _ListContentsResponseSuccess
375
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListContentsResponse]
376
+ def content_summaries: () -> ::Array[Types::ContentSummary]
377
+ def next_token: () -> ::String
378
+ end
379
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_contents-instance_method
380
+ def list_contents: (
381
+ knowledge_base_id: ::String,
382
+ ?max_results: ::Integer,
383
+ ?next_token: ::String
384
+ ) -> _ListContentsResponseSuccess
385
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListContentsResponseSuccess
386
+
387
+ interface _ListImportJobsResponseSuccess
388
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListImportJobsResponse]
389
+ def import_job_summaries: () -> ::Array[Types::ImportJobSummary]
390
+ def next_token: () -> ::String
391
+ end
392
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_import_jobs-instance_method
393
+ def list_import_jobs: (
394
+ knowledge_base_id: ::String,
395
+ ?max_results: ::Integer,
396
+ ?next_token: ::String
397
+ ) -> _ListImportJobsResponseSuccess
398
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListImportJobsResponseSuccess
399
+
400
+ interface _ListKnowledgeBasesResponseSuccess
401
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListKnowledgeBasesResponse]
402
+ def knowledge_base_summaries: () -> ::Array[Types::KnowledgeBaseSummary]
403
+ def next_token: () -> ::String
404
+ end
405
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_knowledge_bases-instance_method
406
+ def list_knowledge_bases: (
407
+ ?max_results: ::Integer,
408
+ ?next_token: ::String
409
+ ) -> _ListKnowledgeBasesResponseSuccess
410
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKnowledgeBasesResponseSuccess
411
+
412
+ interface _ListQuickResponsesResponseSuccess
413
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListQuickResponsesResponse]
414
+ def next_token: () -> ::String
415
+ def quick_response_summaries: () -> ::Array[Types::QuickResponseSummary]
416
+ end
417
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_quick_responses-instance_method
418
+ def list_quick_responses: (
419
+ knowledge_base_id: ::String,
420
+ ?max_results: ::Integer,
421
+ ?next_token: ::String
422
+ ) -> _ListQuickResponsesResponseSuccess
423
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListQuickResponsesResponseSuccess
424
+
425
+ interface _ListTagsForResourceResponseSuccess
426
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
427
+ def tags: () -> ::Hash[::String, ::String]
428
+ end
429
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#list_tags_for_resource-instance_method
430
+ def list_tags_for_resource: (
431
+ resource_arn: ::String
432
+ ) -> _ListTagsForResourceResponseSuccess
433
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
434
+
435
+ interface _NotifyRecommendationsReceivedResponseSuccess
436
+ include ::Seahorse::Client::_ResponseSuccess[Types::NotifyRecommendationsReceivedResponse]
437
+ def errors: () -> ::Array[Types::NotifyRecommendationsReceivedError]
438
+ def recommendation_ids: () -> ::Array[::String]
439
+ end
440
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#notify_recommendations_received-instance_method
441
+ def notify_recommendations_received: (
442
+ assistant_id: ::String,
443
+ recommendation_ids: Array[::String],
444
+ session_id: ::String
445
+ ) -> _NotifyRecommendationsReceivedResponseSuccess
446
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _NotifyRecommendationsReceivedResponseSuccess
447
+
448
+ interface _PutFeedbackResponseSuccess
449
+ include ::Seahorse::Client::_ResponseSuccess[Types::PutFeedbackResponse]
450
+ def assistant_arn: () -> ::String
451
+ def assistant_id: () -> ::String
452
+ def content_feedback: () -> Types::ContentFeedbackData
453
+ def target_id: () -> ::String
454
+ def target_type: () -> ("RECOMMENDATION" | "RESULT")
455
+ end
456
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#put_feedback-instance_method
457
+ def put_feedback: (
458
+ assistant_id: ::String,
459
+ content_feedback: {
460
+ generative_content_feedback_data: {
461
+ relevance: ("HELPFUL" | "NOT_HELPFUL")
462
+ }?
463
+ },
464
+ target_id: ::String,
465
+ target_type: ("RECOMMENDATION" | "RESULT")
466
+ ) -> _PutFeedbackResponseSuccess
467
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutFeedbackResponseSuccess
468
+
469
+ interface _QueryAssistantResponseSuccess
470
+ include ::Seahorse::Client::_ResponseSuccess[Types::QueryAssistantResponse]
471
+ def next_token: () -> ::String
472
+ def results: () -> ::Array[Types::ResultData]
473
+ end
474
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#query_assistant-instance_method
475
+ def query_assistant: (
476
+ assistant_id: ::String,
477
+ ?max_results: ::Integer,
478
+ ?next_token: ::String,
479
+ ?query_condition: Array[
480
+ {
481
+ single: {
482
+ comparator: ("EQUALS"),
483
+ field: ("RESULT_TYPE"),
484
+ value: ::String
485
+ }?
486
+ },
487
+ ],
488
+ query_text: ::String,
489
+ ?session_id: ::String
490
+ ) -> _QueryAssistantResponseSuccess
491
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _QueryAssistantResponseSuccess
492
+
493
+ interface _RemoveKnowledgeBaseTemplateUriResponseSuccess
494
+ include ::Seahorse::Client::_ResponseSuccess[Types::RemoveKnowledgeBaseTemplateUriResponse]
495
+ end
496
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#remove_knowledge_base_template_uri-instance_method
497
+ def remove_knowledge_base_template_uri: (
498
+ knowledge_base_id: ::String
499
+ ) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
500
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RemoveKnowledgeBaseTemplateUriResponseSuccess
501
+
502
+ interface _SearchContentResponseSuccess
503
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchContentResponse]
504
+ def content_summaries: () -> ::Array[Types::ContentSummary]
505
+ def next_token: () -> ::String
506
+ end
507
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_content-instance_method
508
+ def search_content: (
509
+ knowledge_base_id: ::String,
510
+ ?max_results: ::Integer,
511
+ ?next_token: ::String,
512
+ search_expression: {
513
+ filters: Array[
514
+ {
515
+ field: ("NAME"),
516
+ operator: ("EQUALS"),
517
+ value: ::String
518
+ },
519
+ ]
520
+ }
521
+ ) -> _SearchContentResponseSuccess
522
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchContentResponseSuccess
523
+
524
+ interface _SearchQuickResponsesResponseSuccess
525
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchQuickResponsesResponse]
526
+ def next_token: () -> ::String
527
+ def results: () -> ::Array[Types::QuickResponseSearchResultData]
528
+ end
529
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_quick_responses-instance_method
530
+ def search_quick_responses: (
531
+ ?attributes: Hash[::String, ::String],
532
+ knowledge_base_id: ::String,
533
+ ?max_results: ::Integer,
534
+ ?next_token: ::String,
535
+ search_expression: {
536
+ filters: Array[
537
+ {
538
+ include_no_existence: bool?,
539
+ name: ::String,
540
+ operator: ("EQUALS" | "PREFIX"),
541
+ values: Array[::String]?
542
+ },
543
+ ]?,
544
+ order_on_field: {
545
+ name: ::String,
546
+ order: ("ASC" | "DESC")?
547
+ }?,
548
+ queries: Array[
549
+ {
550
+ allow_fuzziness: bool?,
551
+ name: ::String,
552
+ operator: ("CONTAINS" | "CONTAINS_AND_PREFIX"),
553
+ priority: ("HIGH" | "MEDIUM" | "LOW")?,
554
+ values: Array[::String]
555
+ },
556
+ ]?
557
+ }
558
+ ) -> _SearchQuickResponsesResponseSuccess
559
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchQuickResponsesResponseSuccess
560
+
561
+ interface _SearchSessionsResponseSuccess
562
+ include ::Seahorse::Client::_ResponseSuccess[Types::SearchSessionsResponse]
563
+ def next_token: () -> ::String
564
+ def session_summaries: () -> ::Array[Types::SessionSummary]
565
+ end
566
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#search_sessions-instance_method
567
+ def search_sessions: (
568
+ assistant_id: ::String,
569
+ ?max_results: ::Integer,
570
+ ?next_token: ::String,
571
+ search_expression: {
572
+ filters: Array[
573
+ {
574
+ field: ("NAME"),
575
+ operator: ("EQUALS"),
576
+ value: ::String
577
+ },
578
+ ]
579
+ }
580
+ ) -> _SearchSessionsResponseSuccess
581
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchSessionsResponseSuccess
582
+
583
+ interface _StartContentUploadResponseSuccess
584
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartContentUploadResponse]
585
+ def headers_to_include: () -> ::Hash[::String, ::String]
586
+ def upload_id: () -> ::String
587
+ def url: () -> ::String
588
+ def url_expiry: () -> ::Time
589
+ end
590
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_content_upload-instance_method
591
+ def start_content_upload: (
592
+ content_type: ::String,
593
+ knowledge_base_id: ::String,
594
+ ?presigned_url_time_to_live: ::Integer
595
+ ) -> _StartContentUploadResponseSuccess
596
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContentUploadResponseSuccess
597
+
598
+ interface _StartImportJobResponseSuccess
599
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartImportJobResponse]
600
+ def import_job: () -> Types::ImportJobData
601
+ end
602
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#start_import_job-instance_method
603
+ def start_import_job: (
604
+ ?client_token: ::String,
605
+ ?external_source_configuration: {
606
+ configuration: {
607
+ connect_configuration: {
608
+ instance_id: ::String?
609
+ }?
610
+ },
611
+ source: ("AMAZON_CONNECT")
612
+ },
613
+ import_job_type: ("QUICK_RESPONSES"),
614
+ knowledge_base_id: ::String,
615
+ ?metadata: Hash[::String, ::String],
616
+ upload_id: ::String
617
+ ) -> _StartImportJobResponseSuccess
618
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartImportJobResponseSuccess
619
+
620
+ interface _TagResourceResponseSuccess
621
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
622
+ end
623
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#tag_resource-instance_method
624
+ def tag_resource: (
625
+ resource_arn: ::String,
626
+ tags: Hash[::String, ::String]
627
+ ) -> _TagResourceResponseSuccess
628
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
629
+
630
+ interface _UntagResourceResponseSuccess
631
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
632
+ end
633
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#untag_resource-instance_method
634
+ def untag_resource: (
635
+ resource_arn: ::String,
636
+ tag_keys: Array[::String]
637
+ ) -> _UntagResourceResponseSuccess
638
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
639
+
640
+ interface _UpdateContentResponseSuccess
641
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateContentResponse]
642
+ def content: () -> Types::ContentData
643
+ end
644
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_content-instance_method
645
+ def update_content: (
646
+ content_id: ::String,
647
+ knowledge_base_id: ::String,
648
+ ?metadata: Hash[::String, ::String],
649
+ ?override_link_out_uri: ::String,
650
+ ?remove_override_link_out_uri: bool,
651
+ ?revision_id: ::String,
652
+ ?title: ::String,
653
+ ?upload_id: ::String
654
+ ) -> _UpdateContentResponseSuccess
655
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateContentResponseSuccess
656
+
657
+ interface _UpdateKnowledgeBaseTemplateUriResponseSuccess
658
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateKnowledgeBaseTemplateUriResponse]
659
+ def knowledge_base: () -> Types::KnowledgeBaseData
660
+ end
661
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_knowledge_base_template_uri-instance_method
662
+ def update_knowledge_base_template_uri: (
663
+ knowledge_base_id: ::String,
664
+ template_uri: ::String
665
+ ) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
666
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateKnowledgeBaseTemplateUriResponseSuccess
667
+
668
+ interface _UpdateQuickResponseResponseSuccess
669
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateQuickResponseResponse]
670
+ def quick_response: () -> Types::QuickResponseData
671
+ end
672
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QConnect/Client.html#update_quick_response-instance_method
673
+ def update_quick_response: (
674
+ ?channels: Array[::String],
675
+ ?content: {
676
+ content: ::String?
677
+ },
678
+ ?content_type: ::String,
679
+ ?description: ::String,
680
+ ?grouping_configuration: {
681
+ criteria: ::String?,
682
+ values: Array[::String]?
683
+ },
684
+ ?is_active: bool,
685
+ knowledge_base_id: ::String,
686
+ ?language: ::String,
687
+ ?name: ::String,
688
+ quick_response_id: ::String,
689
+ ?remove_description: bool,
690
+ ?remove_grouping_configuration: bool,
691
+ ?remove_shortcut_key: bool,
692
+ ?shortcut_key: ::String
693
+ ) -> _UpdateQuickResponseResponseSuccess
694
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateQuickResponseResponseSuccess
695
+ end
696
+ end
697
+ end
698
+