aws-sdk-qconnect 1.24.0 → 1.26.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.
@@ -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
@@ -560,6 +833,11 @@ module Aws::QConnect
560
833
 
561
834
  # The configuration for the `ANSWER_RECOMMENDATION` AI Agent type.
562
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
+ #
563
841
  # @!attribute [rw] answer_generation_ai_prompt_id
564
842
  # The AI Prompt identifier for the Answer Generation prompt used by
565
843
  # the `ANSWER_RECOMMENDATION` AI Agent.
@@ -575,6 +853,21 @@ module Aws::QConnect
575
853
  # `ANSWER_RECOMMENDATION` AI Agent.
576
854
  # @return [String]
577
855
  #
856
+ # @!attribute [rw] locale
857
+ # The locale to which specifies the language and region settings that
858
+ # determine the response language for [QueryAssistant][1].
859
+ #
860
+ # <note markdown="1"> Changing this locale to anything other than `en_US` will turn off
861
+ # recommendations triggered by contact transcripts for agent
862
+ # assistance, as this feature is not supported in multiple languages.
863
+ #
864
+ # </note>
865
+ #
866
+ #
867
+ #
868
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html
869
+ # @return [String]
870
+ #
578
871
  # @!attribute [rw] query_reformulation_ai_prompt_id
579
872
  # The AI Prompt identifier for the Query Reformulation prompt used by
580
873
  # the `ANSWER_RECOMMENDATION` AI Agent.
@@ -583,9 +876,11 @@ module Aws::QConnect
583
876
  # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration AWS API Documentation
584
877
  #
585
878
  class AnswerRecommendationAIAgentConfiguration < Struct.new(
879
+ :answer_generation_ai_guardrail_id,
586
880
  :answer_generation_ai_prompt_id,
587
881
  :association_configurations,
588
882
  :intent_labeling_generation_ai_prompt_id,
883
+ :locale,
589
884
  :query_reformulation_ai_prompt_id)
590
885
  SENSITIVE = []
591
886
  include Aws::Structure
@@ -1563,6 +1858,40 @@ module Aws::QConnect
1563
1858
  include Aws::Structure
1564
1859
  end
1565
1860
 
1861
+ # The conversation context to include in SendMessage.
1862
+ #
1863
+ # @!attribute [rw] self_service_conversation_history
1864
+ # The self service conversation history before the Amazon Q in Connect
1865
+ # session.
1866
+ # @return [Array<Types::SelfServiceConversationHistory>]
1867
+ #
1868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConversationContext AWS API Documentation
1869
+ #
1870
+ class ConversationContext < Struct.new(
1871
+ :self_service_conversation_history)
1872
+ SENSITIVE = []
1873
+ include Aws::Structure
1874
+ end
1875
+
1876
+ # The conversation state associated to a message.
1877
+ #
1878
+ # @!attribute [rw] reason
1879
+ # The reason of the conversation state.
1880
+ # @return [String]
1881
+ #
1882
+ # @!attribute [rw] status
1883
+ # The status of the conversation state.
1884
+ # @return [String]
1885
+ #
1886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ConversationState AWS API Documentation
1887
+ #
1888
+ class ConversationState < Struct.new(
1889
+ :reason,
1890
+ :status)
1891
+ SENSITIVE = []
1892
+ include Aws::Structure
1893
+ end
1894
+
1566
1895
  # @!attribute [rw] assistant_id
1567
1896
  # The identifier of the Amazon Q in Connect assistant. Can be either
1568
1897
  # the ID or the ARN. URLs cannot contain the ARN.
@@ -1695,15 +2024,19 @@ module Aws::QConnect
1695
2024
  include Aws::Structure
1696
2025
  end
1697
2026
 
1698
- # @!attribute [rw] api_format
1699
- # The API Format of the AI Prompt.
1700
- # @return [String]
1701
- #
1702
2027
  # @!attribute [rw] assistant_id
1703
2028
  # The identifier of the Amazon Q in Connect assistant. Can be either
1704
2029
  # the ID or the ARN. URLs cannot contain the ARN.
1705
2030
  # @return [String]
1706
2031
  #
2032
+ # @!attribute [rw] blocked_input_messaging
2033
+ # The message to return when the AI Guardrail blocks a prompt.
2034
+ # @return [String]
2035
+ #
2036
+ # @!attribute [rw] blocked_outputs_messaging
2037
+ # The message to return when the AI Guardrail blocks a model response.
2038
+ # @return [String]
2039
+ #
1707
2040
  # @!attribute [rw] client_token
1708
2041
  # A unique, case-sensitive identifier that you provide to ensure the
1709
2042
  # idempotency of the request. If not provided, the Amazon Web Services
@@ -1718,72 +2051,78 @@ module Aws::QConnect
1718
2051
  # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1719
2052
  # @return [String]
1720
2053
  #
1721
- # @!attribute [rw] description
1722
- # The description of the AI Prompt.
1723
- # @return [String]
2054
+ # @!attribute [rw] content_policy_config
2055
+ # The content filter policies to configure for the AI Guardrail.
2056
+ # @return [Types::AIGuardrailContentPolicyConfig]
1724
2057
  #
1725
- # @!attribute [rw] model_id
1726
- # The identifier of the model used for this AI Prompt. Model Ids
1727
- # supported are: `CLAUDE_3_HAIKU_20240307_V1`
2058
+ # @!attribute [rw] contextual_grounding_policy_config
2059
+ # The contextual grounding policy configuration used to create an AI
2060
+ # Guardrail.
2061
+ # @return [Types::AIGuardrailContextualGroundingPolicyConfig]
2062
+ #
2063
+ # @!attribute [rw] description
2064
+ # A description of the AI Guardrail.
1728
2065
  # @return [String]
1729
2066
  #
1730
2067
  # @!attribute [rw] name
1731
- # The name of the AI Prompt.
2068
+ # The name of the AI Guardrail.
1732
2069
  # @return [String]
1733
2070
  #
2071
+ # @!attribute [rw] sensitive_information_policy_config
2072
+ # The sensitive information policy to configure for the AI Guardrail.
2073
+ # @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
2074
+ #
1734
2075
  # @!attribute [rw] tags
1735
2076
  # The tags used to organize, track, or control access for this
1736
2077
  # resource.
1737
2078
  # @return [Hash<String,String>]
1738
2079
  #
1739
- # @!attribute [rw] template_configuration
1740
- # The configuration of the prompt template for this AI Prompt.
1741
- # @return [Types::AIPromptTemplateConfiguration]
1742
- #
1743
- # @!attribute [rw] template_type
1744
- # The type of the prompt template for this AI Prompt.
1745
- # @return [String]
1746
- #
1747
- # @!attribute [rw] type
1748
- # The type of this AI Prompt.
1749
- # @return [String]
2080
+ # @!attribute [rw] topic_policy_config
2081
+ # The topic policies to configure for the AI Guardrail.
2082
+ # @return [Types::AIGuardrailTopicPolicyConfig]
1750
2083
  #
1751
2084
  # @!attribute [rw] visibility_status
1752
- # The visibility status of the AI Prompt.
2085
+ # The visibility status of the AI Guardrail.
1753
2086
  # @return [String]
1754
2087
  #
1755
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptRequest AWS API Documentation
2088
+ # @!attribute [rw] word_policy_config
2089
+ # The word policy you configure for the AI Guardrail.
2090
+ # @return [Types::AIGuardrailWordPolicyConfig]
1756
2091
  #
1757
- class CreateAIPromptRequest < Struct.new(
1758
- :api_format,
2092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailRequest AWS API Documentation
2093
+ #
2094
+ class CreateAIGuardrailRequest < Struct.new(
1759
2095
  :assistant_id,
2096
+ :blocked_input_messaging,
2097
+ :blocked_outputs_messaging,
1760
2098
  :client_token,
2099
+ :content_policy_config,
2100
+ :contextual_grounding_policy_config,
1761
2101
  :description,
1762
- :model_id,
1763
2102
  :name,
2103
+ :sensitive_information_policy_config,
1764
2104
  :tags,
1765
- :template_configuration,
1766
- :template_type,
1767
- :type,
1768
- :visibility_status)
1769
- SENSITIVE = []
2105
+ :topic_policy_config,
2106
+ :visibility_status,
2107
+ :word_policy_config)
2108
+ SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
1770
2109
  include Aws::Structure
1771
2110
  end
1772
2111
 
