aws-sdk-qconnect 1.23.0 → 1.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +2715 -89
- data/lib/aws-sdk-qconnect/client_api.rb +1161 -0
- data/lib/aws-sdk-qconnect/types.rb +3572 -260
- data/lib/aws-sdk-qconnect.rb +2 -2
- data/sig/client.rbs +866 -6
- data/sig/types.rbs +809 -13
- metadata +2 -2
@@ -25,11 +25,16 @@ module Aws::QConnect
|
|
25
25
|
# The configuration for AI Agents of type `MANUAL_SEARCH`.
|
26
26
|
# @return [Types::ManualSearchAIAgentConfiguration]
|
27
27
|
#
|
28
|
+
# @!attribute [rw] self_service_ai_agent_configuration
|
29
|
+
# The configuration for AI Agents of type SELF\_SERVICE.
|
30
|
+
# @return [Types::SelfServiceAIAgentConfiguration]
|
31
|
+
#
|
28
32
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentConfiguration AWS API Documentation
|
29
33
|
#
|
30
34
|
class AIAgentConfiguration < Struct.new(
|
31
35
|
:answer_recommendation_ai_agent_configuration,
|
32
36
|
:manual_search_ai_agent_configuration,
|
37
|
+
:self_service_ai_agent_configuration,
|
33
38
|
:unknown)
|
34
39
|
SENSITIVE = []
|
35
40
|
include Aws::Structure
|
@@ -37,6 +42,7 @@ module Aws::QConnect
|
|
37
42
|
|
38
43
|
class AnswerRecommendationAiAgentConfiguration < AIAgentConfiguration; end
|
39
44
|
class ManualSearchAiAgentConfiguration < AIAgentConfiguration; end
|
45
|
+
class SelfServiceAiAgentConfiguration < AIAgentConfiguration; end
|
40
46
|
class Unknown < AIAgentConfiguration; end
|
41
47
|
end
|
42
48
|
|
@@ -231,6 +237,273 @@ module Aws::QConnect
|
|
231
237
|
include Aws::Structure
|
232
238
|
end
|
233
239
|
|
240
|
+
# Contains details about how to handle harmful content.
|
241
|
+
#
|
242
|
+
# @!attribute [rw] filters_config
|
243
|
+
# Contains the type of the content filter and how strongly it should
|
244
|
+
# apply to prompts and model responses.
|
245
|
+
# @return [Array<Types::GuardrailContentFilterConfig>]
|
246
|
+
#
|
247
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailContentPolicyConfig AWS API Documentation
|
248
|
+
#
|
249
|
+
class AIGuardrailContentPolicyConfig < Struct.new(
|
250
|
+
:filters_config)
|
251
|
+
SENSITIVE = []
|
252
|
+
include Aws::Structure
|
253
|
+
end
|
254
|
+
|
255
|
+
# The policy configuration details for the AI Guardrail's contextual
|
256
|
+
# grounding policy.
|
257
|
+
#
|
258
|
+
# @!attribute [rw] filters_config
|
259
|
+
# The filter configuration details for the AI Guardrails contextual
|
260
|
+
# grounding policy.
|
261
|
+
# @return [Array<Types::GuardrailContextualGroundingFilterConfig>]
|
262
|
+
#
|
263
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailContextualGroundingPolicyConfig AWS API Documentation
|
264
|
+
#
|
265
|
+
class AIGuardrailContextualGroundingPolicyConfig < Struct.new(
|
266
|
+
:filters_config)
|
267
|
+
SENSITIVE = []
|
268
|
+
include Aws::Structure
|
269
|
+
end
|
270
|
+
|
271
|
+
# The data for the AI Guardrail
|
272
|
+
#
|
273
|
+
# @!attribute [rw] ai_guardrail_arn
|
274
|
+
# The Amazon Resource Name (ARN) of the AI Guardrail.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] ai_guardrail_id
|
278
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] assistant_arn
|
282
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @!attribute [rw] assistant_id
|
286
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
287
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] blocked_input_messaging
|
291
|
+
# The message to return when the AI Guardrail blocks a prompt.
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] blocked_outputs_messaging
|
295
|
+
# The message to return when the AI Guardrail blocks a model response.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] content_policy_config
|
299
|
+
# Contains details about how to handle harmful content.
|
300
|
+
# @return [Types::AIGuardrailContentPolicyConfig]
|
301
|
+
#
|
302
|
+
# @!attribute [rw] contextual_grounding_policy_config
|
303
|
+
# The policy configuration details for the AI Guardrail's contextual
|
304
|
+
# grounding policy.
|
305
|
+
# @return [Types::AIGuardrailContextualGroundingPolicyConfig]
|
306
|
+
#
|
307
|
+
# @!attribute [rw] description
|
308
|
+
# A description of the AI Guardrail.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] modified_time
|
312
|
+
# The time the AI Guardrail was last modified.
|
313
|
+
# @return [Time]
|
314
|
+
#
|
315
|
+
# @!attribute [rw] name
|
316
|
+
# The name of the AI Guardrail.
|
317
|
+
# @return [String]
|
318
|
+
#
|
319
|
+
# @!attribute [rw] sensitive_information_policy_config
|
320
|
+
# Contains details about PII entities and regular expressions to
|
321
|
+
# configure for the AI Guardrail.
|
322
|
+
# @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] status
|
325
|
+
# The status of the AI Guardrail.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] tags
|
329
|
+
# The tags used to organize, track, or control access for this
|
330
|
+
# resource.
|
331
|
+
# @return [Hash<String,String>]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] topic_policy_config
|
334
|
+
# Contains details about topics that the AI Guardrail should identify
|
335
|
+
# and deny.
|
336
|
+
# @return [Types::AIGuardrailTopicPolicyConfig]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] visibility_status
|
339
|
+
# The visibility status of the AI Guardrail.
|
340
|
+
# @return [String]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] word_policy_config
|
343
|
+
# Contains details about the word policy to configured for the AI
|
344
|
+
# Guardrail.
|
345
|
+
# @return [Types::AIGuardrailWordPolicyConfig]
|
346
|
+
#
|
347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailData AWS API Documentation
|
348
|
+
#
|
349
|
+
class AIGuardrailData < Struct.new(
|
350
|
+
:ai_guardrail_arn,
|
351
|
+
:ai_guardrail_id,
|
352
|
+
:assistant_arn,
|
353
|
+
:assistant_id,
|
354
|
+
:blocked_input_messaging,
|
355
|
+
:blocked_outputs_messaging,
|
356
|
+
:content_policy_config,
|
357
|
+
:contextual_grounding_policy_config,
|
358
|
+
:description,
|
359
|
+
:modified_time,
|
360
|
+
:name,
|
361
|
+
:sensitive_information_policy_config,
|
362
|
+
:status,
|
363
|
+
:tags,
|
364
|
+
:topic_policy_config,
|
365
|
+
:visibility_status,
|
366
|
+
:word_policy_config)
|
367
|
+
SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
|
368
|
+
include Aws::Structure
|
369
|
+
end
|
370
|
+
|
371
|
+
# Contains details about PII entities and regular expressions to
|
372
|
+
# configure for the AI Guardrail.
|
373
|
+
#
|
374
|
+
# @!attribute [rw] pii_entities_config
|
375
|
+
# A list of PII entities to configure to the AI Guardrail.
|
376
|
+
# @return [Array<Types::GuardrailPiiEntityConfig>]
|
377
|
+
#
|
378
|
+
# @!attribute [rw] regexes_config
|
379
|
+
# A list of regular expressions to configure to the AI Guardrail.
|
380
|
+
# @return [Array<Types::GuardrailRegexConfig>]
|
381
|
+
#
|
382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailSensitiveInformationPolicyConfig AWS API Documentation
|
383
|
+
#
|
384
|
+
class AIGuardrailSensitiveInformationPolicyConfig < Struct.new(
|
385
|
+
:pii_entities_config,
|
386
|
+
:regexes_config)
|
387
|
+
SENSITIVE = []
|
388
|
+
include Aws::Structure
|
389
|
+
end
|
390
|
+
|
391
|
+
# The summary of the AI Guardrail.
|
392
|
+
#
|
393
|
+
# @!attribute [rw] ai_guardrail_arn
|
394
|
+
# The Amazon Resource Name (ARN) of the AI Guardrail.
|
395
|
+
# @return [String]
|
396
|
+
#
|
397
|
+
# @!attribute [rw] ai_guardrail_id
|
398
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
399
|
+
# @return [String]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] assistant_arn
|
402
|
+
# The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
|
403
|
+
# @return [String]
|
404
|
+
#
|
405
|
+
# @!attribute [rw] assistant_id
|
406
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
407
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] description
|
411
|
+
# A description of the AI Guardrail.
|
412
|
+
# @return [String]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] modified_time
|
415
|
+
# The time the AI Guardrail was last modified.
|
416
|
+
# @return [Time]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] name
|
419
|
+
# The name of the AI Guardrail.
|
420
|
+
# @return [String]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] status
|
423
|
+
# The status of the AI Guardrail.
|
424
|
+
# @return [String]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] tags
|
427
|
+
# The tags used to organize, track, or control access for this
|
428
|
+
# resource.
|
429
|
+
# @return [Hash<String,String>]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] visibility_status
|
432
|
+
# The visibility status of the AI Guardrail.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailSummary AWS API Documentation
|
436
|
+
#
|
437
|
+
class AIGuardrailSummary < Struct.new(
|
438
|
+
:ai_guardrail_arn,
|
439
|
+
:ai_guardrail_id,
|
440
|
+
:assistant_arn,
|
441
|
+
:assistant_id,
|
442
|
+
:description,
|
443
|
+
:modified_time,
|
444
|
+
:name,
|
445
|
+
:status,
|
446
|
+
:tags,
|
447
|
+
:visibility_status)
|
448
|
+
SENSITIVE = [:description]
|
449
|
+
include Aws::Structure
|
450
|
+
end
|
451
|
+
|
452
|
+
# Contains details about topics that the AI Guardrail should identify
|
453
|
+
# and deny.
|
454
|
+
#
|
455
|
+
# @!attribute [rw] topics_config
|
456
|
+
# A list of policies related to topics that the AI Guardrail should
|
457
|
+
# deny.
|
458
|
+
# @return [Array<Types::GuardrailTopicConfig>]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailTopicPolicyConfig AWS API Documentation
|
461
|
+
#
|
462
|
+
class AIGuardrailTopicPolicyConfig < Struct.new(
|
463
|
+
:topics_config)
|
464
|
+
SENSITIVE = []
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# The summary of the AI Guardrail version.
|
469
|
+
#
|
470
|
+
# @!attribute [rw] ai_guardrail_summary
|
471
|
+
# The data for the summary of the AI Guardrail version.
|
472
|
+
# @return [Types::AIGuardrailSummary]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] version_number
|
475
|
+
# The version number for this AI Guardrail version.
|
476
|
+
# @return [Integer]
|
477
|
+
#
|
478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailVersionSummary AWS API Documentation
|
479
|
+
#
|
480
|
+
class AIGuardrailVersionSummary < Struct.new(
|
481
|
+
:ai_guardrail_summary,
|
482
|
+
:version_number)
|
483
|
+
SENSITIVE = []
|
484
|
+
include Aws::Structure
|
485
|
+
end
|
486
|
+
|
487
|
+
# Contains details about the word policy to configured for the AI
|
488
|
+
# Guardrail.
|
489
|
+
#
|
490
|
+
# @!attribute [rw] managed_word_lists_config
|
491
|
+
# A list of managed words to configure for the AI Guardrail.
|
492
|
+
# @return [Array<Types::GuardrailManagedWordsConfig>]
|
493
|
+
#
|
494
|
+
# @!attribute [rw] words_config
|
495
|
+
# A list of words to configure for the AI Guardrail.
|
496
|
+
# @return [Array<Types::GuardrailWordConfig>]
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailWordPolicyConfig AWS API Documentation
|
499
|
+
#
|
500
|
+
class AIGuardrailWordPolicyConfig < Struct.new(
|
501
|
+
:managed_word_lists_config,
|
502
|
+
:words_config)
|
503
|
+
SENSITIVE = []
|
504
|
+
include Aws::Structure
|
505
|
+
end
|
506
|
+
|
234
507
|
# The data for the AI Prompt
|
235
508
|
#
|
236
509
|
# @!attribute [rw] ai_prompt_arn
|
@@ -471,6 +744,74 @@ module Aws::QConnect
|
|
471
744
|
include Aws::Structure
|
472
745
|
end
|
473
746
|
|
747
|
+
# @!attribute [rw] knowledge_base_id
|
748
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
749
|
+
# ARN. URLs cannot contain the ARN.
|
750
|
+
# @return [String]
|
751
|
+
#
|
752
|
+
# @!attribute [rw] message_template_id
|
753
|
+
# The identifier of the message template. Can be either the ID or the
|
754
|
+
# ARN. It cannot contain any qualifier.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @!attribute [rw] version_number
|
758
|
+
# The version number of the message template version to activate.
|
759
|
+
# @return [Integer]
|
760
|
+
#
|
761
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ActivateMessageTemplateRequest AWS API Documentation
|
762
|
+
#
|
763
|
+
class ActivateMessageTemplateRequest < Struct.new(
|
764
|
+
:knowledge_base_id,
|
765
|
+
:message_template_id,
|
766
|
+
:version_number)
|
767
|
+
SENSITIVE = []
|
768
|
+
include Aws::Structure
|
769
|
+
end
|
770
|
+
|
771
|
+
# @!attribute [rw] message_template_arn
|
772
|
+
# The Amazon Resource Name (ARN) of the message template.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] message_template_id
|
776
|
+
# The identifier of the message template.
|
777
|
+
# @return [String]
|
778
|
+
#
|
779
|
+
# @!attribute [rw] version_number
|
780
|
+
# The version number of the message template version that is
|
781
|
+
# activated.
|
782
|
+
# @return [Integer]
|
783
|
+
#
|
784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ActivateMessageTemplateResponse AWS API Documentation
|
785
|
+
#
|
786
|
+
class ActivateMessageTemplateResponse < Struct.new(
|
787
|
+
:message_template_arn,
|
788
|
+
:message_template_id,
|
789
|
+
:version_number)
|
790
|
+
SENSITIVE = []
|
791
|
+
include Aws::Structure
|
792
|
+
end
|
793
|
+
|
794
|
+
# Information about an agent.
|
795
|
+
#
|
796
|
+
# @!attribute [rw] first_name
|
797
|
+
# The agent’s first name as entered in their Amazon Connect user
|
798
|
+
# account.
|
799
|
+
# @return [String]
|
800
|
+
#
|
801
|
+
# @!attribute [rw] last_name
|
802
|
+
# The agent’s last name as entered in their Amazon Connect user
|
803
|
+
# account.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AgentAttributes AWS API Documentation
|
807
|
+
#
|
808
|
+
class AgentAttributes < Struct.new(
|
809
|
+
:first_name,
|
810
|
+
:last_name)
|
811
|
+
SENSITIVE = [:first_name, :last_name]
|
812
|
+
include Aws::Structure
|
813
|
+
end
|
814
|
+
|
474
815
|
# Content association data for a [step-by-step guide][1].
|
475
816
|
#
|
476
817
|
#
|
@@ -492,6 +833,11 @@ module Aws::QConnect
|
|
492
833
|
|
493
834
|
# The configuration for the `ANSWER_RECOMMENDATION` AI Agent type.
|
494
835
|
#
|
836
|
+
# @!attribute [rw] answer_generation_ai_guardrail_id
|
837
|
+
# The AI Guardrail identifier for the Answer Generation Guardrail used
|
838
|
+
# by the `ANSWER_RECOMMENDATION` AI Agent.
|
839
|
+
# @return [String]
|
840
|
+
#
|
495
841
|
# @!attribute [rw] answer_generation_ai_prompt_id
|
496
842
|
# The AI Prompt identifier for the Answer Generation prompt used by
|
497
843
|
# the `ANSWER_RECOMMENDATION` AI Agent.
|
@@ -515,6 +861,7 @@ module Aws::QConnect
|
|
515
861
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration AWS API Documentation
|
516
862
|
#
|
517
863
|
class AnswerRecommendationAIAgentConfiguration < Struct.new(
|
864
|
+
:answer_generation_ai_guardrail_id,
|
518
865
|
:answer_generation_ai_prompt_id,
|
519
866
|
:association_configurations,
|
520
867
|
:intent_labeling_generation_ai_prompt_id,
|
@@ -1495,6 +1842,40 @@ module Aws::QConnect
|
|
1495
1842
|
include Aws::Structure
|
1496
1843
|
end
|
1497
1844
|
|
1845
|
+
# The conversation context to include in SendMessage.
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] self_service_conversation_history
|
1848
|
+
# The self service conversation history before the Amazon Q in Connect
|
1849
|
+
# session.
|
1850
|
+
# @return [Array<Types::SelfServiceConversationHistory>]
|
1851
|
+
#
|
1852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConversationContext AWS API Documentation
|
1853
|
+
#
|
1854
|
+
class ConversationContext < Struct.new(
|
1855
|
+
:self_service_conversation_history)
|
1856
|
+
SENSITIVE = []
|
1857
|
+
include Aws::Structure
|
1858
|
+
end
|
1859
|
+
|
1860
|
+
# The conversation state associated to a message.
|
1861
|
+
#
|
1862
|
+
# @!attribute [rw] reason
|
1863
|
+
# The reason of the conversation state.
|
1864
|
+
# @return [String]
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] status
|
1867
|
+
# The status of the conversation state.
|
1868
|
+
# @return [String]
|
1869
|
+
#
|
1870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConversationState AWS API Documentation
|
1871
|
+
#
|
1872
|
+
class ConversationState < Struct.new(
|
1873
|
+
:reason,
|
1874
|
+
:status)
|
1875
|
+
SENSITIVE = []
|
1876
|
+
include Aws::Structure
|
1877
|
+
end
|
1878
|
+
|
1498
1879
|
# @!attribute [rw] assistant_id
|
1499
1880
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1500
1881
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -1502,9 +1883,9 @@ module Aws::QConnect
|
|
1502
1883
|
#
|
1503
1884
|
# @!attribute [rw] client_token
|
1504
1885
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1505
|
-
# idempotency of the request. If not provided, the
|
1506
|
-
# this field. For more information about idempotency,
|
1507
|
-
# retries safe with idempotent APIs][1]
|
1886
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1887
|
+
# SDK populates this field. For more information about idempotency,
|
1888
|
+
# see [Making retries safe with idempotent APIs][1]..
|
1508
1889
|
#
|
1509
1890
|
# **A suitable default value is auto-generated.** You should normally
|
1510
1891
|
# not need to pass this option.
|
@@ -1577,9 +1958,9 @@ module Aws::QConnect
|
|
1577
1958
|
#
|
1578
1959
|
# @!attribute [rw] client_token
|
1579
1960
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1580
|
-
# idempotency of the request. If not provided, the
|
1581
|
-
# this field. For more information about idempotency,
|
1582
|
-
# retries safe with idempotent APIs][1]
|
1961
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1962
|
+
# SDK populates this field. For more information about idempotency,
|
1963
|
+
# see [Making retries safe with idempotent APIs][1]..
|
1583
1964
|
#
|
1584
1965
|
# **A suitable default value is auto-generated.** You should normally
|
1585
1966
|
# not need to pass this option.
|
@@ -1627,20 +2008,24 @@ module Aws::QConnect
|
|
1627
2008
|
include Aws::Structure
|
1628
2009
|
end
|
1629
2010
|
|
1630
|
-
# @!attribute [rw] api_format
|
1631
|
-
# The API Format of the AI Prompt.
|
1632
|
-
# @return [String]
|
1633
|
-
#
|
1634
2011
|
# @!attribute [rw] assistant_id
|
1635
2012
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1636
2013
|
# the ID or the ARN. URLs cannot contain the ARN.
|
1637
2014
|
# @return [String]
|
1638
2015
|
#
|
2016
|
+
# @!attribute [rw] blocked_input_messaging
|
2017
|
+
# The message to return when the AI Guardrail blocks a prompt.
|
2018
|
+
# @return [String]
|
2019
|
+
#
|
2020
|
+
# @!attribute [rw] blocked_outputs_messaging
|
2021
|
+
# The message to return when the AI Guardrail blocks a model response.
|
2022
|
+
# @return [String]
|
2023
|
+
#
|
1639
2024
|
# @!attribute [rw] client_token
|
1640
2025
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1641
|
-
# idempotency of the request. If not provided, the
|
1642
|
-
# this field. For more information about idempotency,
|
1643
|
-
# retries safe with idempotent APIs][1]
|
2026
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2027
|
+
# SDK populates this field. For more information about idempotency,
|
2028
|
+
# see [Making retries safe with idempotent APIs][1]..
|
1644
2029
|
#
|
1645
2030
|
# **A suitable default value is auto-generated.** You should normally
|
1646
2031
|
# not need to pass this option.
|
@@ -1650,54 +2035,202 @@ module Aws::QConnect
|
|
1650
2035
|
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1651
2036
|
# @return [String]
|
1652
2037
|
#
|
1653
|
-
# @!attribute [rw]
|
1654
|
-
# The
|
1655
|
-
# @return [
|
2038
|
+
# @!attribute [rw] content_policy_config
|
2039
|
+
# The content filter policies to configure for the AI Guardrail.
|
2040
|
+
# @return [Types::AIGuardrailContentPolicyConfig]
|
1656
2041
|
#
|
1657
|
-
# @!attribute [rw]
|
1658
|
-
# The
|
1659
|
-
#
|
2042
|
+
# @!attribute [rw] contextual_grounding_policy_config
|
2043
|
+
# The contextual grounding policy configuration used to create an AI
|
2044
|
+
# Guardrail.
|
2045
|
+
# @return [Types::AIGuardrailContextualGroundingPolicyConfig]
|
2046
|
+
#
|
2047
|
+
# @!attribute [rw] description
|
2048
|
+
# A description of the AI Guardrail.
|
1660
2049
|
# @return [String]
|
1661
2050
|
#
|
1662
2051
|
# @!attribute [rw] name
|
1663
|
-
# The name of the AI
|
2052
|
+
# The name of the AI Guardrail.
|
1664
2053
|
# @return [String]
|
1665
2054
|
#
|
2055
|
+
# @!attribute [rw] sensitive_information_policy_config
|
2056
|
+
# The sensitive information policy to configure for the AI Guardrail.
|
2057
|
+
# @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
|
2058
|
+
#
|
1666
2059
|
# @!attribute [rw] tags
|
1667
2060
|
# The tags used to organize, track, or control access for this
|
1668
2061
|
# resource.
|
1669
2062
|
# @return [Hash<String,String>]
|
1670
2063
|
#
|
1671
|
-
# @!attribute [rw]
|
1672
|
-
# The
|
1673
|
-
# @return [Types::
|
1674
|
-
#
|
1675
|
-
# @!attribute [rw] template_type
|
1676
|
-
# The type of the prompt template for this AI Prompt.
|
1677
|
-
# @return [String]
|
1678
|
-
#
|
1679
|
-
# @!attribute [rw] type
|
1680
|
-
# The type of this AI Prompt.
|
1681
|
-
# @return [String]
|
2064
|
+
# @!attribute [rw] topic_policy_config
|
2065
|
+
# The topic policies to configure for the AI Guardrail.
|
2066
|
+
# @return [Types::AIGuardrailTopicPolicyConfig]
|
1682
2067
|
#
|
1683
2068
|
# @!attribute [rw] visibility_status
|
1684
|
-
# The visibility status of the AI
|
2069
|
+
# The visibility status of the AI Guardrail.
|
1685
2070
|
# @return [String]
|
1686
2071
|
#
|
1687
|
-
#
|
2072
|
+
# @!attribute [rw] word_policy_config
|
2073
|
+
# The word policy you configure for the AI Guardrail.
|
2074
|
+
# @return [Types::AIGuardrailWordPolicyConfig]
|
1688
2075
|
#
|
1689
|
-
|
1690
|
-
|
2076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailRequest AWS API Documentation
|
2077
|
+
#
|
2078
|
+
class CreateAIGuardrailRequest < Struct.new(
|
1691
2079
|
:assistant_id,
|
2080
|
+
:blocked_input_messaging,
|
2081
|
+
:blocked_outputs_messaging,
|
1692
2082
|
:client_token,
|
2083
|
+
:content_policy_config,
|
2084
|
+
:contextual_grounding_policy_config,
|
1693
2085
|
:description,
|
1694
|
-
:model_id,
|
1695
2086
|
:name,
|
2087
|
+
:sensitive_information_policy_config,
|
1696
2088
|
:tags,
|
1697
|
-
:
|
1698
|
-
:
|
1699
|
-
:
|
1700
|
-
:
|
2089
|
+
:topic_policy_config,
|
2090
|
+
:visibility_status,
|
2091
|
+
:word_policy_config)
|
2092
|
+
SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
|
2093
|
+
include Aws::Structure
|
2094
|
+
end
|
2095
|
+
|
2096
|
+
# @!attribute [rw] ai_guardrail
|
2097
|
+
# The data of the AI Guardrail.
|
2098
|
+
# @return [Types::AIGuardrailData]
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailResponse AWS API Documentation
|
2101
|
+
#
|
2102
|
+
class CreateAIGuardrailResponse < Struct.new(
|
2103
|
+
:ai_guardrail)
|
2104
|
+
SENSITIVE = []
|
2105
|
+
include Aws::Structure
|
2106
|
+
end
|
2107
|
+
|
2108
|
+
# @!attribute [rw] ai_guardrail_id
|
2109
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] assistant_id
|
2113
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2114
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2115
|
+
# @return [String]
|
2116
|
+
#
|
2117
|
+
# @!attribute [rw] client_token
|
2118
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2119
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2120
|
+
# SDK populates this field. For more information about idempotency,
|
2121
|
+
# see [Making retries safe with idempotent APIs][1]..
|
2122
|
+
#
|
2123
|
+
# **A suitable default value is auto-generated.** You should normally
|
2124
|
+
# not need to pass this option.
|
2125
|
+
#
|
2126
|
+
#
|
2127
|
+
#
|
2128
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] modified_time
|
2132
|
+
# The time the AI Guardrail was last modified.
|
2133
|
+
# @return [Time]
|
2134
|
+
#
|
2135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionRequest AWS API Documentation
|
2136
|
+
#
|
2137
|
+
class CreateAIGuardrailVersionRequest < Struct.new(
|
2138
|
+
:ai_guardrail_id,
|
2139
|
+
:assistant_id,
|
2140
|
+
:client_token,
|
2141
|
+
:modified_time)
|
2142
|
+
SENSITIVE = []
|
2143
|
+
include Aws::Structure
|
2144
|
+
end
|
2145
|
+
|
2146
|
+
# @!attribute [rw] ai_guardrail
|
2147
|
+
# The data of the AI Guardrail version.
|
2148
|
+
# @return [Types::AIGuardrailData]
|
2149
|
+
#
|
2150
|
+
# @!attribute [rw] version_number
|
2151
|
+
# The version number of the AI Guardrail version.
|
2152
|
+
# @return [Integer]
|
2153
|
+
#
|
2154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionResponse AWS API Documentation
|
2155
|
+
#
|
2156
|
+
class CreateAIGuardrailVersionResponse < Struct.new(
|
2157
|
+
:ai_guardrail,
|
2158
|
+
:version_number)
|
2159
|
+
SENSITIVE = []
|
2160
|
+
include Aws::Structure
|
2161
|
+
end
|
2162
|
+
|
2163
|
+
# @!attribute [rw] api_format
|
2164
|
+
# The API Format of the AI Prompt.
|
2165
|
+
# @return [String]
|
2166
|
+
#
|
2167
|
+
# @!attribute [rw] assistant_id
|
2168
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2169
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2170
|
+
# @return [String]
|
2171
|
+
#
|
2172
|
+
# @!attribute [rw] client_token
|
2173
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2174
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2175
|
+
# SDK populates this field. For more information about idempotency,
|
2176
|
+
# see [Making retries safe with idempotent APIs][1]..
|
2177
|
+
#
|
2178
|
+
# **A suitable default value is auto-generated.** You should normally
|
2179
|
+
# not need to pass this option.
|
2180
|
+
#
|
2181
|
+
#
|
2182
|
+
#
|
2183
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2184
|
+
# @return [String]
|
2185
|
+
#
|
2186
|
+
# @!attribute [rw] description
|
2187
|
+
# The description of the AI Prompt.
|
2188
|
+
# @return [String]
|
2189
|
+
#
|
2190
|
+
# @!attribute [rw] model_id
|
2191
|
+
# The identifier of the model used for this AI Prompt. Model Ids
|
2192
|
+
# supported are: `CLAUDE_3_HAIKU_20240307_V1`
|
2193
|
+
# @return [String]
|
2194
|
+
#
|
2195
|
+
# @!attribute [rw] name
|
2196
|
+
# The name of the AI Prompt.
|
2197
|
+
# @return [String]
|
2198
|
+
#
|
2199
|
+
# @!attribute [rw] tags
|
2200
|
+
# The tags used to organize, track, or control access for this
|
2201
|
+
# resource.
|
2202
|
+
# @return [Hash<String,String>]
|
2203
|
+
#
|
2204
|
+
# @!attribute [rw] template_configuration
|
2205
|
+
# The configuration of the prompt template for this AI Prompt.
|
2206
|
+
# @return [Types::AIPromptTemplateConfiguration]
|
2207
|
+
#
|
2208
|
+
# @!attribute [rw] template_type
|
2209
|
+
# The type of the prompt template for this AI Prompt.
|
2210
|
+
# @return [String]
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] type
|
2213
|
+
# The type of this AI Prompt.
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] visibility_status
|
2217
|
+
# The visibility status of the AI Prompt.
|
2218
|
+
# @return [String]
|
2219
|
+
#
|
2220
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptRequest AWS API Documentation
|
2221
|
+
#
|
2222
|
+
class CreateAIPromptRequest < Struct.new(
|
2223
|
+
:api_format,
|
2224
|
+
:assistant_id,
|
2225
|
+
:client_token,
|
2226
|
+
:description,
|
2227
|
+
:model_id,
|
2228
|
+
:name,
|
2229
|
+
:tags,
|
2230
|
+
:template_configuration,
|
2231
|
+
:template_type,
|
2232
|
+
:type,
|
2233
|
+
:visibility_status)
|
1701
2234
|
SENSITIVE = []
|
1702
2235
|
include Aws::Structure
|
1703
2236
|
end
|
@@ -1725,16 +2258,16 @@ module Aws::QConnect
|
|
1725
2258
|
#
|
1726
2259
|
# @!attribute [rw] client_token
|
1727
2260
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1728
|
-
# idempotency of the request. If not provided, the
|
1729
|
-
# this field. For more information about idempotency,
|
1730
|
-
# retries safe with idempotent APIs][1]
|
2261
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2262
|
+
# SDK populates this field. For more information about idempotency,
|
2263
|
+
# see [Making retries safe with idempotent APIs][1]..
|
1731
2264
|
#
|
1732
2265
|
# **A suitable default value is auto-generated.** You should normally
|
1733
2266
|
# not need to pass this option.
|
1734
2267
|
#
|
1735
2268
|
#
|
1736
2269
|
#
|
1737
|
-
# [1]: http://aws.amazon.com/
|
2270
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1738
2271
|
# @return [String]
|
1739
2272
|
#
|
1740
2273
|
# @!attribute [rw] modified_time
|
@@ -1793,7 +2326,7 @@ module Aws::QConnect
|
|
1793
2326
|
#
|
1794
2327
|
#
|
1795
2328
|
#
|
1796
|
-
# [1]:
|
2329
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1797
2330
|
# @return [String]
|
1798
2331
|
#
|
1799
2332
|
# @!attribute [rw] tags
|
@@ -1836,7 +2369,7 @@ module Aws::QConnect
|
|
1836
2369
|
#
|
1837
2370
|
#
|
1838
2371
|
#
|
1839
|
-
# [1]:
|
2372
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1840
2373
|
# @return [String]
|
1841
2374
|
#
|
1842
2375
|
# @!attribute [rw] description
|
@@ -1921,7 +2454,7 @@ module Aws::QConnect
|
|
1921
2454
|
#
|
1922
2455
|
#
|
1923
2456
|
#
|
1924
|
-
# [1]:
|
2457
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1925
2458
|
# @return [String]
|
1926
2459
|
#
|
1927
2460
|
# @!attribute [rw] content_id
|
@@ -1974,7 +2507,7 @@ module Aws::QConnect
|
|
1974
2507
|
#
|
1975
2508
|
#
|
1976
2509
|
#
|
1977
|
-
# [1]:
|
2510
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1978
2511
|
# @return [String]
|
1979
2512
|
#
|
1980
2513
|
# @!attribute [rw] knowledge_base_id
|
@@ -2064,7 +2597,7 @@ module Aws::QConnect
|
|
2064
2597
|
#
|
2065
2598
|
#
|
2066
2599
|
#
|
2067
|
-
# [1]:
|
2600
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2068
2601
|
# @return [String]
|
2069
2602
|
#
|
2070
2603
|
# @!attribute [rw] description
|
@@ -2106,7 +2639,7 @@ module Aws::QConnect
|
|
2106
2639
|
#
|
2107
2640
|
# @!attribute [rw] source_configuration
|
2108
2641
|
# The source of the knowledge base content. Only set this argument for
|
2109
|
-
# EXTERNAL knowledge bases.
|
2642
|
+
# EXTERNAL or Managed knowledge bases.
|
2110
2643
|
# @return [Types::SourceConfiguration]
|
2111
2644
|
#
|
2112
2645
|
# @!attribute [rw] tags
|
@@ -2146,6 +2679,197 @@ module Aws::QConnect
|
|
2146
2679
|
include Aws::Structure
|
2147
2680
|
end
|
2148
2681
|
|
2682
|
+
# @!attribute [rw] body
|
2683
|
+
# The body of the attachment file being uploaded. It should be encoded
|
2684
|
+
# using base64 encoding.
|
2685
|
+
# @return [String]
|
2686
|
+
#
|
2687
|
+
# @!attribute [rw] client_token
|
2688
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2689
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2690
|
+
# SDK populates this field. For more information about idempotency,
|
2691
|
+
# see [Making retries safe with idempotent APIs][1].
|
2692
|
+
#
|
2693
|
+
#
|
2694
|
+
#
|
2695
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2696
|
+
# @return [String]
|
2697
|
+
#
|
2698
|
+
# @!attribute [rw] content_disposition
|
2699
|
+
# The presentation information for the attachment file.
|
2700
|
+
# @return [String]
|
2701
|
+
#
|
2702
|
+
# @!attribute [rw] knowledge_base_id
|
2703
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
2704
|
+
# ARN. URLs cannot contain the ARN.
|
2705
|
+
# @return [String]
|
2706
|
+
#
|
2707
|
+
# @!attribute [rw] message_template_id
|
2708
|
+
# The identifier of the message template. Can be either the ID or the
|
2709
|
+
# ARN. It cannot contain any qualifier.
|
2710
|
+
# @return [String]
|
2711
|
+
#
|
2712
|
+
# @!attribute [rw] name
|
2713
|
+
# The name of the attachment file being uploaded. The name should
|
2714
|
+
# include the file extension.
|
2715
|
+
# @return [String]
|
2716
|
+
#
|
2717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachmentRequest AWS API Documentation
|
2718
|
+
#
|
2719
|
+
class CreateMessageTemplateAttachmentRequest < Struct.new(
|
2720
|
+
:body,
|
2721
|
+
:client_token,
|
2722
|
+
:content_disposition,
|
2723
|
+
:knowledge_base_id,
|
2724
|
+
:message_template_id,
|
2725
|
+
:name)
|
2726
|
+
SENSITIVE = [:body, :name]
|
2727
|
+
include Aws::Structure
|
2728
|
+
end
|
2729
|
+
|
2730
|
+
# @!attribute [rw] attachment
|
2731
|
+
# The message template attachment.
|
2732
|
+
# @return [Types::MessageTemplateAttachment]
|
2733
|
+
#
|
2734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateAttachmentResponse AWS API Documentation
|
2735
|
+
#
|
2736
|
+
class CreateMessageTemplateAttachmentResponse < Struct.new(
|
2737
|
+
:attachment)
|
2738
|
+
SENSITIVE = []
|
2739
|
+
include Aws::Structure
|
2740
|
+
end
|
2741
|
+
|
2742
|
+
# @!attribute [rw] channel_subtype
|
2743
|
+
# The channel subtype this message template applies to.
|
2744
|
+
# @return [String]
|
2745
|
+
#
|
2746
|
+
# @!attribute [rw] client_token
|
2747
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2748
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2749
|
+
# SDK populates this field. For more information about idempotency,
|
2750
|
+
# see [Making retries safe with idempotent APIs][1].
|
2751
|
+
#
|
2752
|
+
# **A suitable default value is auto-generated.** You should normally
|
2753
|
+
# not need to pass this option.
|
2754
|
+
#
|
2755
|
+
#
|
2756
|
+
#
|
2757
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2758
|
+
# @return [String]
|
2759
|
+
#
|
2760
|
+
# @!attribute [rw] content
|
2761
|
+
# The content of the message template.
|
2762
|
+
# @return [Types::MessageTemplateContentProvider]
|
2763
|
+
#
|
2764
|
+
# @!attribute [rw] default_attributes
|
2765
|
+
# An object that specifies the default values to use for variables in
|
2766
|
+
# the message template. This object contains different categories of
|
2767
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
2768
|
+
# message template. The corresponding value defines the default value
|
2769
|
+
# for that variable.
|
2770
|
+
# @return [Types::MessageTemplateAttributes]
|
2771
|
+
#
|
2772
|
+
# @!attribute [rw] description
|
2773
|
+
# The description of the message template.
|
2774
|
+
# @return [String]
|
2775
|
+
#
|
2776
|
+
# @!attribute [rw] grouping_configuration
|
2777
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
2778
|
+
# users.
|
2779
|
+
# @return [Types::GroupingConfiguration]
|
2780
|
+
#
|
2781
|
+
# @!attribute [rw] knowledge_base_id
|
2782
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
2783
|
+
# ARN. URLs cannot contain the ARN.
|
2784
|
+
# @return [String]
|
2785
|
+
#
|
2786
|
+
# @!attribute [rw] language
|
2787
|
+
# The language code value for the language in which the quick response
|
2788
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
2789
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
2790
|
+
# `zh_CN`, `zh_TW`
|
2791
|
+
# @return [String]
|
2792
|
+
#
|
2793
|
+
# @!attribute [rw] name
|
2794
|
+
# The name of the message template.
|
2795
|
+
# @return [String]
|
2796
|
+
#
|
2797
|
+
# @!attribute [rw] tags
|
2798
|
+
# The tags used to organize, track, or control access for this
|
2799
|
+
# resource.
|
2800
|
+
# @return [Hash<String,String>]
|
2801
|
+
#
|
2802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateRequest AWS API Documentation
|
2803
|
+
#
|
2804
|
+
class CreateMessageTemplateRequest < Struct.new(
|
2805
|
+
:channel_subtype,
|
2806
|
+
:client_token,
|
2807
|
+
:content,
|
2808
|
+
:default_attributes,
|
2809
|
+
:description,
|
2810
|
+
:grouping_configuration,
|
2811
|
+
:knowledge_base_id,
|
2812
|
+
:language,
|
2813
|
+
:name,
|
2814
|
+
:tags)
|
2815
|
+
SENSITIVE = []
|
2816
|
+
include Aws::Structure
|
2817
|
+
end
|
2818
|
+
|
2819
|
+
# @!attribute [rw] message_template
|
2820
|
+
# The message template.
|
2821
|
+
# @return [Types::MessageTemplateData]
|
2822
|
+
#
|
2823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateResponse AWS API Documentation
|
2824
|
+
#
|
2825
|
+
class CreateMessageTemplateResponse < Struct.new(
|
2826
|
+
:message_template)
|
2827
|
+
SENSITIVE = []
|
2828
|
+
include Aws::Structure
|
2829
|
+
end
|
2830
|
+
|
2831
|
+
# @!attribute [rw] knowledge_base_id
|
2832
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
2833
|
+
# ARN. URLs cannot contain the ARN.
|
2834
|
+
# @return [String]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] message_template_content_sha_256
|
2837
|
+
# The checksum value of the message template content that is
|
2838
|
+
# referenced by the `$LATEST` qualifier. It can be returned in
|
2839
|
+
# `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
|
2840
|
+
# calculated by content, language, `defaultAttributes` and
|
2841
|
+
# `Attachments` of the message template. If not supplied, the message
|
2842
|
+
# template version will be created based on the message template
|
2843
|
+
# content that is referenced by the `$LATEST` qualifier by default.
|
2844
|
+
# @return [String]
|
2845
|
+
#
|
2846
|
+
# @!attribute [rw] message_template_id
|
2847
|
+
# The identifier of the message template. Can be either the ID or the
|
2848
|
+
# ARN. It cannot contain any qualifier.
|
2849
|
+
# @return [String]
|
2850
|
+
#
|
2851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersionRequest AWS API Documentation
|
2852
|
+
#
|
2853
|
+
class CreateMessageTemplateVersionRequest < Struct.new(
|
2854
|
+
:knowledge_base_id,
|
2855
|
+
:message_template_content_sha_256,
|
2856
|
+
:message_template_id)
|
2857
|
+
SENSITIVE = []
|
2858
|
+
include Aws::Structure
|
2859
|
+
end
|
2860
|
+
|
2861
|
+
# @!attribute [rw] message_template
|
2862
|
+
# The message template.
|
2863
|
+
# @return [Types::ExtendedMessageTemplateData]
|
2864
|
+
#
|
2865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateMessageTemplateVersionResponse AWS API Documentation
|
2866
|
+
#
|
2867
|
+
class CreateMessageTemplateVersionResponse < Struct.new(
|
2868
|
+
:message_template)
|
2869
|
+
SENSITIVE = []
|
2870
|
+
include Aws::Structure
|
2871
|
+
end
|
2872
|
+
|
2149
2873
|
# @!attribute [rw] channels
|
2150
2874
|
# The Amazon Connect channels this quick response applies to.
|
2151
2875
|
# @return [Array<String>]
|
@@ -2161,7 +2885,7 @@ module Aws::QConnect
|
|
2161
2885
|
#
|
2162
2886
|
#
|
2163
2887
|
#
|
2164
|
-
# [1]:
|
2888
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2165
2889
|
# @return [String]
|
2166
2890
|
#
|
2167
2891
|
# @!attribute [rw] content
|
@@ -2270,7 +2994,7 @@ module Aws::QConnect
|
|
2270
2994
|
#
|
2271
2995
|
#
|
2272
2996
|
#
|
2273
|
-
# [1]:
|
2997
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2274
2998
|
# @return [String]
|
2275
2999
|
#
|
2276
3000
|
# @!attribute [rw] description
|
@@ -2316,9 +3040,311 @@ module Aws::QConnect
|
|
2316
3040
|
include Aws::Structure
|
2317
3041
|
end
|
2318
3042
|
|
2319
|
-
#
|
3043
|
+
# The customer profile attributes that are used with the message
|
3044
|
+
# template.
|
2320
3045
|
#
|
2321
|
-
#
|
3046
|
+
# @!attribute [rw] account_number
|
3047
|
+
# A unique account number that you have given to the customer.
|
3048
|
+
# @return [String]
|
3049
|
+
#
|
3050
|
+
# @!attribute [rw] additional_information
|
3051
|
+
# Any additional information relevant to the customer's profile.
|
3052
|
+
# @return [String]
|
3053
|
+
#
|
3054
|
+
# @!attribute [rw] address1
|
3055
|
+
# The first line of a customer address.
|
3056
|
+
# @return [String]
|
3057
|
+
#
|
3058
|
+
# @!attribute [rw] address2
|
3059
|
+
# The second line of a customer address.
|
3060
|
+
# @return [String]
|
3061
|
+
#
|
3062
|
+
# @!attribute [rw] address3
|
3063
|
+
# The third line of a customer address.
|
3064
|
+
# @return [String]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] address4
|
3067
|
+
# The fourth line of a customer address.
|
3068
|
+
# @return [String]
|
3069
|
+
#
|
3070
|
+
# @!attribute [rw] billing_address_1
|
3071
|
+
# The first line of a customer’s billing address.
|
3072
|
+
# @return [String]
|
3073
|
+
#
|
3074
|
+
# @!attribute [rw] billing_address_2
|
3075
|
+
# The second line of a customer’s billing address.
|
3076
|
+
# @return [String]
|
3077
|
+
#
|
3078
|
+
# @!attribute [rw] billing_address_3
|
3079
|
+
# The third line of a customer’s billing address.
|
3080
|
+
# @return [String]
|
3081
|
+
#
|
3082
|
+
# @!attribute [rw] billing_address_4
|
3083
|
+
# The fourth line of a customer’s billing address.
|
3084
|
+
# @return [String]
|
3085
|
+
#
|
3086
|
+
# @!attribute [rw] billing_city
|
3087
|
+
# The city of a customer’s billing address.
|
3088
|
+
# @return [String]
|
3089
|
+
#
|
3090
|
+
# @!attribute [rw] billing_country
|
3091
|
+
# The country of a customer’s billing address.
|
3092
|
+
# @return [String]
|
3093
|
+
#
|
3094
|
+
# @!attribute [rw] billing_county
|
3095
|
+
# The county of a customer’s billing address.
|
3096
|
+
# @return [String]
|
3097
|
+
#
|
3098
|
+
# @!attribute [rw] billing_postal_code
|
3099
|
+
# The postal code of a customer’s billing address.
|
3100
|
+
# @return [String]
|
3101
|
+
#
|
3102
|
+
# @!attribute [rw] billing_province
|
3103
|
+
# The province of a customer’s billing address.
|
3104
|
+
# @return [String]
|
3105
|
+
#
|
3106
|
+
# @!attribute [rw] billing_state
|
3107
|
+
# The state of a customer’s billing address.
|
3108
|
+
# @return [String]
|
3109
|
+
#
|
3110
|
+
# @!attribute [rw] birth_date
|
3111
|
+
# The customer's birth date.
|
3112
|
+
# @return [String]
|
3113
|
+
#
|
3114
|
+
# @!attribute [rw] business_email_address
|
3115
|
+
# The customer's business email address.
|
3116
|
+
# @return [String]
|
3117
|
+
#
|
3118
|
+
# @!attribute [rw] business_name
|
3119
|
+
# The name of the customer's business.
|
3120
|
+
# @return [String]
|
3121
|
+
#
|
3122
|
+
# @!attribute [rw] business_phone_number
|
3123
|
+
# The customer's business phone number.
|
3124
|
+
# @return [String]
|
3125
|
+
#
|
3126
|
+
# @!attribute [rw] city
|
3127
|
+
# The city in which a customer lives.
|
3128
|
+
# @return [String]
|
3129
|
+
#
|
3130
|
+
# @!attribute [rw] country
|
3131
|
+
# The country in which a customer lives.
|
3132
|
+
# @return [String]
|
3133
|
+
#
|
3134
|
+
# @!attribute [rw] county
|
3135
|
+
# The county in which a customer lives.
|
3136
|
+
# @return [String]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] custom
|
3139
|
+
# The custom attributes in customer profile attributes.
|
3140
|
+
# @return [Hash<String,String>]
|
3141
|
+
#
|
3142
|
+
# @!attribute [rw] email_address
|
3143
|
+
# The customer's email address, which has not been specified as a
|
3144
|
+
# personal or business address.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] first_name
|
3148
|
+
# The customer's first name.
|
3149
|
+
# @return [String]
|
3150
|
+
#
|
3151
|
+
# @!attribute [rw] gender
|
3152
|
+
# The customer's gender.
|
3153
|
+
# @return [String]
|
3154
|
+
#
|
3155
|
+
# @!attribute [rw] home_phone_number
|
3156
|
+
# The customer's mobile phone number.
|
3157
|
+
# @return [String]
|
3158
|
+
#
|
3159
|
+
# @!attribute [rw] last_name
|
3160
|
+
# The customer's last name.
|
3161
|
+
# @return [String]
|
3162
|
+
#
|
3163
|
+
# @!attribute [rw] mailing_address_1
|
3164
|
+
# The first line of a customer’s mailing address.
|
3165
|
+
# @return [String]
|
3166
|
+
#
|
3167
|
+
# @!attribute [rw] mailing_address_2
|
3168
|
+
# The second line of a customer’s mailing address.
|
3169
|
+
# @return [String]
|
3170
|
+
#
|
3171
|
+
# @!attribute [rw] mailing_address_3
|
3172
|
+
# The third line of a customer’s mailing address.
|
3173
|
+
# @return [String]
|
3174
|
+
#
|
3175
|
+
# @!attribute [rw] mailing_address_4
|
3176
|
+
# The fourth line of a customer’s mailing address.
|
3177
|
+
# @return [String]
|
3178
|
+
#
|
3179
|
+
# @!attribute [rw] mailing_city
|
3180
|
+
# The city of a customer’s mailing address.
|
3181
|
+
# @return [String]
|
3182
|
+
#
|
3183
|
+
# @!attribute [rw] mailing_country
|
3184
|
+
# The country of a customer’s mailing address.
|
3185
|
+
# @return [String]
|
3186
|
+
#
|
3187
|
+
# @!attribute [rw] mailing_county
|
3188
|
+
# The county of a customer’s mailing address.
|
3189
|
+
# @return [String]
|
3190
|
+
#
|
3191
|
+
# @!attribute [rw] mailing_postal_code
|
3192
|
+
# The postal code of a customer’s mailing address.
|
3193
|
+
# @return [String]
|
3194
|
+
#
|
3195
|
+
# @!attribute [rw] mailing_province
|
3196
|
+
# The province of a customer’s mailing address.
|
3197
|
+
# @return [String]
|
3198
|
+
#
|
3199
|
+
# @!attribute [rw] mailing_state
|
3200
|
+
# The state of a customer’s mailing address.
|
3201
|
+
# @return [String]
|
3202
|
+
#
|
3203
|
+
# @!attribute [rw] middle_name
|
3204
|
+
# The customer's middle name.
|
3205
|
+
# @return [String]
|
3206
|
+
#
|
3207
|
+
# @!attribute [rw] mobile_phone_number
|
3208
|
+
# The customer's mobile phone number.
|
3209
|
+
# @return [String]
|
3210
|
+
#
|
3211
|
+
# @!attribute [rw] party_type
|
3212
|
+
# The customer's party type.
|
3213
|
+
# @return [String]
|
3214
|
+
#
|
3215
|
+
# @!attribute [rw] phone_number
|
3216
|
+
# The customer's phone number, which has not been specified as a
|
3217
|
+
# mobile, home, or business number.
|
3218
|
+
# @return [String]
|
3219
|
+
#
|
3220
|
+
# @!attribute [rw] postal_code
|
3221
|
+
# The postal code of a customer address.
|
3222
|
+
# @return [String]
|
3223
|
+
#
|
3224
|
+
# @!attribute [rw] profile_arn
|
3225
|
+
# The ARN of a customer profile.
|
3226
|
+
# @return [String]
|
3227
|
+
#
|
3228
|
+
# @!attribute [rw] profile_id
|
3229
|
+
# The unique identifier of a customer profile.
|
3230
|
+
# @return [String]
|
3231
|
+
#
|
3232
|
+
# @!attribute [rw] province
|
3233
|
+
# The province in which a customer lives.
|
3234
|
+
# @return [String]
|
3235
|
+
#
|
3236
|
+
# @!attribute [rw] shipping_address_1
|
3237
|
+
# The first line of a customer’s shipping address.
|
3238
|
+
# @return [String]
|
3239
|
+
#
|
3240
|
+
# @!attribute [rw] shipping_address_2
|
3241
|
+
# The second line of a customer’s shipping address.
|
3242
|
+
# @return [String]
|
3243
|
+
#
|
3244
|
+
# @!attribute [rw] shipping_address_3
|
3245
|
+
# The third line of a customer’s shipping address.
|
3246
|
+
# @return [String]
|
3247
|
+
#
|
3248
|
+
# @!attribute [rw] shipping_address_4
|
3249
|
+
# The fourth line of a customer’s shipping address.
|
3250
|
+
# @return [String]
|
3251
|
+
#
|
3252
|
+
# @!attribute [rw] shipping_city
|
3253
|
+
# The city of a customer’s shipping address.
|
3254
|
+
# @return [String]
|
3255
|
+
#
|
3256
|
+
# @!attribute [rw] shipping_country
|
3257
|
+
# The country of a customer’s shipping address.
|
3258
|
+
# @return [String]
|
3259
|
+
#
|
3260
|
+
# @!attribute [rw] shipping_county
|
3261
|
+
# The county of a customer’s shipping address.
|
3262
|
+
# @return [String]
|
3263
|
+
#
|
3264
|
+
# @!attribute [rw] shipping_postal_code
|
3265
|
+
# The postal code of a customer’s shipping address.
|
3266
|
+
# @return [String]
|
3267
|
+
#
|
3268
|
+
# @!attribute [rw] shipping_province
|
3269
|
+
# The province of a customer’s shipping address.
|
3270
|
+
# @return [String]
|
3271
|
+
#
|
3272
|
+
# @!attribute [rw] shipping_state
|
3273
|
+
# The state of a customer’s shipping address.
|
3274
|
+
# @return [String]
|
3275
|
+
#
|
3276
|
+
# @!attribute [rw] state
|
3277
|
+
# The state in which a customer lives.
|
3278
|
+
# @return [String]
|
3279
|
+
#
|
3280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CustomerProfileAttributes AWS API Documentation
|
3281
|
+
#
|
3282
|
+
class CustomerProfileAttributes < Struct.new(
|
3283
|
+
:account_number,
|
3284
|
+
:additional_information,
|
3285
|
+
:address1,
|
3286
|
+
:address2,
|
3287
|
+
:address3,
|
3288
|
+
:address4,
|
3289
|
+
:billing_address_1,
|
3290
|
+
:billing_address_2,
|
3291
|
+
:billing_address_3,
|
3292
|
+
:billing_address_4,
|
3293
|
+
:billing_city,
|
3294
|
+
:billing_country,
|
3295
|
+
:billing_county,
|
3296
|
+
:billing_postal_code,
|
3297
|
+
:billing_province,
|
3298
|
+
:billing_state,
|
3299
|
+
:birth_date,
|
3300
|
+
:business_email_address,
|
3301
|
+
:business_name,
|
3302
|
+
:business_phone_number,
|
3303
|
+
:city,
|
3304
|
+
:country,
|
3305
|
+
:county,
|
3306
|
+
:custom,
|
3307
|
+
:email_address,
|
3308
|
+
:first_name,
|
3309
|
+
:gender,
|
3310
|
+
:home_phone_number,
|
3311
|
+
:last_name,
|
3312
|
+
:mailing_address_1,
|
3313
|
+
:mailing_address_2,
|
3314
|
+
:mailing_address_3,
|
3315
|
+
:mailing_address_4,
|
3316
|
+
:mailing_city,
|
3317
|
+
:mailing_country,
|
3318
|
+
:mailing_county,
|
3319
|
+
:mailing_postal_code,
|
3320
|
+
:mailing_province,
|
3321
|
+
:mailing_state,
|
3322
|
+
:middle_name,
|
3323
|
+
:mobile_phone_number,
|
3324
|
+
:party_type,
|
3325
|
+
:phone_number,
|
3326
|
+
:postal_code,
|
3327
|
+
:profile_arn,
|
3328
|
+
:profile_id,
|
3329
|
+
:province,
|
3330
|
+
:shipping_address_1,
|
3331
|
+
:shipping_address_2,
|
3332
|
+
:shipping_address_3,
|
3333
|
+
:shipping_address_4,
|
3334
|
+
:shipping_city,
|
3335
|
+
:shipping_country,
|
3336
|
+
:shipping_county,
|
3337
|
+
:shipping_postal_code,
|
3338
|
+
:shipping_province,
|
3339
|
+
:shipping_state,
|
3340
|
+
:state)
|
3341
|
+
SENSITIVE = [:account_number, :additional_information, :address1, :address2, :address3, :address4, :billing_address_1, :billing_address_2, :billing_address_3, :billing_address_4, :billing_city, :billing_country, :billing_county, :billing_postal_code, :billing_province, :billing_state, :birth_date, :business_email_address, :business_name, :business_phone_number, :city, :country, :county, :custom, :email_address, :first_name, :gender, :home_phone_number, :last_name, :mailing_address_1, :mailing_address_2, :mailing_address_3, :mailing_address_4, :mailing_city, :mailing_country, :mailing_county, :mailing_postal_code, :mailing_province, :mailing_state, :middle_name, :mobile_phone_number, :party_type, :phone_number, :postal_code, :profile_arn, :profile_id, :province, :shipping_address_1, :shipping_address_2, :shipping_address_3, :shipping_address_4, :shipping_city, :shipping_country, :shipping_county, :shipping_postal_code, :shipping_province, :shipping_state, :state]
|
3342
|
+
include Aws::Structure
|
3343
|
+
end
|
3344
|
+
|
3345
|
+
# Details about the data.
|
3346
|
+
#
|
3347
|
+
# @note DataDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataDetails corresponding to the set member.
|
2322
3348
|
#
|
2323
3349
|
# @!attribute [rw] content_data
|
2324
3350
|
# Details about the content data.
|
@@ -2401,6 +3427,53 @@ module Aws::QConnect
|
|
2401
3427
|
include Aws::Structure
|
2402
3428
|
end
|
2403
3429
|
|
3430
|
+
# @!attribute [rw] knowledge_base_id
|
3431
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
3432
|
+
# ARN. URLs cannot contain the ARN.
|
3433
|
+
# @return [String]
|
3434
|
+
#
|
3435
|
+
# @!attribute [rw] message_template_id
|
3436
|
+
# The identifier of the message template. Can be either the ID or the
|
3437
|
+
# ARN. It cannot contain any qualifier.
|
3438
|
+
# @return [String]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] version_number
|
3441
|
+
# The version number of the message template version to deactivate.
|
3442
|
+
# @return [Integer]
|
3443
|
+
#
|
3444
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplateRequest AWS API Documentation
|
3445
|
+
#
|
3446
|
+
class DeactivateMessageTemplateRequest < Struct.new(
|
3447
|
+
:knowledge_base_id,
|
3448
|
+
:message_template_id,
|
3449
|
+
:version_number)
|
3450
|
+
SENSITIVE = []
|
3451
|
+
include Aws::Structure
|
3452
|
+
end
|
3453
|
+
|
3454
|
+
# @!attribute [rw] message_template_arn
|
3455
|
+
# The Amazon Resource Name (ARN) of the message template.
|
3456
|
+
# @return [String]
|
3457
|
+
#
|
3458
|
+
# @!attribute [rw] message_template_id
|
3459
|
+
# The identifier of the message template.
|
3460
|
+
# @return [String]
|
3461
|
+
#
|
3462
|
+
# @!attribute [rw] version_number
|
3463
|
+
# The version number of the message template version that has been
|
3464
|
+
# deactivated.
|
3465
|
+
# @return [Integer]
|
3466
|
+
#
|
3467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeactivateMessageTemplateResponse AWS API Documentation
|
3468
|
+
#
|
3469
|
+
class DeactivateMessageTemplateResponse < Struct.new(
|
3470
|
+
:message_template_arn,
|
3471
|
+
:message_template_id,
|
3472
|
+
:version_number)
|
3473
|
+
SENSITIVE = []
|
3474
|
+
include Aws::Structure
|
3475
|
+
end
|
3476
|
+
|
2404
3477
|
# @!attribute [rw] ai_agent_id
|
2405
3478
|
# The identifier of the Amazon Q in Connect AI Agent. Can be either
|
2406
3479
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -2452,6 +3525,56 @@ module Aws::QConnect
|
|
2452
3525
|
#
|
2453
3526
|
class DeleteAIAgentVersionResponse < Aws::EmptyStructure; end
|
2454
3527
|
|
3528
|
+
# @!attribute [rw] ai_guardrail_id
|
3529
|
+
# The identifier of the Amazon Q in Connect AI Guardrail. Can be
|
3530
|
+
# either the ID or the ARN. URLs cannot contain the ARN.
|
3531
|
+
# @return [String]
|
3532
|
+
#
|
3533
|
+
# @!attribute [rw] assistant_id
|
3534
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3535
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3536
|
+
# @return [String]
|
3537
|
+
#
|
3538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailRequest AWS API Documentation
|
3539
|
+
#
|
3540
|
+
class DeleteAIGuardrailRequest < Struct.new(
|
3541
|
+
:ai_guardrail_id,
|
3542
|
+
:assistant_id)
|
3543
|
+
SENSITIVE = []
|
3544
|
+
include Aws::Structure
|
3545
|
+
end
|
3546
|
+
|
3547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailResponse AWS API Documentation
|
3548
|
+
#
|
3549
|
+
class DeleteAIGuardrailResponse < Aws::EmptyStructure; end
|
3550
|
+
|
3551
|
+
# @!attribute [rw] ai_guardrail_id
|
3552
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
3553
|
+
# @return [String]
|
3554
|
+
#
|
3555
|
+
# @!attribute [rw] assistant_id
|
3556
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
3557
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
3558
|
+
# @return [String]
|
3559
|
+
#
|
3560
|
+
# @!attribute [rw] version_number
|
3561
|
+
# The version number of the AI Guardrail version to be deleted.
|
3562
|
+
# @return [Integer]
|
3563
|
+
#
|
3564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailVersionRequest AWS API Documentation
|
3565
|
+
#
|
3566
|
+
class DeleteAIGuardrailVersionRequest < Struct.new(
|
3567
|
+
:ai_guardrail_id,
|
3568
|
+
:assistant_id,
|
3569
|
+
:version_number)
|
3570
|
+
SENSITIVE = []
|
3571
|
+
include Aws::Structure
|
3572
|
+
end
|
3573
|
+
|
3574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailVersionResponse AWS API Documentation
|
3575
|
+
#
|
3576
|
+
class DeleteAIGuardrailVersionResponse < Aws::EmptyStructure; end
|
3577
|
+
|
2455
3578
|
# @!attribute [rw] ai_prompt_id
|
2456
3579
|
# The identifier of the Amazon Q in Connect AI prompt. Can be either
|
2457
3580
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -2630,6 +3753,57 @@ module Aws::QConnect
|
|
2630
3753
|
#
|
2631
3754
|
class DeleteKnowledgeBaseResponse < Aws::EmptyStructure; end
|
2632
3755
|
|
3756
|
+
# @!attribute [rw] attachment_id
|
3757
|
+
# The identifier of the attachment file.
|
3758
|
+
# @return [String]
|
3759
|
+
#
|
3760
|
+
# @!attribute [rw] knowledge_base_id
|
3761
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
3762
|
+
# ARN. URLs cannot contain the ARN.
|
3763
|
+
# @return [String]
|
3764
|
+
#
|
3765
|
+
# @!attribute [rw] message_template_id
|
3766
|
+
# The identifier of the message template. Can be either the ID or the
|
3767
|
+
# ARN. It cannot contain any qualifier.
|
3768
|
+
# @return [String]
|
3769
|
+
#
|
3770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachmentRequest AWS API Documentation
|
3771
|
+
#
|
3772
|
+
class DeleteMessageTemplateAttachmentRequest < Struct.new(
|
3773
|
+
:attachment_id,
|
3774
|
+
:knowledge_base_id,
|
3775
|
+
:message_template_id)
|
3776
|
+
SENSITIVE = []
|
3777
|
+
include Aws::Structure
|
3778
|
+
end
|
3779
|
+
|
3780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateAttachmentResponse AWS API Documentation
|
3781
|
+
#
|
3782
|
+
class DeleteMessageTemplateAttachmentResponse < Aws::EmptyStructure; end
|
3783
|
+
|
3784
|
+
# @!attribute [rw] knowledge_base_id
|
3785
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
3786
|
+
# ARN. URLs cannot contain the ARN.
|
3787
|
+
# @return [String]
|
3788
|
+
#
|
3789
|
+
# @!attribute [rw] message_template_id
|
3790
|
+
# The identifier of the message template. Can be either the ID or the
|
3791
|
+
# ARN.
|
3792
|
+
# @return [String]
|
3793
|
+
#
|
3794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateRequest AWS API Documentation
|
3795
|
+
#
|
3796
|
+
class DeleteMessageTemplateRequest < Struct.new(
|
3797
|
+
:knowledge_base_id,
|
3798
|
+
:message_template_id)
|
3799
|
+
SENSITIVE = []
|
3800
|
+
include Aws::Structure
|
3801
|
+
end
|
3802
|
+
|
3803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteMessageTemplateResponse AWS API Documentation
|
3804
|
+
#
|
3805
|
+
class DeleteMessageTemplateResponse < Aws::EmptyStructure; end
|
3806
|
+
|
2633
3807
|
# @!attribute [rw] knowledge_base_id
|
2634
3808
|
# The knowledge base from which the quick response is deleted. The
|
2635
3809
|
# identifier of the knowledge base.
|
@@ -2695,58 +3869,251 @@ module Aws::QConnect
|
|
2695
3869
|
include Aws::Structure
|
2696
3870
|
end
|
2697
3871
|
|
2698
|
-
# The
|
3872
|
+
# The email header to include in email messages.
|
2699
3873
|
#
|
2700
|
-
# @!attribute [rw]
|
2701
|
-
# The
|
2702
|
-
# @return [
|
3874
|
+
# @!attribute [rw] name
|
3875
|
+
# The name of the email header.
|
3876
|
+
# @return [String]
|
2703
3877
|
#
|
2704
|
-
# @!attribute [rw]
|
2705
|
-
# The
|
3878
|
+
# @!attribute [rw] value
|
3879
|
+
# The value of the email header.
|
2706
3880
|
# @return [String]
|
2707
3881
|
#
|
2708
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
3882
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailHeader AWS API Documentation
|
2709
3883
|
#
|
2710
|
-
class
|
2711
|
-
:
|
2712
|
-
:
|
2713
|
-
SENSITIVE = []
|
3884
|
+
class EmailHeader < Struct.new(
|
3885
|
+
:name,
|
3886
|
+
:value)
|
3887
|
+
SENSITIVE = [:value]
|
2714
3888
|
include Aws::Structure
|
2715
3889
|
end
|
2716
3890
|
|
2717
|
-
#
|
3891
|
+
# The content of the message template that applies to the email channel
|
3892
|
+
# subtype.
|
2718
3893
|
#
|
2719
|
-
# @!attribute [rw]
|
2720
|
-
# The
|
2721
|
-
# @return [
|
3894
|
+
# @!attribute [rw] body
|
3895
|
+
# The body to use in email messages.
|
3896
|
+
# @return [Types::EmailMessageTemplateContentBody]
|
2722
3897
|
#
|
2723
|
-
# @!attribute [rw]
|
2724
|
-
# The
|
2725
|
-
#
|
2726
|
-
# @return [String]
|
3898
|
+
# @!attribute [rw] headers
|
3899
|
+
# The email headers to include in email messages.
|
3900
|
+
# @return [Array<Types::EmailHeader>]
|
2727
3901
|
#
|
2728
|
-
# @!attribute [rw]
|
2729
|
-
# The
|
3902
|
+
# @!attribute [rw] subject
|
3903
|
+
# The subject line, or title, to use in email messages.
|
2730
3904
|
# @return [String]
|
2731
3905
|
#
|
2732
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
3906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailMessageTemplateContent AWS API Documentation
|
2733
3907
|
#
|
2734
|
-
class
|
2735
|
-
:
|
2736
|
-
:
|
2737
|
-
:
|
2738
|
-
SENSITIVE = []
|
3908
|
+
class EmailMessageTemplateContent < Struct.new(
|
3909
|
+
:body,
|
3910
|
+
:headers,
|
3911
|
+
:subject)
|
3912
|
+
SENSITIVE = [:subject]
|
2739
3913
|
include Aws::Structure
|
2740
3914
|
end
|
2741
3915
|
|
2742
|
-
#
|
2743
|
-
# `chunkingStrategy` as `NONE`, exclude this field.
|
3916
|
+
# The body to use in email messages.
|
2744
3917
|
#
|
2745
|
-
# @!attribute [rw]
|
2746
|
-
# The
|
2747
|
-
#
|
3918
|
+
# @!attribute [rw] html
|
3919
|
+
# The message body, in HTML format, to use in email messages that are
|
3920
|
+
# based on the message template. We recommend using HTML format for
|
3921
|
+
# email clients that render HTML content. You can include links,
|
3922
|
+
# formatted text, and more in an HTML message.
|
3923
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
2748
3924
|
#
|
2749
|
-
# @!attribute [rw]
|
3925
|
+
# @!attribute [rw] plain_text
|
3926
|
+
# The message body, in plain text format, to use in email messages
|
3927
|
+
# that are based on the message template. We recommend using plain
|
3928
|
+
# text format for email clients that don't render HTML content and
|
3929
|
+
# clients that are connected to high-latency networks, such as mobile
|
3930
|
+
# devices.
|
3931
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
3932
|
+
#
|
3933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailMessageTemplateContentBody AWS API Documentation
|
3934
|
+
#
|
3935
|
+
class EmailMessageTemplateContentBody < Struct.new(
|
3936
|
+
:html,
|
3937
|
+
:plain_text)
|
3938
|
+
SENSITIVE = []
|
3939
|
+
include Aws::Structure
|
3940
|
+
end
|
3941
|
+
|
3942
|
+
# The extended data of a message template.
|
3943
|
+
#
|
3944
|
+
# @!attribute [rw] attachments
|
3945
|
+
# The message template attachments.
|
3946
|
+
# @return [Array<Types::MessageTemplateAttachment>]
|
3947
|
+
#
|
3948
|
+
# @!attribute [rw] attribute_types
|
3949
|
+
# The types of attributes contain the message template.
|
3950
|
+
# @return [Array<String>]
|
3951
|
+
#
|
3952
|
+
# @!attribute [rw] channel_subtype
|
3953
|
+
# The channel subtype this message template applies to.
|
3954
|
+
# @return [String]
|
3955
|
+
#
|
3956
|
+
# @!attribute [rw] content
|
3957
|
+
# The content of the message template.
|
3958
|
+
# @return [Types::MessageTemplateContentProvider]
|
3959
|
+
#
|
3960
|
+
# @!attribute [rw] created_time
|
3961
|
+
# The timestamp when the message template was created.
|
3962
|
+
# @return [Time]
|
3963
|
+
#
|
3964
|
+
# @!attribute [rw] default_attributes
|
3965
|
+
# An object that specifies the default values to use for variables in
|
3966
|
+
# the message template. This object contains different categories of
|
3967
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
3968
|
+
# message template. The corresponding value defines the default value
|
3969
|
+
# for that variable.
|
3970
|
+
# @return [Types::MessageTemplateAttributes]
|
3971
|
+
#
|
3972
|
+
# @!attribute [rw] description
|
3973
|
+
# The description of the message template.
|
3974
|
+
# @return [String]
|
3975
|
+
#
|
3976
|
+
# @!attribute [rw] grouping_configuration
|
3977
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
3978
|
+
# users.
|
3979
|
+
# @return [Types::GroupingConfiguration]
|
3980
|
+
#
|
3981
|
+
# @!attribute [rw] is_active
|
3982
|
+
# Whether the version of the message template is activated.
|
3983
|
+
# @return [Boolean]
|
3984
|
+
#
|
3985
|
+
# @!attribute [rw] knowledge_base_arn
|
3986
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
3987
|
+
# @return [String]
|
3988
|
+
#
|
3989
|
+
# @!attribute [rw] knowledge_base_id
|
3990
|
+
# The identifier of the knowledge base.
|
3991
|
+
# @return [String]
|
3992
|
+
#
|
3993
|
+
# @!attribute [rw] language
|
3994
|
+
# The language code value for the language in which the quick response
|
3995
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
3996
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
3997
|
+
# `zh_CN`, `zh_TW`
|
3998
|
+
# @return [String]
|
3999
|
+
#
|
4000
|
+
# @!attribute [rw] last_modified_by
|
4001
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
4002
|
+
# message template data.
|
4003
|
+
# @return [String]
|
4004
|
+
#
|
4005
|
+
# @!attribute [rw] last_modified_time
|
4006
|
+
# The timestamp when the message template data was last modified.
|
4007
|
+
# @return [Time]
|
4008
|
+
#
|
4009
|
+
# @!attribute [rw] message_template_arn
|
4010
|
+
# The Amazon Resource Name (ARN) of the message template.
|
4011
|
+
# @return [String]
|
4012
|
+
#
|
4013
|
+
# @!attribute [rw] message_template_content_sha_256
|
4014
|
+
# The checksum value of the message template content that is
|
4015
|
+
# referenced by the `$LATEST` qualifier. It can be returned in
|
4016
|
+
# `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
|
4017
|
+
# calculated by content, language, `defaultAttributes` and
|
4018
|
+
# `Attachments` of the message template.
|
4019
|
+
# @return [String]
|
4020
|
+
#
|
4021
|
+
# @!attribute [rw] message_template_id
|
4022
|
+
# The identifier of the message template.
|
4023
|
+
# @return [String]
|
4024
|
+
#
|
4025
|
+
# @!attribute [rw] name
|
4026
|
+
# The name of the message template.
|
4027
|
+
# @return [String]
|
4028
|
+
#
|
4029
|
+
# @!attribute [rw] tags
|
4030
|
+
# The tags used to organize, track, or control access for this
|
4031
|
+
# resource.
|
4032
|
+
# @return [Hash<String,String>]
|
4033
|
+
#
|
4034
|
+
# @!attribute [rw] version_number
|
4035
|
+
# The version number of the message template version.
|
4036
|
+
# @return [Integer]
|
4037
|
+
#
|
4038
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExtendedMessageTemplateData AWS API Documentation
|
4039
|
+
#
|
4040
|
+
class ExtendedMessageTemplateData < Struct.new(
|
4041
|
+
:attachments,
|
4042
|
+
:attribute_types,
|
4043
|
+
:channel_subtype,
|
4044
|
+
:content,
|
4045
|
+
:created_time,
|
4046
|
+
:default_attributes,
|
4047
|
+
:description,
|
4048
|
+
:grouping_configuration,
|
4049
|
+
:is_active,
|
4050
|
+
:knowledge_base_arn,
|
4051
|
+
:knowledge_base_id,
|
4052
|
+
:language,
|
4053
|
+
:last_modified_by,
|
4054
|
+
:last_modified_time,
|
4055
|
+
:message_template_arn,
|
4056
|
+
:message_template_content_sha_256,
|
4057
|
+
:message_template_id,
|
4058
|
+
:name,
|
4059
|
+
:tags,
|
4060
|
+
:version_number)
|
4061
|
+
SENSITIVE = []
|
4062
|
+
include Aws::Structure
|
4063
|
+
end
|
4064
|
+
|
4065
|
+
# The configuration information of the external data source.
|
4066
|
+
#
|
4067
|
+
# @!attribute [rw] configuration
|
4068
|
+
# The configuration information of the external data source.
|
4069
|
+
# @return [Types::Configuration]
|
4070
|
+
#
|
4071
|
+
# @!attribute [rw] source
|
4072
|
+
# The type of the external data source.
|
4073
|
+
# @return [String]
|
4074
|
+
#
|
4075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExternalSourceConfiguration AWS API Documentation
|
4076
|
+
#
|
4077
|
+
class ExternalSourceConfiguration < Struct.new(
|
4078
|
+
:configuration,
|
4079
|
+
:source)
|
4080
|
+
SENSITIVE = []
|
4081
|
+
include Aws::Structure
|
4082
|
+
end
|
4083
|
+
|
4084
|
+
# A search filter.
|
4085
|
+
#
|
4086
|
+
# @!attribute [rw] field
|
4087
|
+
# The field on which to filter.
|
4088
|
+
# @return [String]
|
4089
|
+
#
|
4090
|
+
# @!attribute [rw] operator
|
4091
|
+
# The operator to use for comparing the field’s value with the
|
4092
|
+
# provided value.
|
4093
|
+
# @return [String]
|
4094
|
+
#
|
4095
|
+
# @!attribute [rw] value
|
4096
|
+
# The desired field value on which to filter.
|
4097
|
+
# @return [String]
|
4098
|
+
#
|
4099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Filter AWS API Documentation
|
4100
|
+
#
|
4101
|
+
class Filter < Struct.new(
|
4102
|
+
:field,
|
4103
|
+
:operator,
|
4104
|
+
:value)
|
4105
|
+
SENSITIVE = []
|
4106
|
+
include Aws::Structure
|
4107
|
+
end
|
4108
|
+
|
4109
|
+
# Configurations for when you choose fixed-size chunking. If you set the
|
4110
|
+
# `chunkingStrategy` as `NONE`, exclude this field.
|
4111
|
+
#
|
4112
|
+
# @!attribute [rw] max_tokens
|
4113
|
+
# The maximum number of tokens to include in a chunk.
|
4114
|
+
# @return [Integer]
|
4115
|
+
#
|
4116
|
+
# @!attribute [rw] overlap_percentage
|
2750
4117
|
# The percentage of overlap between adjacent chunks of a data source.
|
2751
4118
|
# @return [Integer]
|
2752
4119
|
#
|
@@ -2855,6 +4222,43 @@ module Aws::QConnect
|
|
2855
4222
|
include Aws::Structure
|
2856
4223
|
end
|
2857
4224
|
|
4225
|
+
# @!attribute [rw] ai_guardrail_id
|
4226
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
4227
|
+
# @return [String]
|
4228
|
+
#
|
4229
|
+
# @!attribute [rw] assistant_id
|
4230
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
4231
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
4232
|
+
# @return [String]
|
4233
|
+
#
|
4234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIGuardrailRequest AWS API Documentation
|
4235
|
+
#
|
4236
|
+
class GetAIGuardrailRequest < Struct.new(
|
4237
|
+
:ai_guardrail_id,
|
4238
|
+
:assistant_id)
|
4239
|
+
SENSITIVE = []
|
4240
|
+
include Aws::Structure
|
4241
|
+
end
|
4242
|
+
|
4243
|
+
# @!attribute [rw] ai_guardrail
|
4244
|
+
# The data of the AI Guardrail.
|
4245
|
+
# @return [Types::AIGuardrailData]
|
4246
|
+
#
|
4247
|
+
# @!attribute [rw] version_number
|
4248
|
+
# The version number of the AI Guardrail version (returned if an AI
|
4249
|
+
# Guardrail version was specified via use of a qualifier for the
|
4250
|
+
# `aiGuardrailId` on the request).
|
4251
|
+
# @return [Integer]
|
4252
|
+
#
|
4253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIGuardrailResponse AWS API Documentation
|
4254
|
+
#
|
4255
|
+
class GetAIGuardrailResponse < Struct.new(
|
4256
|
+
:ai_guardrail,
|
4257
|
+
:version_number)
|
4258
|
+
SENSITIVE = []
|
4259
|
+
include Aws::Structure
|
4260
|
+
end
|
4261
|
+
|
2858
4262
|
# @!attribute [rw] ai_prompt_id
|
2859
4263
|
# The identifier of the Amazon Q in Connect AI prompt.
|
2860
4264
|
# @return [String]
|
@@ -3101,6 +4505,98 @@ module Aws::QConnect
|
|
3101
4505
|
include Aws::Structure
|
3102
4506
|
end
|
3103
4507
|
|
4508
|
+
# @!attribute [rw] knowledge_base_id
|
4509
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
4510
|
+
# ARN. URLs cannot contain the ARN.
|
4511
|
+
# @return [String]
|
4512
|
+
#
|
4513
|
+
# @!attribute [rw] message_template_id
|
4514
|
+
# The identifier of the message template. Can be either the ID or the
|
4515
|
+
# ARN.
|
4516
|
+
# @return [String]
|
4517
|
+
#
|
4518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplateRequest AWS API Documentation
|
4519
|
+
#
|
4520
|
+
class GetMessageTemplateRequest < Struct.new(
|
4521
|
+
:knowledge_base_id,
|
4522
|
+
:message_template_id)
|
4523
|
+
SENSITIVE = []
|
4524
|
+
include Aws::Structure
|
4525
|
+
end
|
4526
|
+
|
4527
|
+
# @!attribute [rw] message_template
|
4528
|
+
# The message template.
|
4529
|
+
# @return [Types::ExtendedMessageTemplateData]
|
4530
|
+
#
|
4531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetMessageTemplateResponse AWS API Documentation
|
4532
|
+
#
|
4533
|
+
class GetMessageTemplateResponse < Struct.new(
|
4534
|
+
:message_template)
|
4535
|
+
SENSITIVE = []
|
4536
|
+
include Aws::Structure
|
4537
|
+
end
|
4538
|
+
|
4539
|
+
# @!attribute [rw] assistant_id
|
4540
|
+
# The identifier of the Amazon Q in Connect assistant.
|
4541
|
+
# @return [String]
|
4542
|
+
#
|
4543
|
+
# @!attribute [rw] next_message_token
|
4544
|
+
# The token for the next message. Use the value returned in the
|
4545
|
+
# SendMessage or previous response in the next request to retrieve the
|
4546
|
+
# next message.
|
4547
|
+
# @return [String]
|
4548
|
+
#
|
4549
|
+
# @!attribute [rw] session_id
|
4550
|
+
# The identifier of the Amazon Q in Connect session.
|
4551
|
+
# @return [String]
|
4552
|
+
#
|
4553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageRequest AWS API Documentation
|
4554
|
+
#
|
4555
|
+
class GetNextMessageRequest < Struct.new(
|
4556
|
+
:assistant_id,
|
4557
|
+
:next_message_token,
|
4558
|
+
:session_id)
|
4559
|
+
SENSITIVE = []
|
4560
|
+
include Aws::Structure
|
4561
|
+
end
|
4562
|
+
|
4563
|
+
# @!attribute [rw] conversation_session_data
|
4564
|
+
# The conversation data stored on an Amazon Q in Connect Session.
|
4565
|
+
# @return [Array<Types::RuntimeSessionData>]
|
4566
|
+
#
|
4567
|
+
# @!attribute [rw] conversation_state
|
4568
|
+
# The state of current conversation.
|
4569
|
+
# @return [Types::ConversationState]
|
4570
|
+
#
|
4571
|
+
# @!attribute [rw] next_message_token
|
4572
|
+
# The token for the next message.
|
4573
|
+
# @return [String]
|
4574
|
+
#
|
4575
|
+
# @!attribute [rw] request_message_id
|
4576
|
+
# The identifier of the submitted message.
|
4577
|
+
# @return [String]
|
4578
|
+
#
|
4579
|
+
# @!attribute [rw] response
|
4580
|
+
# The message response to the requested message.
|
4581
|
+
# @return [Types::MessageOutput]
|
4582
|
+
#
|
4583
|
+
# @!attribute [rw] type
|
4584
|
+
# The type of message response.
|
4585
|
+
# @return [String]
|
4586
|
+
#
|
4587
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageResponse AWS API Documentation
|
4588
|
+
#
|
4589
|
+
class GetNextMessageResponse < Struct.new(
|
4590
|
+
:conversation_session_data,
|
4591
|
+
:conversation_state,
|
4592
|
+
:next_message_token,
|
4593
|
+
:request_message_id,
|
4594
|
+
:response,
|
4595
|
+
:type)
|
4596
|
+
SENSITIVE = []
|
4597
|
+
include Aws::Structure
|
4598
|
+
end
|
4599
|
+
|
3104
4600
|
# @!attribute [rw] knowledge_base_id
|
3105
4601
|
# The identifier of the knowledge base. This should be a
|
3106
4602
|
# QUICK\_RESPONSES type knowledge base.
|
@@ -3258,47 +4754,457 @@ module Aws::QConnect
|
|
3258
4754
|
include Aws::Structure
|
3259
4755
|
end
|
3260
4756
|
|
3261
|
-
#
|
3262
|
-
#
|
3263
|
-
#
|
3264
|
-
# smaller chunks derived from the first layer.
|
4757
|
+
# Contains filter strengths for harmful content. AI Guardrail's support
|
4758
|
+
# the following content filters to detect and filter harmful user inputs
|
4759
|
+
# and FM-generated outputs.
|
3265
4760
|
#
|
3266
|
-
#
|
3267
|
-
#
|
3268
|
-
#
|
4761
|
+
# * **Hate**: Describes input prompts and model responses that
|
4762
|
+
# discriminate, criticize, insult, denounce, or dehumanize a person or
|
4763
|
+
# group on the basis of an identity (such as race, ethnicity, gender,
|
4764
|
+
# religion, sexual orientation, ability, and national origin).
|
3269
4765
|
#
|
3270
|
-
#
|
3271
|
-
#
|
3272
|
-
#
|
4766
|
+
# * **Insults**: Describes input prompts and model responses that
|
4767
|
+
# includes demeaning, humiliating, mocking, insulting, or belittling
|
4768
|
+
# language. This type of language is also labeled as bullying.
|
3273
4769
|
#
|
3274
|
-
#
|
4770
|
+
# * **Sexual**: Describes input prompts and model responses that
|
4771
|
+
# indicates sexual interest, activity, or arousal using direct or
|
4772
|
+
# indirect references to body parts, physical traits, or sex.
|
3275
4773
|
#
|
3276
|
-
|
3277
|
-
|
3278
|
-
|
3279
|
-
|
4774
|
+
# * **Violence**: Describes input prompts and model responses that
|
4775
|
+
# includes glorification of, or threats to inflict physical pain,
|
4776
|
+
# hurt, or injury toward a person, group, or thing.
|
4777
|
+
#
|
4778
|
+
# Content filtering depends on the confidence classification of user
|
4779
|
+
# inputs and FM responses across each of the four harmful categories.
|
4780
|
+
# All input and output statements are classified into one of four
|
4781
|
+
# confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category.
|
4782
|
+
# For example, if a statement is classified as *Hate* with HIGH
|
4783
|
+
# confidence, the likelihood of the statement representing hateful
|
4784
|
+
# content is high. A single statement can be classified across multiple
|
4785
|
+
# categories with varying confidence levels. For example, a single
|
4786
|
+
# statement can be classified as *Hate* with HIGH confidence, <i>
|
4787
|
+
# Insults</i> with LOW confidence, *Sexual* with NONE confidence, and
|
4788
|
+
# *Violence* with MEDIUM confidence.
|
4789
|
+
#
|
4790
|
+
# @!attribute [rw] input_strength
|
4791
|
+
# The strength of the content filter to apply to prompts. As you
|
4792
|
+
# increase the filter strength, the likelihood of filtering harmful
|
4793
|
+
# content increases and the probability of seeing harmful content in
|
4794
|
+
# your application reduces.
|
4795
|
+
# @return [String]
|
4796
|
+
#
|
4797
|
+
# @!attribute [rw] output_strength
|
4798
|
+
# The strength of the content filter to apply to model responses. As
|
4799
|
+
# you increase the filter strength, the likelihood of filtering
|
4800
|
+
# harmful content increases and the probability of seeing harmful
|
4801
|
+
# content in your application reduces.
|
4802
|
+
# @return [String]
|
4803
|
+
#
|
4804
|
+
# @!attribute [rw] type
|
4805
|
+
# The harmful category that the content filter is applied to.
|
4806
|
+
# @return [String]
|
4807
|
+
#
|
4808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailContentFilterConfig AWS API Documentation
|
4809
|
+
#
|
4810
|
+
class GuardrailContentFilterConfig < Struct.new(
|
4811
|
+
:input_strength,
|
4812
|
+
:output_strength,
|
4813
|
+
:type)
|
4814
|
+
SENSITIVE = [:input_strength, :output_strength, :type]
|
3280
4815
|
include Aws::Structure
|
3281
4816
|
end
|
3282
4817
|
|
3283
|
-
#
|
4818
|
+
# The filter configuration details for the AI Guardrail's contextual
|
4819
|
+
# grounding filter.
|
3284
4820
|
#
|
3285
|
-
# @!attribute [rw]
|
3286
|
-
# The
|
3287
|
-
#
|
4821
|
+
# @!attribute [rw] threshold
|
4822
|
+
# The threshold details for the AI Guardrail's contextual grounding
|
4823
|
+
# filter.
|
4824
|
+
# @return [Float]
|
3288
4825
|
#
|
3289
|
-
#
|
4826
|
+
# @!attribute [rw] type
|
4827
|
+
# The filter type for the AI Guardrail's contextual grounding filter.
|
4828
|
+
# @return [String]
|
3290
4829
|
#
|
3291
|
-
|
3292
|
-
|
3293
|
-
|
4830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailContextualGroundingFilterConfig AWS API Documentation
|
4831
|
+
#
|
4832
|
+
class GuardrailContextualGroundingFilterConfig < Struct.new(
|
4833
|
+
:threshold,
|
4834
|
+
:type)
|
4835
|
+
SENSITIVE = [:threshold, :type]
|
3294
4836
|
include Aws::Structure
|
3295
4837
|
end
|
3296
4838
|
|
3297
|
-
#
|
3298
|
-
# rendering search results and recommendations.
|
4839
|
+
# The managed word list to configure for the AI Guardrail.
|
3299
4840
|
#
|
3300
|
-
# @!attribute [rw]
|
3301
|
-
# The
|
4841
|
+
# @!attribute [rw] type
|
4842
|
+
# The managed word type to configure for the AI Guardrail.
|
4843
|
+
# @return [String]
|
4844
|
+
#
|
4845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailManagedWordsConfig AWS API Documentation
|
4846
|
+
#
|
4847
|
+
class GuardrailManagedWordsConfig < Struct.new(
|
4848
|
+
:type)
|
4849
|
+
SENSITIVE = [:type]
|
4850
|
+
include Aws::Structure
|
4851
|
+
end
|
4852
|
+
|
4853
|
+
# The PII entity to configure for the AI Guardrail.
|
4854
|
+
#
|
4855
|
+
# @!attribute [rw] action
|
4856
|
+
# Configure AI Guardrail's action when the PII entity is detected.
|
4857
|
+
# @return [String]
|
4858
|
+
#
|
4859
|
+
# @!attribute [rw] type
|
4860
|
+
# Configure AI Guardrail type when the PII entity is detected.
|
4861
|
+
#
|
4862
|
+
# The following PIIs are used to block or mask sensitive information:
|
4863
|
+
#
|
4864
|
+
# * **General**
|
4865
|
+
#
|
4866
|
+
# * **ADDRESS**
|
4867
|
+
#
|
4868
|
+
# A physical address, such as "100 Main Street, Anytown, USA" or
|
4869
|
+
# "Suite #12, Building 123". An address can include information
|
4870
|
+
# such as the street, building, location, city, state, country,
|
4871
|
+
# county, zip code, precinct, and neighborhood.
|
4872
|
+
#
|
4873
|
+
# * **AGE**
|
4874
|
+
#
|
4875
|
+
# An individual's age, including the quantity and unit of time.
|
4876
|
+
# For example, in the phrase "I am 40 years old," Guarrails
|
4877
|
+
# recognizes "40 years" as an age.
|
4878
|
+
#
|
4879
|
+
# * **NAME**
|
4880
|
+
#
|
4881
|
+
# An individual's name. This entity type does not include titles,
|
4882
|
+
# such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply
|
4883
|
+
# this entity type to names that are part of organizations or
|
4884
|
+
# addresses. For example, AI Guardrail recognizes the "John Doe
|
4885
|
+
# Organization" as an organization, and it recognizes "Jane Doe
|
4886
|
+
# Street" as an address.
|
4887
|
+
#
|
4888
|
+
# * **EMAIL**
|
4889
|
+
#
|
4890
|
+
# An email address, such as *marymajor@email.com*.
|
4891
|
+
#
|
4892
|
+
# * **PHONE**
|
4893
|
+
#
|
4894
|
+
# A phone number. This entity type also includes fax and pager
|
4895
|
+
# numbers.
|
4896
|
+
#
|
4897
|
+
# * **USERNAME**
|
4898
|
+
#
|
4899
|
+
# A user name that identifies an account, such as a login name,
|
4900
|
+
# screen name, nick name, or handle.
|
4901
|
+
#
|
4902
|
+
# * **PASSWORD**
|
4903
|
+
#
|
4904
|
+
# An alphanumeric string that is used as a password, such as
|
4905
|
+
# "*<i> very20special#pass*</i>".
|
4906
|
+
#
|
4907
|
+
# * **DRIVER\_ID**
|
4908
|
+
#
|
4909
|
+
# The number assigned to a driver's license, which is an official
|
4910
|
+
# document permitting an individual to operate one or more
|
4911
|
+
# motorized vehicles on a public road. A driver's license number
|
4912
|
+
# consists of alphanumeric characters.
|
4913
|
+
#
|
4914
|
+
# * **LICENSE\_PLATE**
|
4915
|
+
#
|
4916
|
+
# A license plate for a vehicle is issued by the state or country
|
4917
|
+
# where the vehicle is registered. The format for passenger
|
4918
|
+
# vehicles is typically five to eight digits, consisting of
|
4919
|
+
# upper-case letters and numbers. The format varies depending on
|
4920
|
+
# the location of the issuing state or country.
|
4921
|
+
#
|
4922
|
+
# * **VEHICLE\_IDENTIFICATION\_NUMBER**
|
4923
|
+
#
|
4924
|
+
# A Vehicle Identification Number (VIN) uniquely identifies a
|
4925
|
+
# vehicle. VIN content and format are defined in the *ISO 3779*
|
4926
|
+
# specification. Each country has specific codes and formats for
|
4927
|
+
# VINs.
|
4928
|
+
# * **Finance**
|
4929
|
+
#
|
4930
|
+
# * **REDIT\_DEBIT\_CARD\_CVV**
|
4931
|
+
#
|
4932
|
+
# A three-digit card verification code (CVV) that is present on
|
4933
|
+
# VISA, MasterCard, and Discover credit and debit cards. For
|
4934
|
+
# American Express credit or debit cards, the CVV is a four-digit
|
4935
|
+
# numeric code.
|
4936
|
+
#
|
4937
|
+
# * **CREDIT\_DEBIT\_CARD\_EXPIRY**
|
4938
|
+
#
|
4939
|
+
# The expiration date for a credit or debit card. This number is
|
4940
|
+
# usually four digits long and is often formatted as *month/year*
|
4941
|
+
# or *MM/YY*. AI Guardrail recognizes expiration dates such as
|
4942
|
+
# *01/21*, *01/2021*, and *Jan 2021*.
|
4943
|
+
#
|
4944
|
+
# * **CREDIT\_DEBIT\_CARD\_NUMBER**
|
4945
|
+
#
|
4946
|
+
# The number for a credit or debit card. These numbers can vary
|
4947
|
+
# from 13 to 16 digits in length. However, Amazon Comprehend also
|
4948
|
+
# recognizes credit or debit card numbers when only the last four
|
4949
|
+
# digits are present.
|
4950
|
+
#
|
4951
|
+
# * **PIN**
|
4952
|
+
#
|
4953
|
+
# A four-digit personal identification number (PIN) with which you
|
4954
|
+
# can access your bank account.
|
4955
|
+
#
|
4956
|
+
# * **INTERNATIONAL\_BANK\_ACCOUNT\_NUMBER**
|
4957
|
+
#
|
4958
|
+
# An International Bank Account Number has specific formats in
|
4959
|
+
# each country. For more information, see [
|
4960
|
+
# www.iban.com/structure][1].
|
4961
|
+
#
|
4962
|
+
# * **SWIFT\_CODE**
|
4963
|
+
#
|
4964
|
+
# A SWIFT code is a standard format of Bank Identifier Code (BIC)
|
4965
|
+
# used to specify a particular bank or branch. Banks use these
|
4966
|
+
# codes for money transfers such as international wire transfers.
|
4967
|
+
#
|
4968
|
+
# SWIFT codes consist of eight or 11 characters. The 11-digit
|
4969
|
+
# codes refer to specific branches, while eight-digit codes (or
|
4970
|
+
# 11-digit codes ending in 'XXX') refer to the head or primary
|
4971
|
+
# office.
|
4972
|
+
# * **IT**
|
4973
|
+
#
|
4974
|
+
# * **IP\_ADDRESS**
|
4975
|
+
#
|
4976
|
+
# An IPv4 address, such as *198.51.100.0*.
|
4977
|
+
#
|
4978
|
+
# * **MAC\_ADDRESS**
|
4979
|
+
#
|
4980
|
+
# A *media access control* (MAC) address is a unique identifier
|
4981
|
+
# assigned to a network interface controller (NIC).
|
4982
|
+
#
|
4983
|
+
# * **URL**
|
4984
|
+
#
|
4985
|
+
# A web address, such as *www.example.com*.
|
4986
|
+
#
|
4987
|
+
# * **AWS\_ACCESS\_KEY**
|
4988
|
+
#
|
4989
|
+
# A unique identifier that's associated with a secret access key;
|
4990
|
+
# you use the access key ID and secret access key to sign
|
4991
|
+
# programmatic Amazon Web Services requests cryptographically.
|
4992
|
+
#
|
4993
|
+
# * **AWS\_SECRET\_KEY**
|
4994
|
+
#
|
4995
|
+
# A unique identifier that's associated with an access key. You
|
4996
|
+
# use the access key ID and secret access key to sign programmatic
|
4997
|
+
# Amazon Web Services requests cryptographically.
|
4998
|
+
# * **USA specific**
|
4999
|
+
#
|
5000
|
+
# * **US\_BANK\_ACCOUNT\_NUMBER**
|
5001
|
+
#
|
5002
|
+
# A US bank account number, which is typically 10 to 12 digits
|
5003
|
+
# long.
|
5004
|
+
#
|
5005
|
+
# * **US\_BANK\_ROUTING\_NUMBER**
|
5006
|
+
#
|
5007
|
+
# A US bank account routing number. These are typically nine
|
5008
|
+
# digits long,
|
5009
|
+
#
|
5010
|
+
# * **US\_INDIVIDUAL\_TAX\_IDENTIFICATION\_NUMBER**
|
5011
|
+
#
|
5012
|
+
# A US Individual Taxpayer Identification Number (ITIN) is a
|
5013
|
+
# nine-digit number that starts with a "9" and contain a "7"
|
5014
|
+
# or "8" as the fourth digit. An ITIN can be formatted with a
|
5015
|
+
# space or a dash after the third and forth digits.
|
5016
|
+
#
|
5017
|
+
# * **US\_PASSPORT\_NUMBER**
|
5018
|
+
#
|
5019
|
+
# A US passport number. Passport numbers range from six to nine
|
5020
|
+
# alphanumeric characters.
|
5021
|
+
#
|
5022
|
+
# * **US\_SOCIAL\_SECURITY\_NUMBER**
|
5023
|
+
#
|
5024
|
+
# A US Social Security Number (SSN) is a nine-digit number that is
|
5025
|
+
# issued to US citizens, permanent residents, and temporary
|
5026
|
+
# working residents.
|
5027
|
+
# * **Canada specific**
|
5028
|
+
#
|
5029
|
+
# * **CA\_HEALTH\_NUMBER**
|
5030
|
+
#
|
5031
|
+
# A Canadian Health Service Number is a 10-digit unique
|
5032
|
+
# identifier, required for individuals to access healthcare
|
5033
|
+
# benefits.
|
5034
|
+
#
|
5035
|
+
# * **CA\_SOCIAL\_INSURANCE\_NUMBER**
|
5036
|
+
#
|
5037
|
+
# A Canadian Social Insurance Number (SIN) is a nine-digit unique
|
5038
|
+
# identifier, required for individuals to access government
|
5039
|
+
# programs and benefits.
|
5040
|
+
#
|
5041
|
+
# The SIN is formatted as three groups of three digits, such as
|
5042
|
+
# <i> 123-456-789</i>. A SIN can be validated through a simple
|
5043
|
+
# check-digit process called the [Luhn algorithm][2] .
|
5044
|
+
# * **UK Specific**
|
5045
|
+
#
|
5046
|
+
# * **UK\_NATIONAL\_HEALTH\_SERVICE\_NUMBER**
|
5047
|
+
#
|
5048
|
+
# A UK National Health Service Number is a 10-17 digit number,
|
5049
|
+
# such as *485 555 3456*. The current system formats the 10-digit
|
5050
|
+
# number with spaces after the third and sixth digits. The final
|
5051
|
+
# digit is an error-detecting checksum.
|
5052
|
+
#
|
5053
|
+
# * **UK\_NATIONAL\_INSURANCE\_NUMBER**
|
5054
|
+
#
|
5055
|
+
# A UK National Insurance Number (NINO) provides individuals with
|
5056
|
+
# access to National Insurance (social security) benefits. It is
|
5057
|
+
# also used for some purposes in the UK tax system.
|
5058
|
+
#
|
5059
|
+
# The number is nine digits long and starts with two letters,
|
5060
|
+
# followed by six numbers and one letter. A NINO can be formatted
|
5061
|
+
# with a space or a dash after the two letters and after the
|
5062
|
+
# second, forth, and sixth digits.
|
5063
|
+
#
|
5064
|
+
# * **UK\_UNIQUE\_TAXPAYER\_REFERENCE\_NUMBER**
|
5065
|
+
#
|
5066
|
+
# A UK Unique Taxpayer Reference (UTR) is a 10-digit number that
|
5067
|
+
# identifies a taxpayer or a business.
|
5068
|
+
# * **Custom**
|
5069
|
+
#
|
5070
|
+
# * **Regex filter** - You can use a regular expressions to define
|
5071
|
+
# patterns for an AI Guardrail to recognize and act upon such as
|
5072
|
+
# serial number, booking ID etc..
|
5073
|
+
#
|
5074
|
+
# ^
|
5075
|
+
#
|
5076
|
+
#
|
5077
|
+
#
|
5078
|
+
# [1]: https://www.iban.com/structure
|
5079
|
+
# [2]: https://www.wikipedia.org/wiki/Luhn_algorithm
|
5080
|
+
# @return [String]
|
5081
|
+
#
|
5082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailPiiEntityConfig AWS API Documentation
|
5083
|
+
#
|
5084
|
+
class GuardrailPiiEntityConfig < Struct.new(
|
5085
|
+
:action,
|
5086
|
+
:type)
|
5087
|
+
SENSITIVE = [:action, :type]
|
5088
|
+
include Aws::Structure
|
5089
|
+
end
|
5090
|
+
|
5091
|
+
# The regular expression to configure for the AI Guardrail.
|
5092
|
+
#
|
5093
|
+
# @!attribute [rw] action
|
5094
|
+
# The AI Guardrail action to configure when matching regular
|
5095
|
+
# expression is detected.
|
5096
|
+
# @return [String]
|
5097
|
+
#
|
5098
|
+
# @!attribute [rw] description
|
5099
|
+
# The description of the regular expression to configure for the AI
|
5100
|
+
# Guardrail.
|
5101
|
+
# @return [String]
|
5102
|
+
#
|
5103
|
+
# @!attribute [rw] name
|
5104
|
+
# The name of the regular expression to configure for the AI
|
5105
|
+
# Guardrail.
|
5106
|
+
# @return [String]
|
5107
|
+
#
|
5108
|
+
# @!attribute [rw] pattern
|
5109
|
+
# The regular expression pattern to configure for the AI Guardrail.
|
5110
|
+
# @return [String]
|
5111
|
+
#
|
5112
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailRegexConfig AWS API Documentation
|
5113
|
+
#
|
5114
|
+
class GuardrailRegexConfig < Struct.new(
|
5115
|
+
:action,
|
5116
|
+
:description,
|
5117
|
+
:name,
|
5118
|
+
:pattern)
|
5119
|
+
SENSITIVE = [:action, :description, :name, :pattern]
|
5120
|
+
include Aws::Structure
|
5121
|
+
end
|
5122
|
+
|
5123
|
+
# Details about topics for the AI Guardrail to identify and deny.
|
5124
|
+
#
|
5125
|
+
# @!attribute [rw] definition
|
5126
|
+
# A definition of the topic to deny.
|
5127
|
+
# @return [String]
|
5128
|
+
#
|
5129
|
+
# @!attribute [rw] examples
|
5130
|
+
# A list of prompts, each of which is an example of a prompt that can
|
5131
|
+
# be categorized as belonging to the topic.
|
5132
|
+
# @return [Array<String>]
|
5133
|
+
#
|
5134
|
+
# @!attribute [rw] name
|
5135
|
+
# The name of the topic to deny.
|
5136
|
+
# @return [String]
|
5137
|
+
#
|
5138
|
+
# @!attribute [rw] type
|
5139
|
+
# Specifies to deny the topic.
|
5140
|
+
# @return [String]
|
5141
|
+
#
|
5142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailTopicConfig AWS API Documentation
|
5143
|
+
#
|
5144
|
+
class GuardrailTopicConfig < Struct.new(
|
5145
|
+
:definition,
|
5146
|
+
:examples,
|
5147
|
+
:name,
|
5148
|
+
:type)
|
5149
|
+
SENSITIVE = [:definition, :examples, :name, :type]
|
5150
|
+
include Aws::Structure
|
5151
|
+
end
|
5152
|
+
|
5153
|
+
# A word to configure for the AI Guardrail.
|
5154
|
+
#
|
5155
|
+
# @!attribute [rw] text
|
5156
|
+
# Text of the word configured for the AI Guardrail to block.
|
5157
|
+
# @return [String]
|
5158
|
+
#
|
5159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailWordConfig AWS API Documentation
|
5160
|
+
#
|
5161
|
+
class GuardrailWordConfig < Struct.new(
|
5162
|
+
:text)
|
5163
|
+
SENSITIVE = [:text]
|
5164
|
+
include Aws::Structure
|
5165
|
+
end
|
5166
|
+
|
5167
|
+
# Settings for hierarchical document chunking for a data source.
|
5168
|
+
# Hierarchical chunking splits documents into layers of chunks where the
|
5169
|
+
# first layer contains large chunks, and the second layer contains
|
5170
|
+
# smaller chunks derived from the first layer.
|
5171
|
+
#
|
5172
|
+
# @!attribute [rw] level_configurations
|
5173
|
+
# Token settings for each layer.
|
5174
|
+
# @return [Array<Types::HierarchicalChunkingLevelConfiguration>]
|
5175
|
+
#
|
5176
|
+
# @!attribute [rw] overlap_tokens
|
5177
|
+
# The number of tokens to repeat across chunks in the same layer.
|
5178
|
+
# @return [Integer]
|
5179
|
+
#
|
5180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/HierarchicalChunkingConfiguration AWS API Documentation
|
5181
|
+
#
|
5182
|
+
class HierarchicalChunkingConfiguration < Struct.new(
|
5183
|
+
:level_configurations,
|
5184
|
+
:overlap_tokens)
|
5185
|
+
SENSITIVE = []
|
5186
|
+
include Aws::Structure
|
5187
|
+
end
|
5188
|
+
|
5189
|
+
# Token settings for each layer.
|
5190
|
+
#
|
5191
|
+
# @!attribute [rw] max_tokens
|
5192
|
+
# The maximum number of tokens that a chunk can contain in this layer.
|
5193
|
+
# @return [Integer]
|
5194
|
+
#
|
5195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/HierarchicalChunkingLevelConfiguration AWS API Documentation
|
5196
|
+
#
|
5197
|
+
class HierarchicalChunkingLevelConfiguration < Struct.new(
|
5198
|
+
:max_tokens)
|
5199
|
+
SENSITIVE = []
|
5200
|
+
include Aws::Structure
|
5201
|
+
end
|
5202
|
+
|
5203
|
+
# Offset specification to describe highlighting of document excerpts for
|
5204
|
+
# rendering search results and recommendations.
|
5205
|
+
#
|
5206
|
+
# @!attribute [rw] begin_offset_inclusive
|
5207
|
+
# The offset for the start of the highlight.
|
3302
5208
|
# @return [Integer]
|
3303
5209
|
#
|
3304
5210
|
# @!attribute [rw] end_offset_exclusive
|
@@ -3822,6 +5728,100 @@ module Aws::QConnect
|
|
3822
5728
|
include Aws::Structure
|
3823
5729
|
end
|
3824
5730
|
|
5731
|
+
# @!attribute [rw] ai_guardrail_id
|
5732
|
+
# The identifier of the Amazon Q in Connect AI Guardrail for which
|
5733
|
+
# versions are to be listed.
|
5734
|
+
# @return [String]
|
5735
|
+
#
|
5736
|
+
# @!attribute [rw] assistant_id
|
5737
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
5738
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
5739
|
+
# @return [String]
|
5740
|
+
#
|
5741
|
+
# @!attribute [rw] max_results
|
5742
|
+
# The maximum number of results to return per page.
|
5743
|
+
# @return [Integer]
|
5744
|
+
#
|
5745
|
+
# @!attribute [rw] next_token
|
5746
|
+
# The token for the next set of results. Use the value returned in the
|
5747
|
+
# previous response in the next request to retrieve the next set of
|
5748
|
+
# results.
|
5749
|
+
# @return [String]
|
5750
|
+
#
|
5751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsRequest AWS API Documentation
|
5752
|
+
#
|
5753
|
+
class ListAIGuardrailVersionsRequest < Struct.new(
|
5754
|
+
:ai_guardrail_id,
|
5755
|
+
:assistant_id,
|
5756
|
+
:max_results,
|
5757
|
+
:next_token)
|
5758
|
+
SENSITIVE = []
|
5759
|
+
include Aws::Structure
|
5760
|
+
end
|
5761
|
+
|
5762
|
+
# @!attribute [rw] ai_guardrail_version_summaries
|
5763
|
+
# The summaries of the AI Guardrail versions.
|
5764
|
+
# @return [Array<Types::AIGuardrailVersionSummary>]
|
5765
|
+
#
|
5766
|
+
# @!attribute [rw] next_token
|
5767
|
+
# The token for the next set of results. Use the value returned in the
|
5768
|
+
# previous response in the next request to retrieve the next set of
|
5769
|
+
# results.
|
5770
|
+
# @return [String]
|
5771
|
+
#
|
5772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsResponse AWS API Documentation
|
5773
|
+
#
|
5774
|
+
class ListAIGuardrailVersionsResponse < Struct.new(
|
5775
|
+
:ai_guardrail_version_summaries,
|
5776
|
+
:next_token)
|
5777
|
+
SENSITIVE = []
|
5778
|
+
include Aws::Structure
|
5779
|
+
end
|
5780
|
+
|
5781
|
+
# @!attribute [rw] assistant_id
|
5782
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
5783
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
5784
|
+
# @return [String]
|
5785
|
+
#
|
5786
|
+
# @!attribute [rw] max_results
|
5787
|
+
# The maximum number of results to return per page.
|
5788
|
+
# @return [Integer]
|
5789
|
+
#
|
5790
|
+
# @!attribute [rw] next_token
|
5791
|
+
# The token for the next set of results. Use the value returned in the
|
5792
|
+
# previous response in the next request to retrieve the next set of
|
5793
|
+
# results.
|
5794
|
+
# @return [String]
|
5795
|
+
#
|
5796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsRequest AWS API Documentation
|
5797
|
+
#
|
5798
|
+
class ListAIGuardrailsRequest < Struct.new(
|
5799
|
+
:assistant_id,
|
5800
|
+
:max_results,
|
5801
|
+
:next_token)
|
5802
|
+
SENSITIVE = []
|
5803
|
+
include Aws::Structure
|
5804
|
+
end
|
5805
|
+
|
5806
|
+
# @!attribute [rw] ai_guardrail_summaries
|
5807
|
+
# The summaries of the AI Guardrails.
|
5808
|
+
# @return [Array<Types::AIGuardrailSummary>]
|
5809
|
+
#
|
5810
|
+
# @!attribute [rw] next_token
|
5811
|
+
# The token for the next set of results. Use the value returned in the
|
5812
|
+
# previous response in the next request to retrieve the next set of
|
5813
|
+
# results.
|
5814
|
+
# @return [String]
|
5815
|
+
#
|
5816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsResponse AWS API Documentation
|
5817
|
+
#
|
5818
|
+
class ListAIGuardrailsResponse < Struct.new(
|
5819
|
+
:ai_guardrail_summaries,
|
5820
|
+
:next_token)
|
5821
|
+
SENSITIVE = []
|
5822
|
+
include Aws::Structure
|
5823
|
+
end
|
5824
|
+
|
3825
5825
|
# @!attribute [rw] ai_prompt_id
|
3826
5826
|
# The identifier of the Amazon Q in Connect AI prompt for which
|
3827
5827
|
# versions are to be listed.
|
@@ -4106,191 +6106,1011 @@ module Aws::QConnect
|
|
4106
6106
|
# ARN. URLs cannot contain the ARN.
|
4107
6107
|
# @return [String]
|
4108
6108
|
#
|
4109
|
-
# @!attribute [rw] max_results
|
4110
|
-
# The maximum number of results to return per page.
|
4111
|
-
# @return [Integer]
|
4112
|
-
#
|
4113
|
-
# @!attribute [rw] next_token
|
4114
|
-
# The token for the next set of results. Use the value returned in the
|
4115
|
-
# previous response in the next request to retrieve the next set of
|
4116
|
-
# results.
|
6109
|
+
# @!attribute [rw] max_results
|
6110
|
+
# The maximum number of results to return per page.
|
6111
|
+
# @return [Integer]
|
6112
|
+
#
|
6113
|
+
# @!attribute [rw] next_token
|
6114
|
+
# The token for the next set of results. Use the value returned in the
|
6115
|
+
# previous response in the next request to retrieve the next set of
|
6116
|
+
# results.
|
6117
|
+
# @return [String]
|
6118
|
+
#
|
6119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobsRequest AWS API Documentation
|
6120
|
+
#
|
6121
|
+
class ListImportJobsRequest < Struct.new(
|
6122
|
+
:knowledge_base_id,
|
6123
|
+
:max_results,
|
6124
|
+
:next_token)
|
6125
|
+
SENSITIVE = []
|
6126
|
+
include Aws::Structure
|
6127
|
+
end
|
6128
|
+
|
6129
|
+
# @!attribute [rw] import_job_summaries
|
6130
|
+
# Summary information about the import jobs.
|
6131
|
+
# @return [Array<Types::ImportJobSummary>]
|
6132
|
+
#
|
6133
|
+
# @!attribute [rw] next_token
|
6134
|
+
# The token for the next set of results. Use the value returned in the
|
6135
|
+
# previous response in the next request to retrieve the next set of
|
6136
|
+
# results.
|
6137
|
+
# @return [String]
|
6138
|
+
#
|
6139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListImportJobsResponse AWS API Documentation
|
6140
|
+
#
|
6141
|
+
class ListImportJobsResponse < Struct.new(
|
6142
|
+
:import_job_summaries,
|
6143
|
+
:next_token)
|
6144
|
+
SENSITIVE = []
|
6145
|
+
include Aws::Structure
|
6146
|
+
end
|
6147
|
+
|
6148
|
+
# @!attribute [rw] max_results
|
6149
|
+
# The maximum number of results to return per page.
|
6150
|
+
# @return [Integer]
|
6151
|
+
#
|
6152
|
+
# @!attribute [rw] next_token
|
6153
|
+
# The token for the next set of results. Use the value returned in the
|
6154
|
+
# previous response in the next request to retrieve the next set of
|
6155
|
+
# results.
|
6156
|
+
# @return [String]
|
6157
|
+
#
|
6158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBasesRequest AWS API Documentation
|
6159
|
+
#
|
6160
|
+
class ListKnowledgeBasesRequest < Struct.new(
|
6161
|
+
:max_results,
|
6162
|
+
:next_token)
|
6163
|
+
SENSITIVE = []
|
6164
|
+
include Aws::Structure
|
6165
|
+
end
|
6166
|
+
|
6167
|
+
# @!attribute [rw] knowledge_base_summaries
|
6168
|
+
# Information about the knowledge bases.
|
6169
|
+
# @return [Array<Types::KnowledgeBaseSummary>]
|
6170
|
+
#
|
6171
|
+
# @!attribute [rw] next_token
|
6172
|
+
# If there are additional results, this is the token for the next set
|
6173
|
+
# of results.
|
6174
|
+
# @return [String]
|
6175
|
+
#
|
6176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListKnowledgeBasesResponse AWS API Documentation
|
6177
|
+
#
|
6178
|
+
class ListKnowledgeBasesResponse < Struct.new(
|
6179
|
+
:knowledge_base_summaries,
|
6180
|
+
:next_token)
|
6181
|
+
SENSITIVE = []
|
6182
|
+
include Aws::Structure
|
6183
|
+
end
|
6184
|
+
|
6185
|
+
# @!attribute [rw] knowledge_base_id
|
6186
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
6187
|
+
# ARN. URLs cannot contain the ARN.
|
6188
|
+
# @return [String]
|
6189
|
+
#
|
6190
|
+
# @!attribute [rw] max_results
|
6191
|
+
# The maximum number of results to return per page.
|
6192
|
+
# @return [Integer]
|
6193
|
+
#
|
6194
|
+
# @!attribute [rw] message_template_id
|
6195
|
+
# The identifier of the message template. Can be either the ID or the
|
6196
|
+
# ARN. It cannot contain any qualifier.
|
6197
|
+
# @return [String]
|
6198
|
+
#
|
6199
|
+
# @!attribute [rw] next_token
|
6200
|
+
# The token for the next set of results. Use the value returned in the
|
6201
|
+
# previous response in the next request to retrieve the next set of
|
6202
|
+
# results.
|
6203
|
+
# @return [String]
|
6204
|
+
#
|
6205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersionsRequest AWS API Documentation
|
6206
|
+
#
|
6207
|
+
class ListMessageTemplateVersionsRequest < Struct.new(
|
6208
|
+
:knowledge_base_id,
|
6209
|
+
:max_results,
|
6210
|
+
:message_template_id,
|
6211
|
+
:next_token)
|
6212
|
+
SENSITIVE = []
|
6213
|
+
include Aws::Structure
|
6214
|
+
end
|
6215
|
+
|
6216
|
+
# @!attribute [rw] message_template_version_summaries
|
6217
|
+
# Summary information about the versions of a message template.
|
6218
|
+
# @return [Array<Types::MessageTemplateVersionSummary>]
|
6219
|
+
#
|
6220
|
+
# @!attribute [rw] next_token
|
6221
|
+
# If there are additional results, this is the token for the next set
|
6222
|
+
# of results.
|
6223
|
+
# @return [String]
|
6224
|
+
#
|
6225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplateVersionsResponse AWS API Documentation
|
6226
|
+
#
|
6227
|
+
class ListMessageTemplateVersionsResponse < Struct.new(
|
6228
|
+
:message_template_version_summaries,
|
6229
|
+
:next_token)
|
6230
|
+
SENSITIVE = []
|
6231
|
+
include Aws::Structure
|
6232
|
+
end
|
6233
|
+
|
6234
|
+
# @!attribute [rw] knowledge_base_id
|
6235
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
6236
|
+
# ARN. URLs cannot contain the ARN.
|
6237
|
+
# @return [String]
|
6238
|
+
#
|
6239
|
+
# @!attribute [rw] max_results
|
6240
|
+
# The maximum number of results to return per page.
|
6241
|
+
# @return [Integer]
|
6242
|
+
#
|
6243
|
+
# @!attribute [rw] next_token
|
6244
|
+
# The token for the next set of results. Use the value returned in the
|
6245
|
+
# previous response in the next request to retrieve the next set of
|
6246
|
+
# results.
|
6247
|
+
# @return [String]
|
6248
|
+
#
|
6249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplatesRequest AWS API Documentation
|
6250
|
+
#
|
6251
|
+
class ListMessageTemplatesRequest < Struct.new(
|
6252
|
+
:knowledge_base_id,
|
6253
|
+
:max_results,
|
6254
|
+
:next_token)
|
6255
|
+
SENSITIVE = []
|
6256
|
+
include Aws::Structure
|
6257
|
+
end
|
6258
|
+
|
6259
|
+
# @!attribute [rw] message_template_summaries
|
6260
|
+
# Summary information about the message template.
|
6261
|
+
# @return [Array<Types::MessageTemplateSummary>]
|
6262
|
+
#
|
6263
|
+
# @!attribute [rw] next_token
|
6264
|
+
# If there are additional results, this is the token for the next set
|
6265
|
+
# of results.
|
6266
|
+
# @return [String]
|
6267
|
+
#
|
6268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessageTemplatesResponse AWS API Documentation
|
6269
|
+
#
|
6270
|
+
class ListMessageTemplatesResponse < Struct.new(
|
6271
|
+
:message_template_summaries,
|
6272
|
+
:next_token)
|
6273
|
+
SENSITIVE = []
|
6274
|
+
include Aws::Structure
|
6275
|
+
end
|
6276
|
+
|
6277
|
+
# @!attribute [rw] assistant_id
|
6278
|
+
# The identifier of the Amazon Q in Connect assistant.
|
6279
|
+
# @return [String]
|
6280
|
+
#
|
6281
|
+
# @!attribute [rw] max_results
|
6282
|
+
# The maximum number of results to return per page.
|
6283
|
+
# @return [Integer]
|
6284
|
+
#
|
6285
|
+
# @!attribute [rw] next_token
|
6286
|
+
# The token for the next set of results. Use the value returned in the
|
6287
|
+
# previous response in the next request to retrieve the next set of
|
6288
|
+
# results.
|
6289
|
+
# @return [String]
|
6290
|
+
#
|
6291
|
+
# @!attribute [rw] session_id
|
6292
|
+
# The identifier of the Amazon Q in Connect session.
|
6293
|
+
# @return [String]
|
6294
|
+
#
|
6295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesRequest AWS API Documentation
|
6296
|
+
#
|
6297
|
+
class ListMessagesRequest < Struct.new(
|
6298
|
+
:assistant_id,
|
6299
|
+
:max_results,
|
6300
|
+
:next_token,
|
6301
|
+
:session_id)
|
6302
|
+
SENSITIVE = []
|
6303
|
+
include Aws::Structure
|
6304
|
+
end
|
6305
|
+
|
6306
|
+
# @!attribute [rw] messages
|
6307
|
+
# The message information.
|
6308
|
+
# @return [Array<Types::MessageOutput>]
|
6309
|
+
#
|
6310
|
+
# @!attribute [rw] next_token
|
6311
|
+
# The token for the next set of results. Use the value returned in the
|
6312
|
+
# previous response in the next request to retrieve the next set of
|
6313
|
+
# results.
|
6314
|
+
# @return [String]
|
6315
|
+
#
|
6316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesResponse AWS API Documentation
|
6317
|
+
#
|
6318
|
+
class ListMessagesResponse < Struct.new(
|
6319
|
+
:messages,
|
6320
|
+
:next_token)
|
6321
|
+
SENSITIVE = []
|
6322
|
+
include Aws::Structure
|
6323
|
+
end
|
6324
|
+
|
6325
|
+
# @!attribute [rw] knowledge_base_id
|
6326
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
6327
|
+
# ARN. URLs cannot contain the ARN.
|
6328
|
+
# @return [String]
|
6329
|
+
#
|
6330
|
+
# @!attribute [rw] max_results
|
6331
|
+
# The maximum number of results to return per page.
|
6332
|
+
# @return [Integer]
|
6333
|
+
#
|
6334
|
+
# @!attribute [rw] next_token
|
6335
|
+
# The token for the next set of results. Use the value returned in the
|
6336
|
+
# previous response in the next request to retrieve the next set of
|
6337
|
+
# results.
|
6338
|
+
# @return [String]
|
6339
|
+
#
|
6340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesRequest AWS API Documentation
|
6341
|
+
#
|
6342
|
+
class ListQuickResponsesRequest < Struct.new(
|
6343
|
+
:knowledge_base_id,
|
6344
|
+
:max_results,
|
6345
|
+
:next_token)
|
6346
|
+
SENSITIVE = []
|
6347
|
+
include Aws::Structure
|
6348
|
+
end
|
6349
|
+
|
6350
|
+
# @!attribute [rw] next_token
|
6351
|
+
# The token for the next set of results. Use the value returned in the
|
6352
|
+
# previous response in the next request to retrieve the next set of
|
6353
|
+
# results.
|
6354
|
+
# @return [String]
|
6355
|
+
#
|
6356
|
+
# @!attribute [rw] quick_response_summaries
|
6357
|
+
# Summary information about the quick responses.
|
6358
|
+
# @return [Array<Types::QuickResponseSummary>]
|
6359
|
+
#
|
6360
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListQuickResponsesResponse AWS API Documentation
|
6361
|
+
#
|
6362
|
+
class ListQuickResponsesResponse < Struct.new(
|
6363
|
+
:next_token,
|
6364
|
+
:quick_response_summaries)
|
6365
|
+
SENSITIVE = []
|
6366
|
+
include Aws::Structure
|
6367
|
+
end
|
6368
|
+
|
6369
|
+
# @!attribute [rw] resource_arn
|
6370
|
+
# The Amazon Resource Name (ARN) of the resource.
|
6371
|
+
# @return [String]
|
6372
|
+
#
|
6373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceRequest AWS API Documentation
|
6374
|
+
#
|
6375
|
+
class ListTagsForResourceRequest < Struct.new(
|
6376
|
+
:resource_arn)
|
6377
|
+
SENSITIVE = []
|
6378
|
+
include Aws::Structure
|
6379
|
+
end
|
6380
|
+
|
6381
|
+
# @!attribute [rw] tags
|
6382
|
+
# The tags used to organize, track, or control access for this
|
6383
|
+
# resource.
|
6384
|
+
# @return [Hash<String,String>]
|
6385
|
+
#
|
6386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListTagsForResourceResponse AWS API Documentation
|
6387
|
+
#
|
6388
|
+
class ListTagsForResourceResponse < Struct.new(
|
6389
|
+
:tags)
|
6390
|
+
SENSITIVE = []
|
6391
|
+
include Aws::Structure
|
6392
|
+
end
|
6393
|
+
|
6394
|
+
# Source configuration for managed resources.
|
6395
|
+
#
|
6396
|
+
# @note ManagedSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
6397
|
+
#
|
6398
|
+
# @note ManagedSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManagedSourceConfiguration corresponding to the set member.
|
6399
|
+
#
|
6400
|
+
# @!attribute [rw] web_crawler_configuration
|
6401
|
+
# Configuration data for web crawler data source.
|
6402
|
+
# @return [Types::WebCrawlerConfiguration]
|
6403
|
+
#
|
6404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManagedSourceConfiguration AWS API Documentation
|
6405
|
+
#
|
6406
|
+
class ManagedSourceConfiguration < Struct.new(
|
6407
|
+
:web_crawler_configuration,
|
6408
|
+
:unknown)
|
6409
|
+
SENSITIVE = []
|
6410
|
+
include Aws::Structure
|
6411
|
+
include Aws::Structure::Union
|
6412
|
+
|
6413
|
+
class WebCrawlerConfiguration < ManagedSourceConfiguration; end
|
6414
|
+
class Unknown < ManagedSourceConfiguration; end
|
6415
|
+
end
|
6416
|
+
|
6417
|
+
# The configuration for the `MANUAL_SEARCH` AI Agent type.
|
6418
|
+
#
|
6419
|
+
# @!attribute [rw] answer_generation_ai_guardrail_id
|
6420
|
+
# The AI Guardrail identifier for the Answer Generation guardrail used
|
6421
|
+
# by the MANUAL\_SEARCH AI Agent.
|
6422
|
+
# @return [String]
|
6423
|
+
#
|
6424
|
+
# @!attribute [rw] answer_generation_ai_prompt_id
|
6425
|
+
# The AI Prompt identifier for the Answer Generation prompt used by
|
6426
|
+
# the MANUAL\_SEARCH AI Agent.
|
6427
|
+
# @return [String]
|
6428
|
+
#
|
6429
|
+
# @!attribute [rw] association_configurations
|
6430
|
+
# The association configurations for overriding behavior on this AI
|
6431
|
+
# Agent.
|
6432
|
+
# @return [Array<Types::AssociationConfiguration>]
|
6433
|
+
#
|
6434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
|
6435
|
+
#
|
6436
|
+
class ManualSearchAIAgentConfiguration < Struct.new(
|
6437
|
+
:answer_generation_ai_guardrail_id,
|
6438
|
+
:answer_generation_ai_prompt_id,
|
6439
|
+
:association_configurations)
|
6440
|
+
SENSITIVE = []
|
6441
|
+
include Aws::Structure
|
6442
|
+
end
|
6443
|
+
|
6444
|
+
# The message data.
|
6445
|
+
#
|
6446
|
+
# @note MessageData is a union - when making an API calls you must set exactly one of the members.
|
6447
|
+
#
|
6448
|
+
# @note MessageData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageData corresponding to the set member.
|
6449
|
+
#
|
6450
|
+
# @!attribute [rw] text
|
6451
|
+
# The message data in text type.
|
6452
|
+
# @return [Types::TextMessage]
|
6453
|
+
#
|
6454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageData AWS API Documentation
|
6455
|
+
#
|
6456
|
+
class MessageData < Struct.new(
|
6457
|
+
:text,
|
6458
|
+
:unknown)
|
6459
|
+
SENSITIVE = []
|
6460
|
+
include Aws::Structure
|
6461
|
+
include Aws::Structure::Union
|
6462
|
+
|
6463
|
+
class Text < MessageData; end
|
6464
|
+
class Unknown < MessageData; end
|
6465
|
+
end
|
6466
|
+
|
6467
|
+
# The message input.
|
6468
|
+
#
|
6469
|
+
# @!attribute [rw] value
|
6470
|
+
# The message input value.
|
6471
|
+
# @return [Types::MessageData]
|
6472
|
+
#
|
6473
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageInput AWS API Documentation
|
6474
|
+
#
|
6475
|
+
class MessageInput < Struct.new(
|
6476
|
+
:value)
|
6477
|
+
SENSITIVE = []
|
6478
|
+
include Aws::Structure
|
6479
|
+
end
|
6480
|
+
|
6481
|
+
# The message output.
|
6482
|
+
#
|
6483
|
+
# @!attribute [rw] message_id
|
6484
|
+
# The identifier of a message.
|
6485
|
+
# @return [String]
|
6486
|
+
#
|
6487
|
+
# @!attribute [rw] participant
|
6488
|
+
# The participant of a message.
|
6489
|
+
# @return [String]
|
6490
|
+
#
|
6491
|
+
# @!attribute [rw] timestamp
|
6492
|
+
# The timestamp of a message.
|
6493
|
+
# @return [Time]
|
6494
|
+
#
|
6495
|
+
# @!attribute [rw] value
|
6496
|
+
# The value of a message data.
|
6497
|
+
# @return [Types::MessageData]
|
6498
|
+
#
|
6499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageOutput AWS API Documentation
|
6500
|
+
#
|
6501
|
+
class MessageOutput < Struct.new(
|
6502
|
+
:message_id,
|
6503
|
+
:participant,
|
6504
|
+
:timestamp,
|
6505
|
+
:value)
|
6506
|
+
SENSITIVE = []
|
6507
|
+
include Aws::Structure
|
6508
|
+
end
|
6509
|
+
|
6510
|
+
# Information about the message template attachment.
|
6511
|
+
#
|
6512
|
+
# @!attribute [rw] attachment_id
|
6513
|
+
# The identifier of the attachment file.
|
6514
|
+
# @return [String]
|
6515
|
+
#
|
6516
|
+
# @!attribute [rw] content_disposition
|
6517
|
+
# The presentation information for the attachment file.
|
6518
|
+
# @return [String]
|
6519
|
+
#
|
6520
|
+
# @!attribute [rw] name
|
6521
|
+
# The name of the attachment file being uploaded. The name should
|
6522
|
+
# include the file extension.
|
6523
|
+
# @return [String]
|
6524
|
+
#
|
6525
|
+
# @!attribute [rw] uploaded_time
|
6526
|
+
# The timestamp when the attachment file was uploaded.
|
6527
|
+
# @return [Time]
|
6528
|
+
#
|
6529
|
+
# @!attribute [rw] url
|
6530
|
+
# A pre-signed Amazon S3 URL that can be used to download the
|
6531
|
+
# attachment file.
|
6532
|
+
# @return [String]
|
6533
|
+
#
|
6534
|
+
# @!attribute [rw] url_expiry
|
6535
|
+
# The expiration time of the pre-signed Amazon S3 URL.
|
6536
|
+
# @return [Time]
|
6537
|
+
#
|
6538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateAttachment AWS API Documentation
|
6539
|
+
#
|
6540
|
+
class MessageTemplateAttachment < Struct.new(
|
6541
|
+
:attachment_id,
|
6542
|
+
:content_disposition,
|
6543
|
+
:name,
|
6544
|
+
:uploaded_time,
|
6545
|
+
:url,
|
6546
|
+
:url_expiry)
|
6547
|
+
SENSITIVE = [:name, :url]
|
6548
|
+
include Aws::Structure
|
6549
|
+
end
|
6550
|
+
|
6551
|
+
# The attributes that are used with the message template.
|
6552
|
+
#
|
6553
|
+
# @!attribute [rw] agent_attributes
|
6554
|
+
# The agent attributes that are used with the message template.
|
6555
|
+
# @return [Types::AgentAttributes]
|
6556
|
+
#
|
6557
|
+
# @!attribute [rw] custom_attributes
|
6558
|
+
# The custom attributes that are used with the message template.
|
6559
|
+
# @return [Hash<String,String>]
|
6560
|
+
#
|
6561
|
+
# @!attribute [rw] customer_profile_attributes
|
6562
|
+
# The customer profile attributes that are used with the message
|
6563
|
+
# template.
|
6564
|
+
# @return [Types::CustomerProfileAttributes]
|
6565
|
+
#
|
6566
|
+
# @!attribute [rw] system_attributes
|
6567
|
+
# The system attributes that are used with the message template.
|
6568
|
+
# @return [Types::SystemAttributes]
|
6569
|
+
#
|
6570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateAttributes AWS API Documentation
|
6571
|
+
#
|
6572
|
+
class MessageTemplateAttributes < Struct.new(
|
6573
|
+
:agent_attributes,
|
6574
|
+
:custom_attributes,
|
6575
|
+
:customer_profile_attributes,
|
6576
|
+
:system_attributes)
|
6577
|
+
SENSITIVE = [:custom_attributes]
|
6578
|
+
include Aws::Structure
|
6579
|
+
end
|
6580
|
+
|
6581
|
+
# The container of the message template body.
|
6582
|
+
#
|
6583
|
+
# @note MessageTemplateBodyContentProvider is a union - when making an API calls you must set exactly one of the members.
|
6584
|
+
#
|
6585
|
+
# @note MessageTemplateBodyContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateBodyContentProvider corresponding to the set member.
|
6586
|
+
#
|
6587
|
+
# @!attribute [rw] content
|
6588
|
+
# The content of the message template.
|
6589
|
+
# @return [String]
|
6590
|
+
#
|
6591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateBodyContentProvider AWS API Documentation
|
6592
|
+
#
|
6593
|
+
class MessageTemplateBodyContentProvider < Struct.new(
|
6594
|
+
:content,
|
6595
|
+
:unknown)
|
6596
|
+
SENSITIVE = [:content]
|
6597
|
+
include Aws::Structure
|
6598
|
+
include Aws::Structure::Union
|
6599
|
+
|
6600
|
+
class Content < MessageTemplateBodyContentProvider; end
|
6601
|
+
class Unknown < MessageTemplateBodyContentProvider; end
|
6602
|
+
end
|
6603
|
+
|
6604
|
+
# The container of message template content.
|
6605
|
+
#
|
6606
|
+
# @note MessageTemplateContentProvider is a union - when making an API calls you must set exactly one of the members.
|
6607
|
+
#
|
6608
|
+
# @note MessageTemplateContentProvider is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateContentProvider corresponding to the set member.
|
6609
|
+
#
|
6610
|
+
# @!attribute [rw] email
|
6611
|
+
# The content of the message template that applies to the email
|
6612
|
+
# channel subtype.
|
6613
|
+
# @return [Types::EmailMessageTemplateContent]
|
6614
|
+
#
|
6615
|
+
# @!attribute [rw] sms
|
6616
|
+
# The content of the message template that applies to the SMS channel
|
6617
|
+
# subtype.
|
6618
|
+
# @return [Types::SMSMessageTemplateContent]
|
6619
|
+
#
|
6620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateContentProvider AWS API Documentation
|
6621
|
+
#
|
6622
|
+
class MessageTemplateContentProvider < Struct.new(
|
6623
|
+
:email,
|
6624
|
+
:sms,
|
6625
|
+
:unknown)
|
6626
|
+
SENSITIVE = []
|
6627
|
+
include Aws::Structure
|
6628
|
+
include Aws::Structure::Union
|
6629
|
+
|
6630
|
+
class Email < MessageTemplateContentProvider; end
|
6631
|
+
class Sms < MessageTemplateContentProvider; end
|
6632
|
+
class Unknown < MessageTemplateContentProvider; end
|
6633
|
+
end
|
6634
|
+
|
6635
|
+
# The data of a message template.
|
6636
|
+
#
|
6637
|
+
# @!attribute [rw] attribute_types
|
6638
|
+
# The types of attributes that the message template contains.
|
6639
|
+
# @return [Array<String>]
|
6640
|
+
#
|
6641
|
+
# @!attribute [rw] channel_subtype
|
6642
|
+
# The channel subtype this message template applies to.
|
6643
|
+
# @return [String]
|
6644
|
+
#
|
6645
|
+
# @!attribute [rw] content
|
6646
|
+
# The content of the message template.
|
6647
|
+
# @return [Types::MessageTemplateContentProvider]
|
6648
|
+
#
|
6649
|
+
# @!attribute [rw] created_time
|
6650
|
+
# The timestamp when the message template was created.
|
6651
|
+
# @return [Time]
|
6652
|
+
#
|
6653
|
+
# @!attribute [rw] default_attributes
|
6654
|
+
# An object that specifies the default values to use for variables in
|
6655
|
+
# the message template. This object contains different categories of
|
6656
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
6657
|
+
# message template. The corresponding value defines the default value
|
6658
|
+
# for that variable.
|
6659
|
+
# @return [Types::MessageTemplateAttributes]
|
6660
|
+
#
|
6661
|
+
# @!attribute [rw] description
|
6662
|
+
# The description of the message template.
|
6663
|
+
# @return [String]
|
6664
|
+
#
|
6665
|
+
# @!attribute [rw] grouping_configuration
|
6666
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
6667
|
+
# users.
|
6668
|
+
# @return [Types::GroupingConfiguration]
|
6669
|
+
#
|
6670
|
+
# @!attribute [rw] knowledge_base_arn
|
6671
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
6672
|
+
# @return [String]
|
6673
|
+
#
|
6674
|
+
# @!attribute [rw] knowledge_base_id
|
6675
|
+
# The identifier of the knowledge base.
|
6676
|
+
# @return [String]
|
6677
|
+
#
|
6678
|
+
# @!attribute [rw] language
|
6679
|
+
# The language code value for the language in which the quick response
|
6680
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
6681
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
6682
|
+
# `zh_CN`, `zh_TW`
|
6683
|
+
# @return [String]
|
6684
|
+
#
|
6685
|
+
# @!attribute [rw] last_modified_by
|
6686
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
6687
|
+
# message template data.
|
6688
|
+
# @return [String]
|
6689
|
+
#
|
6690
|
+
# @!attribute [rw] last_modified_time
|
6691
|
+
# The timestamp when the message template data was last modified.
|
6692
|
+
# @return [Time]
|
6693
|
+
#
|
6694
|
+
# @!attribute [rw] message_template_arn
|
6695
|
+
# The Amazon Resource Name (ARN) of the message template.
|
6696
|
+
# @return [String]
|
6697
|
+
#
|
6698
|
+
# @!attribute [rw] message_template_content_sha_256
|
6699
|
+
# The checksum value of the message template content that is
|
6700
|
+
# referenced by the `$LATEST` qualifier. It can be returned in
|
6701
|
+
# `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s
|
6702
|
+
# calculated by content, language, `defaultAttributes` and
|
6703
|
+
# `Attachments` of the message template.
|
6704
|
+
# @return [String]
|
6705
|
+
#
|
6706
|
+
# @!attribute [rw] message_template_id
|
6707
|
+
# The identifier of the message template.
|
6708
|
+
# @return [String]
|
6709
|
+
#
|
6710
|
+
# @!attribute [rw] name
|
6711
|
+
# The name of the message template.
|
6712
|
+
# @return [String]
|
6713
|
+
#
|
6714
|
+
# @!attribute [rw] tags
|
6715
|
+
# The tags used to organize, track, or control access for this
|
6716
|
+
# resource.
|
6717
|
+
# @return [Hash<String,String>]
|
6718
|
+
#
|
6719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateData AWS API Documentation
|
6720
|
+
#
|
6721
|
+
class MessageTemplateData < Struct.new(
|
6722
|
+
:attribute_types,
|
6723
|
+
:channel_subtype,
|
6724
|
+
:content,
|
6725
|
+
:created_time,
|
6726
|
+
:default_attributes,
|
6727
|
+
:description,
|
6728
|
+
:grouping_configuration,
|
6729
|
+
:knowledge_base_arn,
|
6730
|
+
:knowledge_base_id,
|
6731
|
+
:language,
|
6732
|
+
:last_modified_by,
|
6733
|
+
:last_modified_time,
|
6734
|
+
:message_template_arn,
|
6735
|
+
:message_template_content_sha_256,
|
6736
|
+
:message_template_id,
|
6737
|
+
:name,
|
6738
|
+
:tags)
|
6739
|
+
SENSITIVE = []
|
6740
|
+
include Aws::Structure
|
6741
|
+
end
|
6742
|
+
|
6743
|
+
# The message template fields to filter the message template query
|
6744
|
+
# results by. The following is the list of supported field names:
|
6745
|
+
#
|
6746
|
+
# * name
|
6747
|
+
#
|
6748
|
+
# * description
|
6749
|
+
#
|
6750
|
+
# * channel
|
6751
|
+
#
|
6752
|
+
# * channelSubtype
|
6753
|
+
#
|
6754
|
+
# * language
|
6755
|
+
#
|
6756
|
+
# * qualifier
|
6757
|
+
#
|
6758
|
+
# * createdTime
|
6759
|
+
#
|
6760
|
+
# * lastModifiedTime
|
6761
|
+
#
|
6762
|
+
# * lastModifiedBy
|
6763
|
+
#
|
6764
|
+
# * groupingConfiguration.criteria
|
6765
|
+
#
|
6766
|
+
# * groupingConfiguration.values
|
6767
|
+
#
|
6768
|
+
# @!attribute [rw] include_no_existence
|
6769
|
+
# Whether to treat null value as a match for the attribute field.
|
6770
|
+
# @return [Boolean]
|
6771
|
+
#
|
6772
|
+
# @!attribute [rw] name
|
6773
|
+
# The name of the attribute field to filter the message templates by.
|
6774
|
+
# @return [String]
|
6775
|
+
#
|
6776
|
+
# @!attribute [rw] operator
|
6777
|
+
# The operator to use for filtering.
|
6778
|
+
# @return [String]
|
6779
|
+
#
|
6780
|
+
# @!attribute [rw] values
|
6781
|
+
# The values of attribute field to filter the message template by.
|
6782
|
+
# @return [Array<String>]
|
6783
|
+
#
|
6784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateFilterField AWS API Documentation
|
6785
|
+
#
|
6786
|
+
class MessageTemplateFilterField < Struct.new(
|
6787
|
+
:include_no_existence,
|
6788
|
+
:name,
|
6789
|
+
:operator,
|
6790
|
+
:values)
|
6791
|
+
SENSITIVE = []
|
6792
|
+
include Aws::Structure
|
6793
|
+
end
|
6794
|
+
|
6795
|
+
# The message template fields to order the message template query
|
6796
|
+
# results by. The following is the list of supported field names:
|
6797
|
+
#
|
6798
|
+
# * name
|
6799
|
+
#
|
6800
|
+
# * description
|
6801
|
+
#
|
6802
|
+
# * channel
|
6803
|
+
#
|
6804
|
+
# * channelSubtype
|
6805
|
+
#
|
6806
|
+
# * language
|
6807
|
+
#
|
6808
|
+
# * qualifier
|
6809
|
+
#
|
6810
|
+
# * createdTime
|
6811
|
+
#
|
6812
|
+
# * lastModifiedTime
|
6813
|
+
#
|
6814
|
+
# * lastModifiedBy
|
6815
|
+
#
|
6816
|
+
# * groupingConfiguration.criteria
|
6817
|
+
#
|
6818
|
+
# * groupingConfiguration.values
|
6819
|
+
#
|
6820
|
+
# @!attribute [rw] name
|
6821
|
+
# The name of the message template.
|
6822
|
+
# @return [String]
|
6823
|
+
#
|
6824
|
+
# @!attribute [rw] order
|
6825
|
+
# The order at which the message templates are sorted by.
|
6826
|
+
# @return [String]
|
6827
|
+
#
|
6828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateOrderField AWS API Documentation
|
6829
|
+
#
|
6830
|
+
class MessageTemplateOrderField < Struct.new(
|
6831
|
+
:name,
|
6832
|
+
:order)
|
6833
|
+
SENSITIVE = []
|
6834
|
+
include Aws::Structure
|
6835
|
+
end
|
6836
|
+
|
6837
|
+
# The message template fields to query message templates by. The
|
6838
|
+
# following is the list of supported field names:
|
6839
|
+
#
|
6840
|
+
# * name
|
6841
|
+
#
|
6842
|
+
# * description
|
6843
|
+
#
|
6844
|
+
# @!attribute [rw] allow_fuzziness
|
6845
|
+
# Whether the query expects only exact matches on the attribute field
|
6846
|
+
# values. The results of the query will only include exact matches if
|
6847
|
+
# this parameter is set to false.
|
6848
|
+
# @return [Boolean]
|
6849
|
+
#
|
6850
|
+
# @!attribute [rw] name
|
6851
|
+
# The name of the attribute to query the message templates by.
|
6852
|
+
# @return [String]
|
6853
|
+
#
|
6854
|
+
# @!attribute [rw] operator
|
6855
|
+
# The operator to use for matching attribute field values in the
|
6856
|
+
# query.
|
6857
|
+
# @return [String]
|
6858
|
+
#
|
6859
|
+
# @!attribute [rw] priority
|
6860
|
+
# The importance of the attribute field when calculating query result
|
6861
|
+
# relevancy scores. The value set for this parameter affects the
|
6862
|
+
# ordering of search results.
|
6863
|
+
# @return [String]
|
6864
|
+
#
|
6865
|
+
# @!attribute [rw] values
|
6866
|
+
# The values of the attribute to query the message templates by.
|
6867
|
+
# @return [Array<String>]
|
6868
|
+
#
|
6869
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateQueryField AWS API Documentation
|
6870
|
+
#
|
6871
|
+
class MessageTemplateQueryField < Struct.new(
|
6872
|
+
:allow_fuzziness,
|
6873
|
+
:name,
|
6874
|
+
:operator,
|
6875
|
+
:priority,
|
6876
|
+
:values)
|
6877
|
+
SENSITIVE = []
|
6878
|
+
include Aws::Structure
|
6879
|
+
end
|
6880
|
+
|
6881
|
+
# The search expression of the message template.
|
6882
|
+
#
|
6883
|
+
# @!attribute [rw] filters
|
6884
|
+
# The configuration of filtering rules applied to message template
|
6885
|
+
# query results.
|
6886
|
+
# @return [Array<Types::MessageTemplateFilterField>]
|
6887
|
+
#
|
6888
|
+
# @!attribute [rw] order_on_field
|
6889
|
+
# The message template attribute fields on which the query results are
|
6890
|
+
# ordered.
|
6891
|
+
# @return [Types::MessageTemplateOrderField]
|
6892
|
+
#
|
6893
|
+
# @!attribute [rw] queries
|
6894
|
+
# The message template query expressions.
|
6895
|
+
# @return [Array<Types::MessageTemplateQueryField>]
|
6896
|
+
#
|
6897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSearchExpression AWS API Documentation
|
6898
|
+
#
|
6899
|
+
class MessageTemplateSearchExpression < Struct.new(
|
6900
|
+
:filters,
|
6901
|
+
:order_on_field,
|
6902
|
+
:queries)
|
6903
|
+
SENSITIVE = []
|
6904
|
+
include Aws::Structure
|
6905
|
+
end
|
6906
|
+
|
6907
|
+
# The result of message template search.
|
6908
|
+
#
|
6909
|
+
# @!attribute [rw] channel_subtype
|
6910
|
+
# The channel subtype this message template applies to.
|
6911
|
+
# @return [String]
|
6912
|
+
#
|
6913
|
+
# @!attribute [rw] created_time
|
6914
|
+
# The timestamp when the message template was created.
|
6915
|
+
# @return [Time]
|
6916
|
+
#
|
6917
|
+
# @!attribute [rw] description
|
6918
|
+
# The description of the message template.
|
6919
|
+
# @return [String]
|
6920
|
+
#
|
6921
|
+
# @!attribute [rw] grouping_configuration
|
6922
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
6923
|
+
# users.
|
6924
|
+
# @return [Types::GroupingConfiguration]
|
6925
|
+
#
|
6926
|
+
# @!attribute [rw] is_active
|
6927
|
+
# Whether the version of the message template is activated.
|
6928
|
+
# @return [Boolean]
|
6929
|
+
#
|
6930
|
+
# @!attribute [rw] knowledge_base_arn
|
6931
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
6932
|
+
# @return [String]
|
6933
|
+
#
|
6934
|
+
# @!attribute [rw] knowledge_base_id
|
6935
|
+
# The identifier of the knowledge base.
|
6936
|
+
# @return [String]
|
6937
|
+
#
|
6938
|
+
# @!attribute [rw] language
|
6939
|
+
# The language code value for the language in which the quick response
|
6940
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
6941
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
6942
|
+
# `zh_CN`, `zh_TW`
|
6943
|
+
# @return [String]
|
6944
|
+
#
|
6945
|
+
# @!attribute [rw] last_modified_by
|
6946
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
6947
|
+
# message template data.
|
4117
6948
|
# @return [String]
|
4118
6949
|
#
|
4119
|
-
#
|
6950
|
+
# @!attribute [rw] last_modified_time
|
6951
|
+
# The timestamp when the message template data was last modified.
|
6952
|
+
# @return [Time]
|
4120
6953
|
#
|
4121
|
-
|
4122
|
-
|
4123
|
-
|
4124
|
-
:next_token)
|
4125
|
-
SENSITIVE = []
|
4126
|
-
include Aws::Structure
|
4127
|
-
end
|
4128
|
-
|
4129
|
-
# @!attribute [rw] import_job_summaries
|
4130
|
-
# Summary information about the import jobs.
|
4131
|
-
# @return [Array<Types::ImportJobSummary>]
|
6954
|
+
# @!attribute [rw] message_template_arn
|
6955
|
+
# The Amazon Resource Name (ARN) of the message template.
|
6956
|
+
# @return [String]
|
4132
6957
|
#
|
4133
|
-
# @!attribute [rw]
|
4134
|
-
# The
|
4135
|
-
# previous response in the next request to retrieve the next set of
|
4136
|
-
# results.
|
6958
|
+
# @!attribute [rw] message_template_id
|
6959
|
+
# The identifier of the message template.
|
4137
6960
|
# @return [String]
|
4138
6961
|
#
|
4139
|
-
#
|
6962
|
+
# @!attribute [rw] name
|
6963
|
+
# The name of the message template.
|
6964
|
+
# @return [String]
|
4140
6965
|
#
|
4141
|
-
|
4142
|
-
|
4143
|
-
|
4144
|
-
|
4145
|
-
include Aws::Structure
|
4146
|
-
end
|
4147
|
-
|
4148
|
-
# @!attribute [rw] max_results
|
4149
|
-
# The maximum number of results to return per page.
|
4150
|
-
# @return [Integer]
|
6966
|
+
# @!attribute [rw] tags
|
6967
|
+
# The tags used to organize, track, or control access for this
|
6968
|
+
# resource.
|
6969
|
+
# @return [Hash<String,String>]
|
4151
6970
|
#
|
4152
|
-
# @!attribute [rw]
|
4153
|
-
# The
|
4154
|
-
#
|
4155
|
-
# results.
|
4156
|
-
# @return [String]
|
6971
|
+
# @!attribute [rw] version_number
|
6972
|
+
# The version number of the message template version.
|
6973
|
+
# @return [Integer]
|
4157
6974
|
#
|
4158
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
6975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSearchResultData AWS API Documentation
|
4159
6976
|
#
|
4160
|
-
class
|
4161
|
-
:
|
4162
|
-
:
|
6977
|
+
class MessageTemplateSearchResultData < Struct.new(
|
6978
|
+
:channel_subtype,
|
6979
|
+
:created_time,
|
6980
|
+
:description,
|
6981
|
+
:grouping_configuration,
|
6982
|
+
:is_active,
|
6983
|
+
:knowledge_base_arn,
|
6984
|
+
:knowledge_base_id,
|
6985
|
+
:language,
|
6986
|
+
:last_modified_by,
|
6987
|
+
:last_modified_time,
|
6988
|
+
:message_template_arn,
|
6989
|
+
:message_template_id,
|
6990
|
+
:name,
|
6991
|
+
:tags,
|
6992
|
+
:version_number)
|
4163
6993
|
SENSITIVE = []
|
4164
6994
|
include Aws::Structure
|
4165
6995
|
end
|
4166
6996
|
|
4167
|
-
#
|
4168
|
-
# Information about the knowledge bases.
|
4169
|
-
# @return [Array<Types::KnowledgeBaseSummary>]
|
6997
|
+
# The summary of the message template.
|
4170
6998
|
#
|
4171
|
-
# @!attribute [rw]
|
4172
|
-
#
|
4173
|
-
#
|
6999
|
+
# @!attribute [rw] active_version_number
|
7000
|
+
# The version number of the message template version that is
|
7001
|
+
# activated.
|
7002
|
+
# @return [Integer]
|
7003
|
+
#
|
7004
|
+
# @!attribute [rw] channel_subtype
|
7005
|
+
# The channel subtype this message template applies to.
|
4174
7006
|
# @return [String]
|
4175
7007
|
#
|
4176
|
-
#
|
7008
|
+
# @!attribute [rw] created_time
|
7009
|
+
# The timestamp when the message template was created.
|
7010
|
+
# @return [Time]
|
4177
7011
|
#
|
4178
|
-
|
4179
|
-
|
4180
|
-
:next_token)
|
4181
|
-
SENSITIVE = []
|
4182
|
-
include Aws::Structure
|
4183
|
-
end
|
4184
|
-
|
4185
|
-
# @!attribute [rw] knowledge_base_id
|
4186
|
-
# The identifier of the knowledge base. Can be either the ID or the
|
4187
|
-
# ARN. URLs cannot contain the ARN.
|
7012
|
+
# @!attribute [rw] description
|
7013
|
+
# The description of the message template.
|
4188
7014
|
# @return [String]
|
4189
7015
|
#
|
4190
|
-
# @!attribute [rw]
|
4191
|
-
# The
|
4192
|
-
# @return [Integer]
|
4193
|
-
#
|
4194
|
-
# @!attribute [rw] next_token
|
4195
|
-
# The token for the next set of results. Use the value returned in the
|
4196
|
-
# previous response in the next request to retrieve the next set of
|
4197
|
-
# results.
|
7016
|
+
# @!attribute [rw] knowledge_base_arn
|
7017
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
4198
7018
|
# @return [String]
|
4199
7019
|
#
|
4200
|
-
#
|
7020
|
+
# @!attribute [rw] knowledge_base_id
|
7021
|
+
# The identifier of the knowledge base.
|
7022
|
+
# @return [String]
|
4201
7023
|
#
|
4202
|
-
|
4203
|
-
|
4204
|
-
|
4205
|
-
:next_token)
|
4206
|
-
SENSITIVE = []
|
4207
|
-
include Aws::Structure
|
4208
|
-
end
|
4209
|
-
|
4210
|
-
# @!attribute [rw] next_token
|
4211
|
-
# The token for the next set of results. Use the value returned in the
|
4212
|
-
# previous response in the next request to retrieve the next set of
|
4213
|
-
# results.
|
7024
|
+
# @!attribute [rw] last_modified_by
|
7025
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
7026
|
+
# message template data.
|
4214
7027
|
# @return [String]
|
4215
7028
|
#
|
4216
|
-
# @!attribute [rw]
|
4217
|
-
#
|
4218
|
-
# @return [
|
7029
|
+
# @!attribute [rw] last_modified_time
|
7030
|
+
# The timestamp when the message template data was last modified.
|
7031
|
+
# @return [Time]
|
4219
7032
|
#
|
4220
|
-
#
|
7033
|
+
# @!attribute [rw] message_template_arn
|
7034
|
+
# The Amazon Resource Name (ARN) of the message template.
|
7035
|
+
# @return [String]
|
4221
7036
|
#
|
4222
|
-
|
4223
|
-
|
4224
|
-
:quick_response_summaries)
|
4225
|
-
SENSITIVE = []
|
4226
|
-
include Aws::Structure
|
4227
|
-
end
|
4228
|
-
|
4229
|
-
# @!attribute [rw] resource_arn
|
4230
|
-
# The Amazon Resource Name (ARN) of the resource.
|
7037
|
+
# @!attribute [rw] message_template_id
|
7038
|
+
# The identifier of the message template.
|
4231
7039
|
# @return [String]
|
4232
7040
|
#
|
4233
|
-
#
|
7041
|
+
# @!attribute [rw] name
|
7042
|
+
# The name of the message template.
|
7043
|
+
# @return [String]
|
4234
7044
|
#
|
4235
|
-
class ListTagsForResourceRequest < Struct.new(
|
4236
|
-
:resource_arn)
|
4237
|
-
SENSITIVE = []
|
4238
|
-
include Aws::Structure
|
4239
|
-
end
|
4240
|
-
|
4241
7045
|
# @!attribute [rw] tags
|
4242
7046
|
# The tags used to organize, track, or control access for this
|
4243
7047
|
# resource.
|
4244
7048
|
# @return [Hash<String,String>]
|
4245
7049
|
#
|
4246
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
7050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSummary AWS API Documentation
|
4247
7051
|
#
|
4248
|
-
class
|
7052
|
+
class MessageTemplateSummary < Struct.new(
|
7053
|
+
:active_version_number,
|
7054
|
+
:channel_subtype,
|
7055
|
+
:created_time,
|
7056
|
+
:description,
|
7057
|
+
:knowledge_base_arn,
|
7058
|
+
:knowledge_base_id,
|
7059
|
+
:last_modified_by,
|
7060
|
+
:last_modified_time,
|
7061
|
+
:message_template_arn,
|
7062
|
+
:message_template_id,
|
7063
|
+
:name,
|
4249
7064
|
:tags)
|
4250
7065
|
SENSITIVE = []
|
4251
7066
|
include Aws::Structure
|
4252
7067
|
end
|
4253
7068
|
|
4254
|
-
#
|
7069
|
+
# The summary of the message template version.
|
4255
7070
|
#
|
4256
|
-
#
|
7071
|
+
# @!attribute [rw] channel_subtype
|
7072
|
+
# The channel subtype this message template applies to.
|
7073
|
+
# @return [String]
|
4257
7074
|
#
|
4258
|
-
#
|
7075
|
+
# @!attribute [rw] is_active
|
7076
|
+
# Whether the version of the message template is activated.
|
7077
|
+
# @return [Boolean]
|
4259
7078
|
#
|
4260
|
-
# @!attribute [rw]
|
4261
|
-
#
|
4262
|
-
# @return [
|
7079
|
+
# @!attribute [rw] knowledge_base_arn
|
7080
|
+
# The Amazon Resource Name (ARN) of the knowledge base.
|
7081
|
+
# @return [String]
|
4263
7082
|
#
|
4264
|
-
#
|
7083
|
+
# @!attribute [rw] knowledge_base_id
|
7084
|
+
# The identifier of the knowledge base.
|
7085
|
+
# @return [String]
|
4265
7086
|
#
|
4266
|
-
|
4267
|
-
|
4268
|
-
|
4269
|
-
SENSITIVE = []
|
4270
|
-
include Aws::Structure
|
4271
|
-
include Aws::Structure::Union
|
4272
|
-
|
4273
|
-
class WebCrawlerConfiguration < ManagedSourceConfiguration; end
|
4274
|
-
class Unknown < ManagedSourceConfiguration; end
|
4275
|
-
end
|
4276
|
-
|
4277
|
-
# The configuration for the `MANUAL_SEARCH` AI Agent type.
|
7087
|
+
# @!attribute [rw] message_template_arn
|
7088
|
+
# The Amazon Resource Name (ARN) of the message template.
|
7089
|
+
# @return [String]
|
4278
7090
|
#
|
4279
|
-
# @!attribute [rw]
|
4280
|
-
# The
|
4281
|
-
# the MANUAL\_SEARCH AI Agent.
|
7091
|
+
# @!attribute [rw] message_template_id
|
7092
|
+
# The identifier of the message template.
|
4282
7093
|
# @return [String]
|
4283
7094
|
#
|
4284
|
-
# @!attribute [rw]
|
4285
|
-
# The
|
4286
|
-
#
|
4287
|
-
# @return [Array<Types::AssociationConfiguration>]
|
7095
|
+
# @!attribute [rw] name
|
7096
|
+
# The name of the message template.
|
7097
|
+
# @return [String]
|
4288
7098
|
#
|
4289
|
-
#
|
7099
|
+
# @!attribute [rw] version_number
|
7100
|
+
# The version number of the message template version.
|
7101
|
+
# @return [Integer]
|
4290
7102
|
#
|
4291
|
-
|
4292
|
-
|
4293
|
-
|
7103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateVersionSummary AWS API Documentation
|
7104
|
+
#
|
7105
|
+
class MessageTemplateVersionSummary < Struct.new(
|
7106
|
+
:channel_subtype,
|
7107
|
+
:is_active,
|
7108
|
+
:knowledge_base_arn,
|
7109
|
+
:knowledge_base_id,
|
7110
|
+
:message_template_arn,
|
7111
|
+
:message_template_id,
|
7112
|
+
:name,
|
7113
|
+
:version_number)
|
4294
7114
|
SENSITIVE = []
|
4295
7115
|
include Aws::Structure
|
4296
7116
|
end
|
@@ -4757,7 +7577,9 @@ module Aws::QConnect
|
|
4757
7577
|
#
|
4758
7578
|
# @!attribute [rw] language
|
4759
7579
|
# The language code value for the language in which the quick response
|
4760
|
-
# is written.
|
7580
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
7581
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
7582
|
+
# `zh_CN`, `zh_TW`
|
4761
7583
|
# @return [String]
|
4762
7584
|
#
|
4763
7585
|
# @!attribute [rw] last_modified_by
|
@@ -5393,6 +8215,56 @@ module Aws::QConnect
|
|
5393
8215
|
#
|
5394
8216
|
class RemoveKnowledgeBaseTemplateUriResponse < Aws::EmptyStructure; end
|
5395
8217
|
|
8218
|
+
# @!attribute [rw] attributes
|
8219
|
+
# An object that specifies the values to use for variables in the
|
8220
|
+
# message template. This object contains different categories of
|
8221
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
8222
|
+
# message template. The corresponding value defines the value for that
|
8223
|
+
# variable.
|
8224
|
+
# @return [Types::MessageTemplateAttributes]
|
8225
|
+
#
|
8226
|
+
# @!attribute [rw] knowledge_base_id
|
8227
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
8228
|
+
# ARN. URLs cannot contain the ARN.
|
8229
|
+
# @return [String]
|
8230
|
+
#
|
8231
|
+
# @!attribute [rw] message_template_id
|
8232
|
+
# The identifier of the message template. Can be either the ID or the
|
8233
|
+
# ARN.
|
8234
|
+
# @return [String]
|
8235
|
+
#
|
8236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplateRequest AWS API Documentation
|
8237
|
+
#
|
8238
|
+
class RenderMessageTemplateRequest < Struct.new(
|
8239
|
+
:attributes,
|
8240
|
+
:knowledge_base_id,
|
8241
|
+
:message_template_id)
|
8242
|
+
SENSITIVE = []
|
8243
|
+
include Aws::Structure
|
8244
|
+
end
|
8245
|
+
|
8246
|
+
# @!attribute [rw] attachments
|
8247
|
+
# The message template attachments.
|
8248
|
+
# @return [Array<Types::MessageTemplateAttachment>]
|
8249
|
+
#
|
8250
|
+
# @!attribute [rw] attributes_not_interpolated
|
8251
|
+
# The attribute keys that are not resolved.
|
8252
|
+
# @return [Array<String>]
|
8253
|
+
#
|
8254
|
+
# @!attribute [rw] content
|
8255
|
+
# The content of the message template.
|
8256
|
+
# @return [Types::MessageTemplateContentProvider]
|
8257
|
+
#
|
8258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RenderMessageTemplateResponse AWS API Documentation
|
8259
|
+
#
|
8260
|
+
class RenderMessageTemplateResponse < Struct.new(
|
8261
|
+
:attachments,
|
8262
|
+
:attributes_not_interpolated,
|
8263
|
+
:content)
|
8264
|
+
SENSITIVE = [:attributes_not_interpolated]
|
8265
|
+
include Aws::Structure
|
8266
|
+
end
|
8267
|
+
|
5396
8268
|
# Information about how to render the content.
|
5397
8269
|
#
|
5398
8270
|
# @!attribute [rw] template_uri
|
@@ -5529,10 +8401,39 @@ module Aws::QConnect
|
|
5529
8401
|
:unknown)
|
5530
8402
|
SENSITIVE = [:string_value]
|
5531
8403
|
include Aws::Structure
|
5532
|
-
include Aws::Structure::Union
|
5533
|
-
|
5534
|
-
class StringValue < RuntimeSessionDataValue; end
|
5535
|
-
class Unknown < RuntimeSessionDataValue; end
|
8404
|
+
include Aws::Structure::Union
|
8405
|
+
|
8406
|
+
class StringValue < RuntimeSessionDataValue; end
|
8407
|
+
class Unknown < RuntimeSessionDataValue; end
|
8408
|
+
end
|
8409
|
+
|
8410
|
+
# The content of the message template that applies to the SMS channel
|
8411
|
+
# subtype.
|
8412
|
+
#
|
8413
|
+
# @!attribute [rw] body
|
8414
|
+
# The body to use in SMS messages.
|
8415
|
+
# @return [Types::SMSMessageTemplateContentBody]
|
8416
|
+
#
|
8417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SMSMessageTemplateContent AWS API Documentation
|
8418
|
+
#
|
8419
|
+
class SMSMessageTemplateContent < Struct.new(
|
8420
|
+
:body)
|
8421
|
+
SENSITIVE = []
|
8422
|
+
include Aws::Structure
|
8423
|
+
end
|
8424
|
+
|
8425
|
+
# The body to use in SMS messages.
|
8426
|
+
#
|
8427
|
+
# @!attribute [rw] plain_text
|
8428
|
+
# The message body to use in SMS messages.
|
8429
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
8430
|
+
#
|
8431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SMSMessageTemplateContentBody AWS API Documentation
|
8432
|
+
#
|
8433
|
+
class SMSMessageTemplateContentBody < Struct.new(
|
8434
|
+
:plain_text)
|
8435
|
+
SENSITIVE = []
|
8436
|
+
include Aws::Structure
|
5536
8437
|
end
|
5537
8438
|
|
5538
8439
|
# @!attribute [rw] knowledge_base_id
|
@@ -5598,6 +8499,54 @@ module Aws::QConnect
|
|
5598
8499
|
include Aws::Structure
|
5599
8500
|
end
|
5600
8501
|
|
8502
|
+
# @!attribute [rw] knowledge_base_id
|
8503
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
8504
|
+
# ARN. URLs cannot contain the ARN.
|
8505
|
+
# @return [String]
|
8506
|
+
#
|
8507
|
+
# @!attribute [rw] max_results
|
8508
|
+
# The maximum number of results to return per page.
|
8509
|
+
# @return [Integer]
|
8510
|
+
#
|
8511
|
+
# @!attribute [rw] next_token
|
8512
|
+
# The token for the next set of results. Use the value returned in the
|
8513
|
+
# previous response in the next request to retrieve the next set of
|
8514
|
+
# results.
|
8515
|
+
# @return [String]
|
8516
|
+
#
|
8517
|
+
# @!attribute [rw] search_expression
|
8518
|
+
# The search expression for querying the message template.
|
8519
|
+
# @return [Types::MessageTemplateSearchExpression]
|
8520
|
+
#
|
8521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplatesRequest AWS API Documentation
|
8522
|
+
#
|
8523
|
+
class SearchMessageTemplatesRequest < Struct.new(
|
8524
|
+
:knowledge_base_id,
|
8525
|
+
:max_results,
|
8526
|
+
:next_token,
|
8527
|
+
:search_expression)
|
8528
|
+
SENSITIVE = []
|
8529
|
+
include Aws::Structure
|
8530
|
+
end
|
8531
|
+
|
8532
|
+
# @!attribute [rw] next_token
|
8533
|
+
# If there are additional results, this is the token for the next set
|
8534
|
+
# of results.
|
8535
|
+
# @return [String]
|
8536
|
+
#
|
8537
|
+
# @!attribute [rw] results
|
8538
|
+
# The results of the message template search.
|
8539
|
+
# @return [Array<Types::MessageTemplateSearchResultData>]
|
8540
|
+
#
|
8541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SearchMessageTemplatesResponse AWS API Documentation
|
8542
|
+
#
|
8543
|
+
class SearchMessageTemplatesResponse < Struct.new(
|
8544
|
+
:next_token,
|
8545
|
+
:results)
|
8546
|
+
SENSITIVE = []
|
8547
|
+
include Aws::Structure
|
8548
|
+
end
|
8549
|
+
|
5601
8550
|
# @!attribute [rw] attributes
|
5602
8551
|
# The [user-defined Amazon Connect contact attributes][1] to be
|
5603
8552
|
# resolved when search results are returned.
|
@@ -5720,6 +8669,63 @@ module Aws::QConnect
|
|
5720
8669
|
include Aws::Structure
|
5721
8670
|
end
|
5722
8671
|
|
8672
|
+
# The configuration for AI Agents of type SELF\_SERVICE.
|
8673
|
+
#
|
8674
|
+
# @!attribute [rw] association_configurations
|
8675
|
+
# The association configurations for overriding behavior on this AI
|
8676
|
+
# Agent.
|
8677
|
+
# @return [Array<Types::AssociationConfiguration>]
|
8678
|
+
#
|
8679
|
+
# @!attribute [rw] self_service_ai_guardrail_id
|
8680
|
+
# The AI Guardrail identifier used by the SELF\_SERVICE AI Agent.
|
8681
|
+
# @return [String]
|
8682
|
+
#
|
8683
|
+
# @!attribute [rw] self_service_answer_generation_ai_prompt_id
|
8684
|
+
# The AI Prompt identifier for the Self Service Answer Generation
|
8685
|
+
# prompt used by the SELF\_SERVICE AI Agent
|
8686
|
+
# @return [String]
|
8687
|
+
#
|
8688
|
+
# @!attribute [rw] self_service_pre_processing_ai_prompt_id
|
8689
|
+
# The AI Prompt identifier for the Self Service Pre-Processing prompt
|
8690
|
+
# used by the SELF\_SERVICE AI Agent
|
8691
|
+
# @return [String]
|
8692
|
+
#
|
8693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceAIAgentConfiguration AWS API Documentation
|
8694
|
+
#
|
8695
|
+
class SelfServiceAIAgentConfiguration < Struct.new(
|
8696
|
+
:association_configurations,
|
8697
|
+
:self_service_ai_guardrail_id,
|
8698
|
+
:self_service_answer_generation_ai_prompt_id,
|
8699
|
+
:self_service_pre_processing_ai_prompt_id)
|
8700
|
+
SENSITIVE = []
|
8701
|
+
include Aws::Structure
|
8702
|
+
end
|
8703
|
+
|
8704
|
+
# The conversation history data to included in conversation context data
|
8705
|
+
# before the the Amazon Q in Connect session..
|
8706
|
+
#
|
8707
|
+
# @!attribute [rw] bot_response
|
8708
|
+
# The bot response of the conversation history data.
|
8709
|
+
# @return [String]
|
8710
|
+
#
|
8711
|
+
# @!attribute [rw] input_transcript
|
8712
|
+
# The input transcript of the conversation history data.
|
8713
|
+
# @return [String]
|
8714
|
+
#
|
8715
|
+
# @!attribute [rw] turn_number
|
8716
|
+
# The number of turn of the conversation history data.
|
8717
|
+
# @return [Integer]
|
8718
|
+
#
|
8719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceConversationHistory AWS API Documentation
|
8720
|
+
#
|
8721
|
+
class SelfServiceConversationHistory < Struct.new(
|
8722
|
+
:bot_response,
|
8723
|
+
:input_transcript,
|
8724
|
+
:turn_number)
|
8725
|
+
SENSITIVE = [:bot_response, :input_transcript]
|
8726
|
+
include Aws::Structure
|
8727
|
+
end
|
8728
|
+
|
5723
8729
|
# Settings for semantic document chunking for a data source. Semantic
|
5724
8730
|
# chunking splits a document into smaller documents based on groups of
|
5725
8731
|
# similar content derived from the text with natural language
|
@@ -5747,6 +8753,66 @@ module Aws::QConnect
|
|
5747
8753
|
include Aws::Structure
|
5748
8754
|
end
|
5749
8755
|
|
8756
|
+
# @!attribute [rw] assistant_id
|
8757
|
+
# The identifier of the Amazon Q in Connect assistant.
|
8758
|
+
# @return [String]
|
8759
|
+
#
|
8760
|
+
# @!attribute [rw] client_token
|
8761
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
8762
|
+
# idempotency of the request. If not provided, the AWS SDK populates
|
8763
|
+
# this field.For more information about idempotency, see Making
|
8764
|
+
# retries safe with idempotent APIs.
|
8765
|
+
#
|
8766
|
+
# **A suitable default value is auto-generated.** You should normally
|
8767
|
+
# not need to pass this option.
|
8768
|
+
# @return [String]
|
8769
|
+
#
|
8770
|
+
# @!attribute [rw] conversation_context
|
8771
|
+
# The conversation context before the Amazon Q in Connect session.
|
8772
|
+
# @return [Types::ConversationContext]
|
8773
|
+
#
|
8774
|
+
# @!attribute [rw] message
|
8775
|
+
# The message data to submit to the Amazon Q in Connect session.
|
8776
|
+
# @return [Types::MessageInput]
|
8777
|
+
#
|
8778
|
+
# @!attribute [rw] session_id
|
8779
|
+
# The identifier of the Amazon Q in Connect session.
|
8780
|
+
# @return [String]
|
8781
|
+
#
|
8782
|
+
# @!attribute [rw] type
|
8783
|
+
# The message type.
|
8784
|
+
# @return [String]
|
8785
|
+
#
|
8786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageRequest AWS API Documentation
|
8787
|
+
#
|
8788
|
+
class SendMessageRequest < Struct.new(
|
8789
|
+
:assistant_id,
|
8790
|
+
:client_token,
|
8791
|
+
:conversation_context,
|
8792
|
+
:message,
|
8793
|
+
:session_id,
|
8794
|
+
:type)
|
8795
|
+
SENSITIVE = []
|
8796
|
+
include Aws::Structure
|
8797
|
+
end
|
8798
|
+
|
8799
|
+
# @!attribute [rw] next_message_token
|
8800
|
+
# The token for the next message, used by GetNextMessage.
|
8801
|
+
# @return [String]
|
8802
|
+
#
|
8803
|
+
# @!attribute [rw] request_message_id
|
8804
|
+
# The identifier of the submitted message.
|
8805
|
+
# @return [String]
|
8806
|
+
#
|
8807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageResponse AWS API Documentation
|
8808
|
+
#
|
8809
|
+
class SendMessageResponse < Struct.new(
|
8810
|
+
:next_message_token,
|
8811
|
+
:request_message_id)
|
8812
|
+
SENSITIVE = []
|
8813
|
+
include Aws::Structure
|
8814
|
+
end
|
8815
|
+
|
5750
8816
|
# The configuration information for the customer managed key used for
|
5751
8817
|
# encryption.
|
5752
8818
|
#
|
@@ -6067,6 +9133,47 @@ module Aws::QConnect
|
|
6067
9133
|
include Aws::Structure
|
6068
9134
|
end
|
6069
9135
|
|
9136
|
+
# The system attributes that are used with the message template.
|
9137
|
+
#
|
9138
|
+
# @!attribute [rw] customer_endpoint
|
9139
|
+
# The CustomerEndpoint attribute.
|
9140
|
+
# @return [Types::SystemEndpointAttributes]
|
9141
|
+
#
|
9142
|
+
# @!attribute [rw] name
|
9143
|
+
# The name of the task.
|
9144
|
+
# @return [String]
|
9145
|
+
#
|
9146
|
+
# @!attribute [rw] system_endpoint
|
9147
|
+
# The SystemEndpoint attribute.
|
9148
|
+
# @return [Types::SystemEndpointAttributes]
|
9149
|
+
#
|
9150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SystemAttributes AWS API Documentation
|
9151
|
+
#
|
9152
|
+
class SystemAttributes < Struct.new(
|
9153
|
+
:customer_endpoint,
|
9154
|
+
:name,
|
9155
|
+
:system_endpoint)
|
9156
|
+
SENSITIVE = [:name]
|
9157
|
+
include Aws::Structure
|
9158
|
+
end
|
9159
|
+
|
9160
|
+
# The system endpoint attributes that are used with the message
|
9161
|
+
# template.
|
9162
|
+
#
|
9163
|
+
# @!attribute [rw] address
|
9164
|
+
# The customer's phone number if used with `customerEndpoint`, or the
|
9165
|
+
# number the customer dialed to call your contact center if used with
|
9166
|
+
# `systemEndpoint`.
|
9167
|
+
# @return [String]
|
9168
|
+
#
|
9169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SystemEndpointAttributes AWS API Documentation
|
9170
|
+
#
|
9171
|
+
class SystemEndpointAttributes < Struct.new(
|
9172
|
+
:address)
|
9173
|
+
SENSITIVE = [:address]
|
9174
|
+
include Aws::Structure
|
9175
|
+
end
|
9176
|
+
|
6070
9177
|
# A leaf node condition which can be used to specify a tag condition.
|
6071
9178
|
#
|
6072
9179
|
# @!attribute [rw] key
|
@@ -6179,6 +9286,20 @@ module Aws::QConnect
|
|
6179
9286
|
include Aws::Structure
|
6180
9287
|
end
|
6181
9288
|
|
9289
|
+
# The message data in text type.
|
9290
|
+
#
|
9291
|
+
# @!attribute [rw] value
|
9292
|
+
# The value of the message data in text type.
|
9293
|
+
# @return [String]
|
9294
|
+
#
|
9295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextMessage AWS API Documentation
|
9296
|
+
#
|
9297
|
+
class TextMessage < Struct.new(
|
9298
|
+
:value)
|
9299
|
+
SENSITIVE = [:value]
|
9300
|
+
include Aws::Structure
|
9301
|
+
end
|
9302
|
+
|
6182
9303
|
# The throttling limit has been exceeded.
|
6183
9304
|
#
|
6184
9305
|
# @!attribute [rw] message
|
@@ -6243,9 +9364,9 @@ module Aws::QConnect
|
|
6243
9364
|
#
|
6244
9365
|
# @!attribute [rw] client_token
|
6245
9366
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6246
|
-
# idempotency of the request. If not provided, the
|
6247
|
-
# this field. For more information about idempotency,
|
6248
|
-
# retries safe with idempotent APIs][1]
|
9367
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
9368
|
+
# SDK populates this field. For more information about idempotency,
|
9369
|
+
# see [Making retries safe with idempotent APIs][1]..
|
6249
9370
|
#
|
6250
9371
|
# **A suitable default value is auto-generated.** You should normally
|
6251
9372
|
# not need to pass this option.
|
@@ -6292,6 +9413,97 @@ module Aws::QConnect
|
|
6292
9413
|
include Aws::Structure
|
6293
9414
|
end
|
6294
9415
|
|
9416
|
+
# @!attribute [rw] ai_guardrail_id
|
9417
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
9418
|
+
# @return [String]
|
9419
|
+
#
|
9420
|
+
# @!attribute [rw] assistant_id
|
9421
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
9422
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
9423
|
+
# @return [String]
|
9424
|
+
#
|
9425
|
+
# @!attribute [rw] blocked_input_messaging
|
9426
|
+
# The message to return when the AI Guardrail blocks a prompt.
|
9427
|
+
# @return [String]
|
9428
|
+
#
|
9429
|
+
# @!attribute [rw] blocked_outputs_messaging
|
9430
|
+
# The message to return when the AI Guardrail blocks a model response.
|
9431
|
+
# @return [String]
|
9432
|
+
#
|
9433
|
+
# @!attribute [rw] client_token
|
9434
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
9435
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
9436
|
+
# SDK populates this field. For more information about idempotency,
|
9437
|
+
# see [Making retries safe with idempotent APIs][1]..
|
9438
|
+
#
|
9439
|
+
# **A suitable default value is auto-generated.** You should normally
|
9440
|
+
# not need to pass this option.
|
9441
|
+
#
|
9442
|
+
#
|
9443
|
+
#
|
9444
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
9445
|
+
# @return [String]
|
9446
|
+
#
|
9447
|
+
# @!attribute [rw] content_policy_config
|
9448
|
+
# The content filter policies to configure for the AI Guardrail.
|
9449
|
+
# @return [Types::AIGuardrailContentPolicyConfig]
|
9450
|
+
#
|
9451
|
+
# @!attribute [rw] contextual_grounding_policy_config
|
9452
|
+
# The contextual grounding policy configuration used to create an AI
|
9453
|
+
# Guardrail.
|
9454
|
+
# @return [Types::AIGuardrailContextualGroundingPolicyConfig]
|
9455
|
+
#
|
9456
|
+
# @!attribute [rw] description
|
9457
|
+
# A description of the AI Guardrail.
|
9458
|
+
# @return [String]
|
9459
|
+
#
|
9460
|
+
# @!attribute [rw] sensitive_information_policy_config
|
9461
|
+
# The sensitive information policy to configure for the AI Guardrail.
|
9462
|
+
# @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
|
9463
|
+
#
|
9464
|
+
# @!attribute [rw] topic_policy_config
|
9465
|
+
# The topic policies to configure for the AI Guardrail.
|
9466
|
+
# @return [Types::AIGuardrailTopicPolicyConfig]
|
9467
|
+
#
|
9468
|
+
# @!attribute [rw] visibility_status
|
9469
|
+
# The visibility status of the Amazon Q in Connect AI Guardrail.
|
9470
|
+
# @return [String]
|
9471
|
+
#
|
9472
|
+
# @!attribute [rw] word_policy_config
|
9473
|
+
# The word policy you configure for the AI Guardrail.
|
9474
|
+
# @return [Types::AIGuardrailWordPolicyConfig]
|
9475
|
+
#
|
9476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIGuardrailRequest AWS API Documentation
|
9477
|
+
#
|
9478
|
+
class UpdateAIGuardrailRequest < Struct.new(
|
9479
|
+
:ai_guardrail_id,
|
9480
|
+
:assistant_id,
|
9481
|
+
:blocked_input_messaging,
|
9482
|
+
:blocked_outputs_messaging,
|
9483
|
+
:client_token,
|
9484
|
+
:content_policy_config,
|
9485
|
+
:contextual_grounding_policy_config,
|
9486
|
+
:description,
|
9487
|
+
:sensitive_information_policy_config,
|
9488
|
+
:topic_policy_config,
|
9489
|
+
:visibility_status,
|
9490
|
+
:word_policy_config)
|
9491
|
+
SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
|
9492
|
+
include Aws::Structure
|
9493
|
+
end
|
9494
|
+
|
9495
|
+
# @!attribute [rw] ai_guardrail
|
9496
|
+
# The data of the updated Amazon Q in Connect AI Guardrail.
|
9497
|
+
# @return [Types::AIGuardrailData]
|
9498
|
+
#
|
9499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIGuardrailResponse AWS API Documentation
|
9500
|
+
#
|
9501
|
+
class UpdateAIGuardrailResponse < Struct.new(
|
9502
|
+
:ai_guardrail)
|
9503
|
+
SENSITIVE = []
|
9504
|
+
include Aws::Structure
|
9505
|
+
end
|
9506
|
+
|
6295
9507
|
# @!attribute [rw] ai_prompt_id
|
6296
9508
|
# The identifier of the Amazon Q in Connect AI Prompt.
|
6297
9509
|
# @return [String]
|
@@ -6303,16 +9515,16 @@ module Aws::QConnect
|
|
6303
9515
|
#
|
6304
9516
|
# @!attribute [rw] client_token
|
6305
9517
|
# A unique, case-sensitive identifier that you provide to ensure the
|
6306
|
-
# idempotency of the request. If not provided, the
|
6307
|
-
# this field. For more information about idempotency,
|
6308
|
-
# retries safe with idempotent APIs][1]
|
9518
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
9519
|
+
# SDK populates this field. For more information about idempotency,
|
9520
|
+
# see [Making retries safe with idempotent APIs][1]..
|
6309
9521
|
#
|
6310
9522
|
# **A suitable default value is auto-generated.** You should normally
|
6311
9523
|
# not need to pass this option.
|
6312
9524
|
#
|
6313
9525
|
#
|
6314
9526
|
#
|
6315
|
-
# [1]: http://aws.amazon.com/
|
9527
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
6316
9528
|
# @return [String]
|
6317
9529
|
#
|
6318
9530
|
# @!attribute [rw] description
|
@@ -6498,6 +9710,106 @@ module Aws::QConnect
|
|
6498
9710
|
include Aws::Structure
|
6499
9711
|
end
|
6500
9712
|
|
9713
|
+
# @!attribute [rw] description
|
9714
|
+
# The description of the message template.
|
9715
|
+
# @return [String]
|
9716
|
+
#
|
9717
|
+
# @!attribute [rw] grouping_configuration
|
9718
|
+
# The configuration information of the grouping of Amazon Q in Connect
|
9719
|
+
# users.
|
9720
|
+
# @return [Types::GroupingConfiguration]
|
9721
|
+
#
|
9722
|
+
# @!attribute [rw] knowledge_base_id
|
9723
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
9724
|
+
# ARN. URLs cannot contain the ARN.
|
9725
|
+
# @return [String]
|
9726
|
+
#
|
9727
|
+
# @!attribute [rw] message_template_id
|
9728
|
+
# The identifier of the message template. Can be either the ID or the
|
9729
|
+
# ARN. It cannot contain any qualifier.
|
9730
|
+
# @return [String]
|
9731
|
+
#
|
9732
|
+
# @!attribute [rw] name
|
9733
|
+
# The name of the message template.
|
9734
|
+
# @return [String]
|
9735
|
+
#
|
9736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadataRequest AWS API Documentation
|
9737
|
+
#
|
9738
|
+
class UpdateMessageTemplateMetadataRequest < Struct.new(
|
9739
|
+
:description,
|
9740
|
+
:grouping_configuration,
|
9741
|
+
:knowledge_base_id,
|
9742
|
+
:message_template_id,
|
9743
|
+
:name)
|
9744
|
+
SENSITIVE = []
|
9745
|
+
include Aws::Structure
|
9746
|
+
end
|
9747
|
+
|
9748
|
+
# @!attribute [rw] message_template
|
9749
|
+
# The message template.
|
9750
|
+
# @return [Types::MessageTemplateData]
|
9751
|
+
#
|
9752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateMetadataResponse AWS API Documentation
|
9753
|
+
#
|
9754
|
+
class UpdateMessageTemplateMetadataResponse < Struct.new(
|
9755
|
+
:message_template)
|
9756
|
+
SENSITIVE = []
|
9757
|
+
include Aws::Structure
|
9758
|
+
end
|
9759
|
+
|
9760
|
+
# @!attribute [rw] content
|
9761
|
+
# The content of the message template.
|
9762
|
+
# @return [Types::MessageTemplateContentProvider]
|
9763
|
+
#
|
9764
|
+
# @!attribute [rw] default_attributes
|
9765
|
+
# An object that specifies the default values to use for variables in
|
9766
|
+
# the message template. This object contains different categories of
|
9767
|
+
# key-value pairs. Each key defines a variable or placeholder in the
|
9768
|
+
# message template. The corresponding value defines the default value
|
9769
|
+
# for that variable.
|
9770
|
+
# @return [Types::MessageTemplateAttributes]
|
9771
|
+
#
|
9772
|
+
# @!attribute [rw] knowledge_base_id
|
9773
|
+
# The identifier of the knowledge base. Can be either the ID or the
|
9774
|
+
# ARN. URLs cannot contain the ARN.
|
9775
|
+
# @return [String]
|
9776
|
+
#
|
9777
|
+
# @!attribute [rw] language
|
9778
|
+
# The language code value for the language in which the quick response
|
9779
|
+
# is written. The supported language codes include `de_DE`, `en_US`,
|
9780
|
+
# `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`,
|
9781
|
+
# `zh_CN`, `zh_TW`
|
9782
|
+
# @return [String]
|
9783
|
+
#
|
9784
|
+
# @!attribute [rw] message_template_id
|
9785
|
+
# The identifier of the message template. Can be either the ID or the
|
9786
|
+
# ARN. It cannot contain any qualifier.
|
9787
|
+
# @return [String]
|
9788
|
+
#
|
9789
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateRequest AWS API Documentation
|
9790
|
+
#
|
9791
|
+
class UpdateMessageTemplateRequest < Struct.new(
|
9792
|
+
:content,
|
9793
|
+
:default_attributes,
|
9794
|
+
:knowledge_base_id,
|
9795
|
+
:language,
|
9796
|
+
:message_template_id)
|
9797
|
+
SENSITIVE = []
|
9798
|
+
include Aws::Structure
|
9799
|
+
end
|
9800
|
+
|
9801
|
+
# @!attribute [rw] message_template
|
9802
|
+
# The message template.
|
9803
|
+
# @return [Types::MessageTemplateData]
|
9804
|
+
#
|
9805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateMessageTemplateResponse AWS API Documentation
|
9806
|
+
#
|
9807
|
+
class UpdateMessageTemplateResponse < Struct.new(
|
9808
|
+
:message_template)
|
9809
|
+
SENSITIVE = []
|
9810
|
+
include Aws::Structure
|
9811
|
+
end
|
9812
|
+
|
6501
9813
|
# @!attribute [rw] channels
|
6502
9814
|
# The Amazon Connect contact channels this quick response applies to.
|
6503
9815
|
# The supported contact channel types include `Chat`.
|