1773
- # @!attribute [rw] ai_prompt
1774
- # The data of the AI Prompt.
1775
- # @return [Types::AIPromptData]
2112
+ # @!attribute [rw] ai_guardrail
2113
+ # The data of the AI Guardrail.
2114
+ # @return [Types::AIGuardrailData]
1776
2115
  #
1777
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptResponse AWS API Documentation
2116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailResponse AWS API Documentation
1778
2117
  #
1779
- class CreateAIPromptResponse < Struct.new(
1780
- :ai_prompt)
2118
+ class CreateAIGuardrailResponse < Struct.new(
2119
+ :ai_guardrail)
1781
2120
  SENSITIVE = []
1782
2121
  include Aws::Structure
1783
2122
  end
1784
2123
 
1785
- # @!attribute [rw] ai_prompt_id
1786
- # The identifier of the Amazon Q in Connect AI prompt.
2124
+ # @!attribute [rw] ai_guardrail_id
2125
+ # The identifier of the Amazon Q in Connect AI Guardrail.
1787
2126
  # @return [String]
1788
2127
  #
1789
2128
  # @!attribute [rw] assistant_id
@@ -1806,13 +2145,13 @@ module Aws::QConnect
1806
2145
  # @return [String]
1807
2146
  #
1808
2147
  # @!attribute [rw] modified_time
1809
- # The time the AI Prompt was last modified.
2148
+ # The time the AI Guardrail was last modified.
1810
2149
  # @return [Time]
1811
2150
  #
1812
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionRequest AWS API Documentation
2151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionRequest AWS API Documentation
1813
2152
  #
1814
- class CreateAIPromptVersionRequest < Struct.new(
1815
- :ai_prompt_id,
2153
+ class CreateAIGuardrailVersionRequest < Struct.new(
2154
+ :ai_guardrail_id,
1816
2155
  :assistant_id,
1817
2156
  :client_token,
1818
2157
  :modified_time)
@@ -1820,41 +2159,37 @@ module Aws::QConnect
1820
2159
  include Aws::Structure
1821
2160
  end
1822
2161
 
1823
- # @!attribute [rw] ai_prompt
1824
- # The data of the AI Prompt version.
1825
- # @return [Types::AIPromptData]
2162
+ # @!attribute [rw] ai_guardrail
2163
+ # The data of the AI Guardrail version.
2164
+ # @return [Types::AIGuardrailData]
1826
2165
  #
1827
2166
  # @!attribute [rw] version_number
1828
- # The version number of the AI Prompt version.
2167
+ # The version number of the AI Guardrail version.
1829
2168
  # @return [Integer]
1830
2169
  #
1831
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionResponse AWS API Documentation
2170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionResponse AWS API Documentation
1832
2171
  #
1833
- class CreateAIPromptVersionResponse < Struct.new(
1834
- :ai_prompt,
2172
+ class CreateAIGuardrailVersionResponse < Struct.new(
2173
+ :ai_guardrail,
1835
2174
  :version_number)
1836
2175
  SENSITIVE = []
1837
2176
  include Aws::Structure
1838
2177
  end
1839
2178
 
2179
+ # @!attribute [rw] api_format
2180
+ # The API Format of the AI Prompt.
2181
+ # @return [String]
2182
+ #
1840
2183
  # @!attribute [rw] assistant_id
1841
2184
  # The identifier of the Amazon Q in Connect assistant. Can be either
1842
2185
  # the ID or the ARN. URLs cannot contain the ARN.
1843
2186
  # @return [String]
1844
2187
  #
1845
- # @!attribute [rw] association
1846
- # The identifier of the associated resource.
1847
- # @return [Types::AssistantAssociationInputData]
1848
- #
1849
- # @!attribute [rw] association_type
1850
- # The type of association.
1851
- # @return [String]
1852
- #
1853
2188
  # @!attribute [rw] client_token
1854
2189
  # A unique, case-sensitive identifier that you provide to ensure the
1855
2190
  # idempotency of the request. If not provided, the Amazon Web Services
1856
2191
  # SDK populates this field. For more information about idempotency,
1857
- # see [Making retries safe with idempotent APIs][1].
2192
+ # see [Making retries safe with idempotent APIs][1]..
1858
2193
  #
1859
2194
  # **A suitable default value is auto-generated.** You should normally
1860
2195
  # not need to pass this option.
@@ -1864,10 +2199,156 @@ module Aws::QConnect
1864
2199
  # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1865
2200
  # @return [String]
1866
2201
  #
1867
- # @!attribute [rw] tags
1868
- # The tags used to organize, track, or control access for this
1869
- # resource.
1870
- # @return [Hash<String,String>]
2202
+ # @!attribute [rw] description
2203
+ # The description of the AI Prompt.
2204
+ # @return [String]
2205
+ #
2206
+ # @!attribute [rw] model_id
2207
+ # The identifier of the model used for this AI Prompt. Model Ids
2208
+ # supported are: `CLAUDE_3_HAIKU_20240307_V1`
2209
+ # @return [String]
2210
+ #
2211
+ # @!attribute [rw] name
2212
+ # The name of the AI Prompt.
2213
+ # @return [String]
2214
+ #
2215
+ # @!attribute [rw] tags
2216
+ # The tags used to organize, track, or control access for this
2217
+ # resource.
2218
+ # @return [Hash<String,String>]
2219
+ #
2220
+ # @!attribute [rw] template_configuration
2221
+ # The configuration of the prompt template for this AI Prompt.
2222
+ # @return [Types::AIPromptTemplateConfiguration]
2223
+ #
2224
+ # @!attribute [rw] template_type
2225
+ # The type of the prompt template for this AI Prompt.
2226
+ # @return [String]
2227
+ #
2228
+ # @!attribute [rw] type
2229
+ # The type of this AI Prompt.
2230
+ # @return [String]
2231
+ #
2232
+ # @!attribute [rw] visibility_status
2233
+ # The visibility status of the AI Prompt.
2234
+ # @return [String]
2235
+ #
2236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptRequest AWS API Documentation
2237
+ #
2238
+ class CreateAIPromptRequest < Struct.new(
2239
+ :api_format,
2240
+ :assistant_id,
2241
+ :client_token,
2242
+ :description,
2243
+ :model_id,
2244
+ :name,
2245
+ :tags,
2246
+ :template_configuration,
2247
+ :template_type,
2248
+ :type,
2249
+ :visibility_status)
2250
+ SENSITIVE = []
2251
+ include Aws::Structure
2252
+ end
2253
+
2254
+ # @!attribute [rw] ai_prompt
2255
+ # The data of the AI Prompt.
2256
+ # @return [Types::AIPromptData]
2257
+ #
2258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptResponse AWS API Documentation
2259
+ #
2260
+ class CreateAIPromptResponse < Struct.new(
2261
+ :ai_prompt)
2262
+ SENSITIVE = []
2263
+ include Aws::Structure
2264
+ end
2265
+
2266
+ # @!attribute [rw] ai_prompt_id
2267
+ # The identifier of the Amazon Q in Connect AI prompt.
2268
+ # @return [String]
2269
+ #
2270
+ # @!attribute [rw] assistant_id
2271
+ # The identifier of the Amazon Q in Connect assistant. Can be either
2272
+ # the ID or the ARN. URLs cannot contain the ARN.
2273
+ # @return [String]
2274
+ #
2275
+ # @!attribute [rw] client_token
2276
+ # A unique, case-sensitive identifier that you provide to ensure the
2277
+ # idempotency of the request. If not provided, the Amazon Web Services
2278
+ # SDK populates this field. For more information about idempotency,
2279
+ # see [Making retries safe with idempotent APIs][1]..
2280
+ #
2281
+ # **A suitable default value is auto-generated.** You should normally
2282
+ # not need to pass this option.
2283
+ #
2284
+ #
2285
+ #
2286
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2287
+ # @return [String]
2288
+ #
2289
+ # @!attribute [rw] modified_time
2290
+ # The time the AI Prompt was last modified.
2291
+ # @return [Time]
2292
+ #
2293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionRequest AWS API Documentation
2294
+ #
2295
+ class CreateAIPromptVersionRequest < Struct.new(
2296
+ :ai_prompt_id,
2297
+ :assistant_id,
2298
+ :client_token,
2299
+ :modified_time)
2300
+ SENSITIVE = []
2301
+ include Aws::Structure
2302
+ end
2303
+
2304
+ # @!attribute [rw] ai_prompt
2305
+ # The data of the AI Prompt version.
2306
+ # @return [Types::AIPromptData]
2307
+ #
2308
+ # @!attribute [rw] version_number
2309
+ # The version number of the AI Prompt version.
2310
+ # @return [Integer]
2311
+ #
2312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionResponse AWS API Documentation
2313
+ #
2314
+ class CreateAIPromptVersionResponse < Struct.new(
2315
+ :ai_prompt,
2316
+ :version_number)
2317
+ SENSITIVE = []
2318
+ include Aws::Structure
2319
+ end
2320
+
2321
+ # @!attribute [rw] assistant_id
2322
+ # The identifier of the Amazon Q in Connect assistant. Can be either
2323
+ # the ID or the ARN. URLs cannot contain the ARN.
2324
+ # @return [String]
2325
+ #
2326
+ # @!attribute [rw] association
2327
+ # The identifier of the associated resource.
2328
+ # @return [Types::AssistantAssociationInputData]
2329
+ #
2330
+ # @!attribute [rw] association_type
2331
+ # The type of association.
2332
+ # @return [String]
2333
+ #
2334
+ # @!attribute [rw] client_token
2335
+ # A unique, case-sensitive identifier that you provide to ensure the
2336
+ # idempotency of the request. If not provided, the Amazon Web Services
2337
+ # SDK populates this field. For more information about idempotency,
2338
+ # see [Making retries safe with idempotent APIs][1].
2339
+ #
2340
+ # **A suitable default value is auto-generated.** You should normally
2341
+ # not need to pass this option.
2342
+ #
2343
+ #
2344
+ #
2345
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
2346
+ # @return [String]
2347
+ #
2348
+ # @!attribute [rw] tags
2349
+ # The tags used to organize, track, or control access for this
2350
+ # resource.
2351
+ # @return [Hash<String,String>]
1871
2352
  #
1872
2353
  # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociationRequest AWS API Documentation
1873
2354
  #
@@ -3060,6 +3541,56 @@ module Aws::QConnect
3060
3541
  #
3061
3542
  class DeleteAIAgentVersionResponse < Aws::EmptyStructure; end
3062
3543
 
3544
+ # @!attribute [rw] ai_guardrail_id
3545
+ # The identifier of the Amazon Q in Connect AI Guardrail. Can be
3546
+ # either the ID or the ARN. URLs cannot contain the ARN.
3547
+ # @return [String]
3548
+ #
3549
+ # @!attribute [rw] assistant_id
3550
+ # The identifier of the Amazon Q in Connect assistant. Can be either
3551
+ # the ID or the ARN. URLs cannot contain the ARN.
3552
+ # @return [String]
3553
+ #
3554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailRequest AWS API Documentation
3555
+ #
3556
+ class DeleteAIGuardrailRequest < Struct.new(
3557
+ :ai_guardrail_id,
3558
+ :assistant_id)
3559
+ SENSITIVE = []
3560
+ include Aws::Structure
3561
+ end
3562
+
3563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailResponse AWS API Documentation
3564
+ #
3565
+ class DeleteAIGuardrailResponse < Aws::EmptyStructure; end
3566
+
3567
+ # @!attribute [rw] ai_guardrail_id
3568
+ # The identifier of the Amazon Q in Connect AI Guardrail.
3569
+ # @return [String]
3570
+ #
3571
+ # @!attribute [rw] assistant_id
3572
+ # The identifier of the Amazon Q in Connect assistant. Can be either
3573
+ # the ID or the ARN. URLs cannot contain the ARN.
3574
+ # @return [String]
3575
+ #
3576
+ # @!attribute [rw] version_number
3577
+ # The version number of the AI Guardrail version to be deleted.
3578
+ # @return [Integer]
3579
+ #
3580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailVersionRequest AWS API Documentation
3581
+ #
3582
+ class DeleteAIGuardrailVersionRequest < Struct.new(
3583
+ :ai_guardrail_id,
3584
+ :assistant_id,
3585
+ :version_number)
3586
+ SENSITIVE = []
3587
+ include Aws::Structure
3588
+ end
3589
+
3590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DeleteAIGuardrailVersionResponse AWS API Documentation
3591
+ #
3592
+ class DeleteAIGuardrailVersionResponse < Aws::EmptyStructure; end
3593
+
3063
3594
  # @!attribute [rw] ai_prompt_id
3064
3595
  # The identifier of the Amazon Q in Connect AI prompt. Can be either
3065
3596
  # the ID or the ARN. URLs cannot contain the ARN.
@@ -3707,6 +4238,43 @@ module Aws::QConnect
3707
4238
  include Aws::Structure
3708
4239
  end
3709
4240
 
4241
+ # @!attribute [rw] ai_guardrail_id
4242
+ # The identifier of the Amazon Q in Connect AI Guardrail.
4243
+ # @return [String]
4244
+ #
4245
+ # @!attribute [rw] assistant_id
4246
+ # The identifier of the Amazon Q in Connect assistant. Can be either
4247
+ # the ID or the ARN. URLs cannot contain the ARN.
4248
+ # @return [String]
4249
+ #
4250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIGuardrailRequest AWS API Documentation
4251
+ #
4252
+ class GetAIGuardrailRequest < Struct.new(
4253
+ :ai_guardrail_id,
4254
+ :assistant_id)
4255
+ SENSITIVE = []
4256
+ include Aws::Structure
4257
+ end
4258
+
4259
+ # @!attribute [rw] ai_guardrail
4260
+ # The data of the AI Guardrail.
4261
+ # @return [Types::AIGuardrailData]
4262
+ #
4263
+ # @!attribute [rw] version_number
4264
+ # The version number of the AI Guardrail version (returned if an AI
4265
+ # Guardrail version was specified via use of a qualifier for the
4266
+ # `aiGuardrailId` on the request).
4267
+ # @return [Integer]
4268
+ #
4269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetAIGuardrailResponse AWS API Documentation
4270
+ #
4271
+ class GetAIGuardrailResponse < Struct.new(
4272
+ :ai_guardrail,
4273
+ :version_number)
4274
+ SENSITIVE = []
4275
+ include Aws::Structure
4276
+ end
4277
+
3710
4278
  # @!attribute [rw] ai_prompt_id
3711
4279
  # The identifier of the Amazon Q in Connect AI prompt.
3712
4280
  # @return [String]
@@ -3984,6 +4552,67 @@ module Aws::QConnect
3984
4552
  include Aws::Structure
3985
4553
  end
3986
4554
 
4555
+ # @!attribute [rw] assistant_id
4556
+ # The identifier of the Amazon Q in Connect assistant.
4557
+ # @return [String]
4558
+ #
4559
+ # @!attribute [rw] next_message_token
4560
+ # The token for the next message. Use the value returned in the
4561
+ # SendMessage or previous response in the next request to retrieve the
4562
+ # next message.
4563
+ # @return [String]
4564
+ #
4565
+ # @!attribute [rw] session_id
4566
+ # The identifier of the Amazon Q in Connect session.
4567
+ # @return [String]
4568
+ #
4569
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageRequest AWS API Documentation
4570
+ #
4571
+ class GetNextMessageRequest < Struct.new(
4572
+ :assistant_id,
4573
+ :next_message_token,
4574
+ :session_id)
4575
+ SENSITIVE = []
4576
+ include Aws::Structure
4577
+ end
4578
+
4579
+ # @!attribute [rw] conversation_session_data
4580
+ # The conversation data stored on an Amazon Q in Connect Session.
4581
+ # @return [Array<Types::RuntimeSessionData>]
4582
+ #
4583
+ # @!attribute [rw] conversation_state
4584
+ # The state of current conversation.
4585
+ # @return [Types::ConversationState]
4586
+ #
4587
+ # @!attribute [rw] next_message_token
4588
+ # The token for the next message.
4589
+ # @return [String]
4590
+ #
4591
+ # @!attribute [rw] request_message_id
4592
+ # The identifier of the submitted message.
4593
+ # @return [String]
4594
+ #
4595
+ # @!attribute [rw] response
4596
+ # The message response to the requested message.
4597
+ # @return [Types::MessageOutput]
4598
+ #
4599
+ # @!attribute [rw] type
4600
+ # The type of message response.
4601
+ # @return [String]
4602
+ #
4603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageResponse AWS API Documentation
4604
+ #
4605
+ class GetNextMessageResponse < Struct.new(
4606
+ :conversation_session_data,
4607
+ :conversation_state,
4608
+ :next_message_token,
4609
+ :request_message_id,
4610
+ :response,
4611
+ :type)
4612
+ SENSITIVE = []
4613
+ include Aws::Structure
4614
+ end
4615
+
3987
4616
  # @!attribute [rw] knowledge_base_id
3988
4617
  # The identifier of the knowledge base. This should be a
3989
4618
  # QUICK\_RESPONSES type knowledge base.
@@ -4141,6 +4770,416 @@ module Aws::QConnect
4141
4770
  include Aws::Structure
4142
4771
  end
4143
4772
 
4773
+ # Contains filter strengths for harmful content. AI Guardrail's support
4774
+ # the following content filters to detect and filter harmful user inputs
4775
+ # and FM-generated outputs.
4776
+ #
4777
+ # * **Hate**: Describes input prompts and model responses that
4778
+ # discriminate, criticize, insult, denounce, or dehumanize a person or
4779
+ # group on the basis of an identity (such as race, ethnicity, gender,
4780
+ # religion, sexual orientation, ability, and national origin).
4781
+ #
4782
+ # * **Insults**: Describes input prompts and model responses that
4783
+ # includes demeaning, humiliating, mocking, insulting, or belittling
4784
+ # language. This type of language is also labeled as bullying.
4785
+ #
4786
+ # * **Sexual**: Describes input prompts and model responses that
4787
+ # indicates sexual interest, activity, or arousal using direct or
4788
+ # indirect references to body parts, physical traits, or sex.
4789
+ #
4790
+ # * **Violence**: Describes input prompts and model responses that
4791
+ # includes glorification of, or threats to inflict physical pain,
4792
+ # hurt, or injury toward a person, group, or thing.
4793
+ #
4794
+ # Content filtering depends on the confidence classification of user
4795
+ # inputs and FM responses across each of the four harmful categories.
4796
+ # All input and output statements are classified into one of four
4797
+ # confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category.
4798
+ # For example, if a statement is classified as *Hate* with HIGH
4799
+ # confidence, the likelihood of the statement representing hateful
4800
+ # content is high. A single statement can be classified across multiple
4801
+ # categories with varying confidence levels. For example, a single
4802
+ # statement can be classified as *Hate* with HIGH confidence, <i>
4803
+ # Insults</i> with LOW confidence, *Sexual* with NONE confidence, and
4804
+ # *Violence* with MEDIUM confidence.
4805
+ #
4806
+ # @!attribute [rw] input_strength
4807
+ # The strength of the content filter to apply to prompts. As you
4808
+ # increase the filter strength, the likelihood of filtering harmful
4809
+ # content increases and the probability of seeing harmful content in
4810
+ # your application reduces.
4811
+ # @return [String]
4812
+ #
4813
+ # @!attribute [rw] output_strength
4814
+ # The strength of the content filter to apply to model responses. As
4815
+ # you increase the filter strength, the likelihood of filtering
4816
+ # harmful content increases and the probability of seeing harmful
4817
+ # content in your application reduces.
4818
+ # @return [String]
4819
+ #
4820
+ # @!attribute [rw] type
4821
+ # The harmful category that the content filter is applied to.
4822
+ # @return [String]
4823
+ #
4824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailContentFilterConfig AWS API Documentation
4825
+ #
4826
+ class GuardrailContentFilterConfig < Struct.new(
4827
+ :input_strength,
4828
+ :output_strength,
4829
+ :type)
4830
+ SENSITIVE = [:input_strength, :output_strength, :type]
4831
+ include Aws::Structure
4832
+ end
4833
+
4834
+ # The filter configuration details for the AI Guardrail's contextual
4835
+ # grounding filter.
4836
+ #
4837
+ # @!attribute [rw] threshold
4838
+ # The threshold details for the AI Guardrail's contextual grounding
4839
+ # filter.
4840
+ # @return [Float]
4841
+ #
4842
+ # @!attribute [rw] type
4843
+ # The filter type for the AI Guardrail's contextual grounding filter.
4844
+ # @return [String]
4845
+ #
4846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailContextualGroundingFilterConfig AWS API Documentation
4847
+ #
4848
+ class GuardrailContextualGroundingFilterConfig < Struct.new(
4849
+ :threshold,
4850
+ :type)
4851
+ SENSITIVE = [:threshold, :type]
4852
+ include Aws::Structure
4853
+ end
4854
+
4855
+ # The managed word list to configure for the AI Guardrail.
4856
+ #
4857
+ # @!attribute [rw] type
4858
+ # The managed word type to configure for the AI Guardrail.
4859
+ # @return [String]
4860
+ #
4861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailManagedWordsConfig AWS API Documentation
4862
+ #
4863
+ class GuardrailManagedWordsConfig < Struct.new(
4864
+ :type)
4865
+ SENSITIVE = [:type]
4866
+ include Aws::Structure
4867
+ end
4868
+
4869
+ # The PII entity to configure for the AI Guardrail.
4870
+ #
4871
+ # @!attribute [rw] action
4872
+ # Configure AI Guardrail's action when the PII entity is detected.
4873
+ # @return [String]
4874
+ #
4875
+ # @!attribute [rw] type
4876
+ # Configure AI Guardrail type when the PII entity is detected.
4877
+ #
4878
+ # The following PIIs are used to block or mask sensitive information:
4879
+ #
4880
+ # * **General**
4881
+ #
4882
+ # * **ADDRESS**
4883
+ #
4884
+ # A physical address, such as "100 Main Street, Anytown, USA" or
4885
+ # "Suite #12, Building 123". An address can include information
4886
+ # such as the street, building, location, city, state, country,
4887
+ # county, zip code, precinct, and neighborhood.
4888
+ #
4889
+ # * **AGE**
4890
+ #
4891
+ # An individual's age, including the quantity and unit of time.
4892
+ # For example, in the phrase "I am 40 years old," Guarrails
4893
+ # recognizes "40 years" as an age.
4894
+ #
4895
+ # * **NAME**
4896
+ #
4897
+ # An individual's name. This entity type does not include titles,
4898
+ # such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply
4899
+ # this entity type to names that are part of organizations or
4900
+ # addresses. For example, AI Guardrail recognizes the "John Doe
4901
+ # Organization" as an organization, and it recognizes "Jane Doe
4902
+ # Street" as an address.
4903
+ #
4904
+ # * **EMAIL**
4905
+ #
4906
+ # An email address, such as *marymajor@email.com*.
4907
+ #
4908
+ # * **PHONE**
4909
+ #
4910
+ # A phone number. This entity type also includes fax and pager
4911
+ # numbers.
4912
+ #
4913
+ # * **USERNAME**
4914
+ #
4915
+ # A user name that identifies an account, such as a login name,
4916
+ # screen name, nick name, or handle.
4917
+ #
4918
+ # * **PASSWORD**
4919
+ #
4920
+ # An alphanumeric string that is used as a password, such as
4921
+ # "*<i> very20special#pass*</i>".
4922
+ #
4923
+ # * **DRIVER\_ID**
4924
+ #
4925
+ # The number assigned to a driver's license, which is an official
4926
+ # document permitting an individual to operate one or more
4927
+ # motorized vehicles on a public road. A driver's license number
4928
+ # consists of alphanumeric characters.
4929
+ #
4930
+ # * **LICENSE\_PLATE**
4931
+ #
4932
+ # A license plate for a vehicle is issued by the state or country
4933
+ # where the vehicle is registered. The format for passenger
4934
+ # vehicles is typically five to eight digits, consisting of
4935
+ # upper-case letters and numbers. The format varies depending on
4936
+ # the location of the issuing state or country.
4937
+ #
4938
+ # * **VEHICLE\_IDENTIFICATION\_NUMBER**
4939
+ #
4940
+ # A Vehicle Identification Number (VIN) uniquely identifies a
4941
+ # vehicle. VIN content and format are defined in the *ISO 3779*
4942
+ # specification. Each country has specific codes and formats for
4943
+ # VINs.
4944
+ # * **Finance**
4945
+ #
4946
+ # * **CREDIT\_DEBIT\_CARD\_CVV**
4947
+ #
4948
+ # A three-digit card verification code (CVV) that is present on
4949
+ # VISA, MasterCard, and Discover credit and debit cards. For
4950
+ # American Express credit or debit cards, the CVV is a four-digit
4951
+ # numeric code.
4952
+ #
4953
+ # * **CREDIT\_DEBIT\_CARD\_EXPIRY**
4954
+ #
4955
+ # The expiration date for a credit or debit card. This number is
4956
+ # usually four digits long and is often formatted as *month/year*
4957
+ # or *MM/YY*. AI Guardrail recognizes expiration dates such as
4958
+ # *01/21*, *01/2021*, and *Jan 2021*.
4959
+ #
4960
+ # * **CREDIT\_DEBIT\_CARD\_NUMBER**
4961
+ #
4962
+ # The number for a credit or debit card. These numbers can vary
4963
+ # from 13 to 16 digits in length. However, Amazon Comprehend also
4964
+ # recognizes credit or debit card numbers when only the last four
4965
+ # digits are present.
4966
+ #
4967
+ # * **PIN**
4968
+ #
4969
+ # A four-digit personal identification number (PIN) with which you
4970
+ # can access your bank account.
4971
+ #
4972
+ # * **INTERNATIONAL\_BANK\_ACCOUNT\_NUMBER**
4973
+ #
4974
+ # An International Bank Account Number has specific formats in
4975
+ # each country. For more information, see [
4976
+ # www.iban.com/structure][1].
4977
+ #
4978
+ # * **SWIFT\_CODE**
4979
+ #
4980
+ # A SWIFT code is a standard format of Bank Identifier Code (BIC)
4981
+ # used to specify a particular bank or branch. Banks use these
4982
+ # codes for money transfers such as international wire transfers.
4983
+ #
4984
+ # SWIFT codes consist of eight or 11 characters. The 11-digit
4985
+ # codes refer to specific branches, while eight-digit codes (or
4986
+ # 11-digit codes ending in 'XXX') refer to the head or primary
4987
+ # office.
4988
+ # * **IT**
4989
+ #
4990
+ # * **IP\_ADDRESS**
4991
+ #
4992
+ # An IPv4 address, such as *198.51.100.0*.
4993
+ #
4994
+ # * **MAC\_ADDRESS**
4995
+ #
4996
+ # A *media access control* (MAC) address is a unique identifier
4997
+ # assigned to a network interface controller (NIC).
4998
+ #
4999
+ # * **URL**
5000
+ #
5001
+ # A web address, such as *www.example.com*.
5002
+ #
5003
+ # * **AWS\_ACCESS\_KEY**
5004
+ #
5005
+ # A unique identifier that's associated with a secret access key;
5006
+ # you use the access key ID and secret access key to sign
5007
+ # programmatic Amazon Web Services requests cryptographically.
5008
+ #
5009
+ # * **AWS\_SECRET\_KEY**
5010
+ #
5011
+ # A unique identifier that's associated with an access key. You
5012
+ # use the access key ID and secret access key to sign programmatic
5013
+ # Amazon Web Services requests cryptographically.
5014
+ # * **USA specific**
5015
+ #
5016
+ # * **US\_BANK\_ACCOUNT\_NUMBER**
5017
+ #
5018
+ # A US bank account number, which is typically 10 to 12 digits
5019
+ # long.
5020
+ #
5021
+ # * **US\_BANK\_ROUTING\_NUMBER**
5022
+ #
5023
+ # A US bank account routing number. These are typically nine
5024
+ # digits long,
5025
+ #
5026
+ # * **US\_INDIVIDUAL\_TAX\_IDENTIFICATION\_NUMBER**
5027
+ #
5028
+ # A US Individual Taxpayer Identification Number (ITIN) is a
5029
+ # nine-digit number that starts with a "9" and contain a "7"
5030
+ # or "8" as the fourth digit. An ITIN can be formatted with a
5031
+ # space or a dash after the third and forth digits.
5032
+ #
5033
+ # * **US\_PASSPORT\_NUMBER**
5034
+ #
5035
+ # A US passport number. Passport numbers range from six to nine
5036
+ # alphanumeric characters.
5037
+ #
5038
+ # * **US\_SOCIAL\_SECURITY\_NUMBER**
5039
+ #
5040
+ # A US Social Security Number (SSN) is a nine-digit number that is
5041
+ # issued to US citizens, permanent residents, and temporary
5042
+ # working residents.
5043
+ # * **Canada specific**
5044
+ #
5045
+ # * **CA\_HEALTH\_NUMBER**
5046
+ #
5047
+ # A Canadian Health Service Number is a 10-digit unique
5048
+ # identifier, required for individuals to access healthcare
5049
+ # benefits.
5050
+ #
5051
+ # * **CA\_SOCIAL\_INSURANCE\_NUMBER**
5052
+ #
5053
+ # A Canadian Social Insurance Number (SIN) is a nine-digit unique
5054
+ # identifier, required for individuals to access government
5055
+ # programs and benefits.
5056
+ #
5057
+ # The SIN is formatted as three groups of three digits, such as
5058
+ # <i> 123-456-789</i>. A SIN can be validated through a simple
5059
+ # check-digit process called the [Luhn algorithm][2] .
5060
+ # * **UK Specific**
5061
+ #
5062
+ # * **UK\_NATIONAL\_HEALTH\_SERVICE\_NUMBER**
5063
+ #
5064
+ # A UK National Health Service Number is a 10-17 digit number,
5065
+ # such as *485 555 3456*. The current system formats the 10-digit
5066
+ # number with spaces after the third and sixth digits. The final
5067
+ # digit is an error-detecting checksum.
5068
+ #
5069
+ # * **UK\_NATIONAL\_INSURANCE\_NUMBER**
5070
+ #
5071
+ # A UK National Insurance Number (NINO) provides individuals with
5072
+ # access to National Insurance (social security) benefits. It is
5073
+ # also used for some purposes in the UK tax system.
5074
+ #
5075
+ # The number is nine digits long and starts with two letters,
5076
+ # followed by six numbers and one letter. A NINO can be formatted
5077
+ # with a space or a dash after the two letters and after the
5078
+ # second, forth, and sixth digits.
5079
+ #
5080
+ # * **UK\_UNIQUE\_TAXPAYER\_REFERENCE\_NUMBER**
5081
+ #
5082
+ # A UK Unique Taxpayer Reference (UTR) is a 10-digit number that
5083
+ # identifies a taxpayer or a business.
5084
+ # * **Custom**
5085
+ #
5086
+ # * **Regex filter** - You can use a regular expressions to define
5087
+ # patterns for an AI Guardrail to recognize and act upon such as
5088
+ # serial number, booking ID etc..
5089
+ #
5090
+ # ^
5091
+ #
5092
+ #
5093
+ #
5094
+ # [1]: https://www.iban.com/structure
5095
+ # [2]: https://www.wikipedia.org/wiki/Luhn_algorithm
5096
+ # @return [String]
5097
+ #
5098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailPiiEntityConfig AWS API Documentation
5099
+ #
5100
+ class GuardrailPiiEntityConfig < Struct.new(
5101
+ :action,
5102
+ :type)
5103
+ SENSITIVE = [:action, :type]
5104
+ include Aws::Structure
5105
+ end
5106
+
5107
+ # The regular expression to configure for the AI Guardrail.
5108
+ #
5109
+ # @!attribute [rw] action
5110
+ # The AI Guardrail action to configure when matching regular
5111
+ # expression is detected.
5112
+ # @return [String]
5113
+ #
5114
+ # @!attribute [rw] description
5115
+ # The description of the regular expression to configure for the AI
5116
+ # Guardrail.
5117
+ # @return [String]
5118
+ #
5119
+ # @!attribute [rw] name
5120
+ # The name of the regular expression to configure for the AI
5121
+ # Guardrail.
5122
+ # @return [String]
5123
+ #
5124
+ # @!attribute [rw] pattern
5125
+ # The regular expression pattern to configure for the AI Guardrail.
5126
+ # @return [String]
5127
+ #
5128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailRegexConfig AWS API Documentation
5129
+ #
5130
+ class GuardrailRegexConfig < Struct.new(
5131
+ :action,
5132
+ :description,
5133
+ :name,
5134
+ :pattern)
5135
+ SENSITIVE = [:action, :description, :name, :pattern]
5136
+ include Aws::Structure
5137
+ end
5138
+
5139
+ # Details about topics for the AI Guardrail to identify and deny.
5140
+ #
5141
+ # @!attribute [rw] definition
5142
+ # A definition of the topic to deny.
5143
+ # @return [String]
5144
+ #
5145
+ # @!attribute [rw] examples
5146
+ # A list of prompts, each of which is an example of a prompt that can
5147
+ # be categorized as belonging to the topic.
5148
+ # @return [Array<String>]
5149
+ #
5150
+ # @!attribute [rw] name
5151
+ # The name of the topic to deny.
5152
+ # @return [String]
5153
+ #
5154
+ # @!attribute [rw] type
5155
+ # Specifies to deny the topic.
5156
+ # @return [String]
5157
+ #
5158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailTopicConfig AWS API Documentation
5159
+ #
5160
+ class GuardrailTopicConfig < Struct.new(
5161
+ :definition,
5162
+ :examples,
5163
+ :name,
5164
+ :type)
5165
+ SENSITIVE = [:definition, :examples, :name, :type]
5166
+ include Aws::Structure
5167
+ end
5168
+
5169
+ # A word to configure for the AI Guardrail.
5170
+ #
5171
+ # @!attribute [rw] text
5172
+ # Text of the word configured for the AI Guardrail to block.
5173
+ # @return [String]
5174
+ #
5175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GuardrailWordConfig AWS API Documentation
5176
+ #
5177
+ class GuardrailWordConfig < Struct.new(
5178
+ :text)
5179
+ SENSITIVE = [:text]
5180
+ include Aws::Structure
5181
+ end
5182
+
4144
5183
  # Settings for hierarchical document chunking for a data source.
4145
5184
  # Hierarchical chunking splits documents into layers of chunks where the
4146
5185
  # first layer contains large chunks, and the second layer contains
@@ -4597,8 +5636,116 @@ module Aws::QConnect
4597
5636
  include Aws::Structure
4598
5637
  end
4599
5638
 
4600
- # @!attribute [rw] ai_agent_id
4601
- # The identifier of the Amazon Q in Connect AI Agent for which
5639
+ # @!attribute [rw] ai_agent_id
5640
+ # The identifier of the Amazon Q in Connect AI Agent for which
5641
+ # versions are to be listed.
5642
+ # @return [String]
5643
+ #
5644
+ # @!attribute [rw] assistant_id
5645
+ # The identifier of the Amazon Q in Connect assistant. Can be either
5646
+ # the ID or the ARN. URLs cannot contain the ARN.
5647
+ # @return [String]
5648
+ #
5649
+ # @!attribute [rw] max_results
5650
+ # The maximum number of results to return per page.
5651
+ # @return [Integer]
5652
+ #
5653
+ # @!attribute [rw] next_token
5654
+ # The token for the next set of results. Use the value returned in the
5655
+ # previous response in the next request to retrieve the next set of
5656
+ # results.
5657
+ # @return [String]
5658
+ #
5659
+ # @!attribute [rw] origin
5660
+ # The origin of the AI Agent versions to be listed. `SYSTEM` for a
5661
+ # default AI Agent created by Q in Connect or `CUSTOMER` for an AI
5662
+ # Agent created by calling AI Agent creation APIs.
5663
+ # @return [String]
5664
+ #
5665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsRequest AWS API Documentation
5666
+ #
5667
+ class ListAIAgentVersionsRequest < Struct.new(
5668
+ :ai_agent_id,
5669
+ :assistant_id,
5670
+ :max_results,
5671
+ :next_token,
5672
+ :origin)
5673
+ SENSITIVE = []
5674
+ include Aws::Structure
5675
+ end
5676
+
5677
+ # @!attribute [rw] ai_agent_version_summaries
5678
+ # The summaries of AI Agent versions.
5679
+ # @return [Array<Types::AIAgentVersionSummary>]
5680
+ #
5681
+ # @!attribute [rw] next_token
5682
+ # The token for the next set of results. Use the value returned in the
5683
+ # previous response in the next request to retrieve the next set of
5684
+ # results.
5685
+ # @return [String]
5686
+ #
5687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsResponse AWS API Documentation
5688
+ #
5689
+ class ListAIAgentVersionsResponse < Struct.new(
5690
+ :ai_agent_version_summaries,
5691
+ :next_token)
5692
+ SENSITIVE = []
5693
+ include Aws::Structure
5694
+ end
5695
+
5696
+ # @!attribute [rw] assistant_id
5697
+ # The identifier of the Amazon Q in Connect assistant. Can be either
5698
+ # the ID or the ARN. URLs cannot contain the ARN.
5699
+ # @return [String]
5700
+ #
5701
+ # @!attribute [rw] max_results
5702
+ # The maximum number of results to return per page.
5703
+ # @return [Integer]
5704
+ #
5705
+ # @!attribute [rw] next_token
5706
+ # The token for the next set of results. Use the value returned in the
5707
+ # previous response in the next request to retrieve the next set of
5708
+ # results.
5709
+ # @return [String]
5710
+ #
5711
+ # @!attribute [rw] origin
5712
+ # The origin of the AI Agents to be listed. `SYSTEM` for a default AI
5713
+ # Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
5714
+ # by calling AI Agent creation APIs.
5715
+ # @return [String]
5716
+ #
5717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsRequest AWS API Documentation
5718
+ #
5719
+ class ListAIAgentsRequest < Struct.new(
5720
+ :assistant_id,
5721
+ :max_results,
5722
+ :next_token,
5723
+ :origin)
5724
+ SENSITIVE = []
5725
+ include Aws::Structure
5726
+ end
5727
+
5728
+ # @!attribute [rw] ai_agent_summaries
5729
+ # The summaries of AI Agents.
5730
+ # @return [Array<Types::AIAgentSummary>]
5731
+ #
5732
+ # @!attribute [rw] next_token
5733
+ # The token for the next set of results. Use the value returned in the
5734
+ # previous response in the next request to retrieve the next set of
5735
+ # results.
5736
+ # @return [String]
5737
+ #
5738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsResponse AWS API Documentation
5739
+ #
5740
+ class ListAIAgentsResponse < Struct.new(
5741
+ :ai_agent_summaries,
5742
+ :next_token)
5743
+ SENSITIVE = []
5744
+ include Aws::Structure
5745
+ end
5746
+
5747
+ # @!attribute [rw] ai_guardrail_id
5748
+ # The identifier of the Amazon Q in Connect AI Guardrail for which
4602
5749
  # versions are to be listed.
4603
5750
  # @return [String]
4604
5751
  #
@@ -4617,27 +5764,20 @@ module Aws::QConnect
4617
5764
  # results.
4618
5765
  # @return [String]
4619
5766
  #
4620
- # @!attribute [rw] origin
4621
- # The origin of the AI Agent versions to be listed. `SYSTEM` for a
4622
- # default AI Agent created by Q in Connect or `CUSTOMER` for an AI
4623
- # Agent created by calling AI Agent creation APIs.
4624
- # @return [String]
4625
- #
4626
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsRequest AWS API Documentation
5767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsRequest AWS API Documentation
4627
5768
  #
4628
- class ListAIAgentVersionsRequest < Struct.new(
4629
- :ai_agent_id,
5769
+ class ListAIGuardrailVersionsRequest < Struct.new(
5770
+ :ai_guardrail_id,
4630
5771
  :assistant_id,
4631
5772
  :max_results,
4632
- :next_token,
4633
- :origin)
5773
+ :next_token)
4634
5774
  SENSITIVE = []
4635
5775
  include Aws::Structure
4636
5776
  end
4637
5777
 
4638
- # @!attribute [rw] ai_agent_version_summaries
4639
- # The summaries of AI Agent versions.
4640
- # @return [Array<Types::AIAgentVersionSummary>]
5778
+ # @!attribute [rw] ai_guardrail_version_summaries
5779
+ # The summaries of the AI Guardrail versions.
5780
+ # @return [Array<Types::AIGuardrailVersionSummary>]
4641
5781
  #
4642
5782
  # @!attribute [rw] next_token
4643
5783
  # The token for the next set of results. Use the value returned in the
@@ -4645,10 +5785,10 @@ module Aws::QConnect
4645
5785
  # results.
4646
5786
  # @return [String]
4647
5787
  #
4648
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsResponse AWS API Documentation
5788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsResponse AWS API Documentation
4649
5789
  #
4650
- class ListAIAgentVersionsResponse < Struct.new(
4651
- :ai_agent_version_summaries,
5790
+ class ListAIGuardrailVersionsResponse < Struct.new(
5791
+ :ai_guardrail_version_summaries,
4652
5792
  :next_token)
4653
5793
  SENSITIVE = []
4654
5794
  include Aws::Structure
@@ -4669,26 +5809,19 @@ module Aws::QConnect
4669
5809
  # results.
4670
5810
  # @return [String]
4671
5811
  #
4672
- # @!attribute [rw] origin
4673
- # The origin of the AI Agents to be listed. `SYSTEM` for a default AI
4674
- # Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
4675
- # by calling AI Agent creation APIs.
4676
- # @return [String]
4677
- #
4678
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsRequest AWS API Documentation
5812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsRequest AWS API Documentation
4679
5813
  #
4680
- class ListAIAgentsRequest < Struct.new(
5814
+ class ListAIGuardrailsRequest < Struct.new(
4681
5815
  :assistant_id,
4682
5816
  :max_results,
4683
- :next_token,
4684
- :origin)
5817
+ :next_token)
4685
5818
  SENSITIVE = []
4686
5819
  include Aws::Structure
4687
5820
  end
4688
5821
 
4689
- # @!attribute [rw] ai_agent_summaries
4690
- # The summaries of AI Agents.
4691
- # @return [Array<Types::AIAgentSummary>]
5822
+ # @!attribute [rw] ai_guardrail_summaries
5823
+ # The summaries of the AI Guardrails.
5824
+ # @return [Array<Types::AIGuardrailSummary>]
4692
5825
  #
4693
5826
  # @!attribute [rw] next_token
4694
5827
  # The token for the next set of results. Use the value returned in the
@@ -4696,10 +5829,10 @@ module Aws::QConnect
4696
5829
  # results.
4697
5830
  # @return [String]
4698
5831
  #
4699
- # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsResponse AWS API Documentation
5832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsResponse AWS API Documentation
4700
5833
  #
4701
- class ListAIAgentsResponse < Struct.new(
4702
- :ai_agent_summaries,
5834
+ class ListAIGuardrailsResponse < Struct.new(
5835
+ :ai_guardrail_summaries,
4703
5836
  :next_token)
4704
5837
  SENSITIVE = []
4705
5838
  include Aws::Structure
@@ -5157,6 +6290,54 @@ module Aws::QConnect
5157
6290
  include Aws::Structure
5158
6291
  end
5159
6292
 
6293
+ # @!attribute [rw] assistant_id
6294
+ # The identifier of the Amazon Q in Connect assistant.
6295
+ # @return [String]
6296
+ #
6297
+ # @!attribute [rw] max_results
6298
+ # The maximum number of results to return per page.
6299
+ # @return [Integer]
6300
+ #
6301
+ # @!attribute [rw] next_token
6302
+ # The token for the next set of results. Use the value returned in the
6303
+ # previous response in the next request to retrieve the next set of
6304
+ # results.
6305
+ # @return [String]
6306
+ #
6307
+ # @!attribute [rw] session_id
6308
+ # The identifier of the Amazon Q in Connect session.
6309
+ # @return [String]
6310
+ #
6311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesRequest AWS API Documentation
6312
+ #
6313
+ class ListMessagesRequest < Struct.new(
6314
+ :assistant_id,
6315
+ :max_results,
6316
+ :next_token,
6317
+ :session_id)
6318
+ SENSITIVE = []
6319
+ include Aws::Structure
6320
+ end
6321
+
6322
+ # @!attribute [rw] messages
6323
+ # The message information.
6324
+ # @return [Array<Types::MessageOutput>]
6325
+ #
6326
+ # @!attribute [rw] next_token
6327
+ # The token for the next set of results. Use the value returned in the
6328
+ # previous response in the next request to retrieve the next set of
6329
+ # results.
6330
+ # @return [String]
6331
+ #
6332
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesResponse AWS API Documentation
6333
+ #
6334
+ class ListMessagesResponse < Struct.new(
6335
+ :messages,
6336
+ :next_token)
6337
+ SENSITIVE = []
6338
+ include Aws::Structure
6339
+ end
6340
+
5160
6341
  # @!attribute [rw] knowledge_base_id
5161
6342
  # The identifier of the knowledge base. Can be either the ID or the
5162
6343
  # ARN. URLs cannot contain the ARN.
@@ -5251,6 +6432,11 @@ module Aws::QConnect
5251
6432
 
5252
6433
  # The configuration for the `MANUAL_SEARCH` AI Agent type.
5253
6434
  #
6435
+ # @!attribute [rw] answer_generation_ai_guardrail_id
6436
+ # The AI Guardrail identifier for the Answer Generation guardrail used
6437
+ # by the MANUAL\_SEARCH AI Agent.
6438
+ # @return [String]
6439
+ #
5254
6440
  # @!attribute [rw] answer_generation_ai_prompt_id
5255
6441
  # The AI Prompt identifier for the Answer Generation prompt used by
5256
6442
  # the MANUAL\_SEARCH AI Agent.
@@ -5261,11 +6447,88 @@ module Aws::QConnect
5261
6447
  # Agent.
5262
6448
  # @return [Array<Types::AssociationConfiguration>]
5263
6449
  #
6450
+ # @!attribute [rw] locale
6451
+ # The locale to which specifies the language and region settings that
6452
+ # determine the response language for [QueryAssistant][1].
6453
+ #
6454
+ #
6455
+ #
6456
+ # [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_QueryAssistant.html
6457
+ # @return [String]
6458
+ #
5264
6459
  # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
5265
6460
  #
5266
6461
  class ManualSearchAIAgentConfiguration < Struct.new(
6462
+ :answer_generation_ai_guardrail_id,
5267
6463
  :answer_generation_ai_prompt_id,
5268
- :association_configurations)
6464
+ :association_configurations,
6465
+ :locale)
6466
+ SENSITIVE = []
6467
+ include Aws::Structure
6468
+ end
6469
+
6470
+ # The message data.
6471
+ #
6472
+ # @note MessageData is a union - when making an API calls you must set exactly one of the members.
6473
+ #
6474
+ # @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.
6475
+ #
6476
+ # @!attribute [rw] text
6477
+ # The message data in text type.
6478
+ # @return [Types::TextMessage]
6479
+ #
6480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageData AWS API Documentation
6481
+ #
6482
+ class MessageData < Struct.new(
6483
+ :text,
6484
+ :unknown)
6485
+ SENSITIVE = []
6486
+ include Aws::Structure
6487
+ include Aws::Structure::Union
6488
+
6489
+ class Text < MessageData; end
6490
+ class Unknown < MessageData; end
6491
+ end
6492
+
6493
+ # The message input.
6494
+ #
6495
+ # @!attribute [rw] value
6496
+ # The message input value.
6497
+ # @return [Types::MessageData]
6498
+ #
6499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageInput AWS API Documentation
6500
+ #
6501
+ class MessageInput < Struct.new(
6502
+ :value)
6503
+ SENSITIVE = []
6504
+ include Aws::Structure
6505
+ end
6506
+
6507
+ # The message output.
6508
+ #
6509
+ # @!attribute [rw] message_id
6510
+ # The identifier of a message.
6511
+ # @return [String]
6512
+ #
6513
+ # @!attribute [rw] participant
6514
+ # The participant of a message.
6515
+ # @return [String]
6516
+ #
6517
+ # @!attribute [rw] timestamp
6518
+ # The timestamp of a message.
6519
+ # @return [Time]
6520
+ #
6521
+ # @!attribute [rw] value
6522
+ # The value of a message data.
6523
+ # @return [Types::MessageData]
6524
+ #
6525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageOutput AWS API Documentation
6526
+ #
6527
+ class MessageOutput < Struct.new(
6528
+ :message_id,
6529
+ :participant,
6530
+ :timestamp,
6531
+ :value)
5269
6532
  SENSITIVE = []
5270
6533
  include Aws::Structure
5271
6534
  end
@@ -7432,6 +8695,63 @@ module Aws::QConnect
7432
8695
  include Aws::Structure
7433
8696
  end
7434
8697
 
8698
+ # The configuration for AI Agents of type SELF\_SERVICE.
8699
+ #
8700
+ # @!attribute [rw] association_configurations
8701
+ # The association configurations for overriding behavior on this AI
8702
+ # Agent.
8703
+ # @return [Array<Types::AssociationConfiguration>]
8704
+ #
8705
+ # @!attribute [rw] self_service_ai_guardrail_id
8706
+ # The AI Guardrail identifier used by the SELF\_SERVICE AI Agent.
8707
+ # @return [String]
8708
+ #
8709
+ # @!attribute [rw] self_service_answer_generation_ai_prompt_id
8710
+ # The AI Prompt identifier for the Self Service Answer Generation
8711
+ # prompt used by the SELF\_SERVICE AI Agent
8712
+ # @return [String]
8713
+ #
8714
+ # @!attribute [rw] self_service_pre_processing_ai_prompt_id
8715
+ # The AI Prompt identifier for the Self Service Pre-Processing prompt
8716
+ # used by the SELF\_SERVICE AI Agent
8717
+ # @return [String]
8718
+ #
8719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceAIAgentConfiguration AWS API Documentation
8720
+ #
8721
+ class SelfServiceAIAgentConfiguration < Struct.new(
8722
+ :association_configurations,
8723
+ :self_service_ai_guardrail_id,
8724
+ :self_service_answer_generation_ai_prompt_id,
8725
+ :self_service_pre_processing_ai_prompt_id)
8726
+ SENSITIVE = []
8727
+ include Aws::Structure
8728
+ end
8729
+
8730
+ # The conversation history data to included in conversation context data
8731
+ # before the the Amazon Q in Connect session..
8732
+ #
8733
+ # @!attribute [rw] bot_response
8734
+ # The bot response of the conversation history data.
8735
+ # @return [String]
8736
+ #
8737
+ # @!attribute [rw] input_transcript
8738
+ # The input transcript of the conversation history data.
8739
+ # @return [String]
8740
+ #
8741
+ # @!attribute [rw] turn_number
8742
+ # The number of turn of the conversation history data.
8743
+ # @return [Integer]
8744
+ #
8745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceConversationHistory AWS API Documentation
8746
+ #
8747
+ class SelfServiceConversationHistory < Struct.new(
8748
+ :bot_response,
8749
+ :input_transcript,
8750
+ :turn_number)
8751
+ SENSITIVE = [:bot_response, :input_transcript]
8752
+ include Aws::Structure
8753
+ end
8754
+
7435
8755
  # Settings for semantic document chunking for a data source. Semantic
7436
8756
  # chunking splits a document into smaller documents based on groups of
7437
8757
  # similar content derived from the text with natural language
@@ -7459,6 +8779,66 @@ module Aws::QConnect
7459
8779
  include Aws::Structure
7460
8780
  end
7461
8781
 
8782
+ # @!attribute [rw] assistant_id
8783
+ # The identifier of the Amazon Q in Connect assistant.
8784
+ # @return [String]
8785
+ #
8786
+ # @!attribute [rw] client_token
8787
+ # A unique, case-sensitive identifier that you provide to ensure the
8788
+ # idempotency of the request. If not provided, the AWS SDK populates
8789
+ # this field.For more information about idempotency, see Making
8790
+ # retries safe with idempotent APIs.
8791
+ #
8792
+ # **A suitable default value is auto-generated.** You should normally
8793
+ # not need to pass this option.
8794
+ # @return [String]
8795
+ #
8796
+ # @!attribute [rw] conversation_context
8797
+ # The conversation context before the Amazon Q in Connect session.
8798
+ # @return [Types::ConversationContext]
8799
+ #
8800
+ # @!attribute [rw] message
8801
+ # The message data to submit to the Amazon Q in Connect session.
8802
+ # @return [Types::MessageInput]
8803
+ #
8804
+ # @!attribute [rw] session_id
8805
+ # The identifier of the Amazon Q in Connect session.
8806
+ # @return [String]
8807
+ #
8808
+ # @!attribute [rw] type
8809
+ # The message type.
8810
+ # @return [String]
8811
+ #
8812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageRequest AWS API Documentation
8813
+ #
8814
+ class SendMessageRequest < Struct.new(
8815
+ :assistant_id,
8816
+ :client_token,
8817
+ :conversation_context,
8818
+ :message,
8819
+ :session_id,
8820
+ :type)
8821
+ SENSITIVE = []
8822
+ include Aws::Structure
8823
+ end
8824
+
8825
+ # @!attribute [rw] next_message_token
8826
+ # The token for the next message, used by GetNextMessage.
8827
+ # @return [String]
8828
+ #
8829
+ # @!attribute [rw] request_message_id
8830
+ # The identifier of the submitted message.
8831
+ # @return [String]
8832
+ #
8833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageResponse AWS API Documentation
8834
+ #
8835
+ class SendMessageResponse < Struct.new(
8836
+ :next_message_token,
8837
+ :request_message_id)
8838
+ SENSITIVE = []
8839
+ include Aws::Structure
8840
+ end
8841
+
7462
8842
  # The configuration information for the customer managed key used for
7463
8843
  # encryption.
7464
8844
  #
@@ -7932,6 +9312,20 @@ module Aws::QConnect
7932
9312
  include Aws::Structure
7933
9313
  end
7934
9314
 
9315
+ # The message data in text type.
9316
+ #
9317
+ # @!attribute [rw] value
9318
+ # The value of the message data in text type.
9319
+ # @return [String]
9320
+ #
9321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextMessage AWS API Documentation
9322
+ #
9323
+ class TextMessage < Struct.new(
9324
+ :value)
9325
+ SENSITIVE = [:value]
9326
+ include Aws::Structure
9327
+ end
9328
+
7935
9329
  # The throttling limit has been exceeded.
7936
9330
  #
7937
9331
  # @!attribute [rw] message
@@ -8045,6 +9439,97 @@ module Aws::QConnect
8045
9439
  include Aws::Structure
8046
9440
  end
8047
9441
 
9442
+ # @!attribute [rw] ai_guardrail_id
9443
+ # The identifier of the Amazon Q in Connect AI Guardrail.
9444
+ # @return [String]
9445
+ #
9446
+ # @!attribute [rw] assistant_id
9447
+ # The identifier of the Amazon Q in Connect assistant. Can be either
9448
+ # the ID or the ARN. URLs cannot contain the ARN.
9449
+ # @return [String]
9450
+ #
9451
+ # @!attribute [rw] blocked_input_messaging
9452
+ # The message to return when the AI Guardrail blocks a prompt.
9453
+ # @return [String]
9454
+ #
9455
+ # @!attribute [rw] blocked_outputs_messaging
9456
+ # The message to return when the AI Guardrail blocks a model response.
9457
+ # @return [String]
9458
+ #
9459
+ # @!attribute [rw] client_token
9460
+ # A unique, case-sensitive identifier that you provide to ensure the
9461
+ # idempotency of the request. If not provided, the Amazon Web Services
9462
+ # SDK populates this field. For more information about idempotency,
9463
+ # see [Making retries safe with idempotent APIs][1]..
9464
+ #
9465
+ # **A suitable default value is auto-generated.** You should normally
9466
+ # not need to pass this option.
9467
+ #
9468
+ #
9469
+ #
9470
+ # [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
9471
+ # @return [String]
9472
+ #
9473
+ # @!attribute [rw] content_policy_config
9474
+ # The content filter policies to configure for the AI Guardrail.
9475
+ # @return [Types::AIGuardrailContentPolicyConfig]
9476
+ #
9477
+ # @!attribute [rw] contextual_grounding_policy_config
9478
+ # The contextual grounding policy configuration used to create an AI
9479
+ # Guardrail.
9480
+ # @return [Types::AIGuardrailContextualGroundingPolicyConfig]
9481
+ #
9482
+ # @!attribute [rw] description
9483
+ # A description of the AI Guardrail.
9484
+ # @return [String]
9485
+ #
9486
+ # @!attribute [rw] sensitive_information_policy_config
9487
+ # The sensitive information policy to configure for the AI Guardrail.
9488
+ # @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
9489
+ #
9490
+ # @!attribute [rw] topic_policy_config
9491
+ # The topic policies to configure for the AI Guardrail.
9492
+ # @return [Types::AIGuardrailTopicPolicyConfig]
9493
+ #
9494
+ # @!attribute [rw] visibility_status
9495
+ # The visibility status of the Amazon Q in Connect AI Guardrail.
9496
+ # @return [String]
9497
+ #
9498
+ # @!attribute [rw] word_policy_config
9499
+ # The word policy you configure for the AI Guardrail.
9500
+ # @return [Types::AIGuardrailWordPolicyConfig]
9501
+ #
9502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIGuardrailRequest AWS API Documentation
9503
+ #
9504
+ class UpdateAIGuardrailRequest < Struct.new(
9505
+ :ai_guardrail_id,
9506
+ :assistant_id,
9507
+ :blocked_input_messaging,
9508
+ :blocked_outputs_messaging,
9509
+ :client_token,
9510
+ :content_policy_config,
9511
+ :contextual_grounding_policy_config,
9512
+ :description,
9513
+ :sensitive_information_policy_config,
9514
+ :topic_policy_config,
9515
+ :visibility_status,
9516
+ :word_policy_config)
9517
+ SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
9518
+ include Aws::Structure
9519
+ end
9520
+
9521
+ # @!attribute [rw] ai_guardrail
9522
+ # The data of the updated Amazon Q in Connect AI Guardrail.
9523
+ # @return [Types::AIGuardrailData]
9524
+ #
9525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIGuardrailResponse AWS API Documentation
9526
+ #
9527
+ class UpdateAIGuardrailResponse < Struct.new(
9528
+ :ai_guardrail)
9529
+ SENSITIVE = []
9530
+ include Aws::Structure
9531
+ end
9532
+
8048
9533
  # @!attribute [rw] ai_prompt_id
8049
9534
  # The identifier of the Amazon Q in Connect AI Prompt.
8050
9535
  # @return [String]