aws-sdk-qconnect 1.24.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +1091 -17
- data/lib/aws-sdk-qconnect/client_api.rb +504 -0
- data/lib/aws-sdk-qconnect/types.rb +1555 -96
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +374 -6
- data/sig/types.rbs +348 -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
|
@@ -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.
|
@@ -583,6 +861,7 @@ module Aws::QConnect
|
|
583
861
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration AWS API Documentation
|
584
862
|
#
|
585
863
|
class AnswerRecommendationAIAgentConfiguration < Struct.new(
|
864
|
+
:answer_generation_ai_guardrail_id,
|
586
865
|
:answer_generation_ai_prompt_id,
|
587
866
|
:association_configurations,
|
588
867
|
:intent_labeling_generation_ai_prompt_id,
|
@@ -1563,6 +1842,40 @@ module Aws::QConnect
|
|
1563
1842
|
include Aws::Structure
|
1564
1843
|
end
|
1565
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
|
+
|
1566
1879
|
# @!attribute [rw] assistant_id
|
1567
1880
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1568
1881
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -1695,15 +2008,19 @@ module Aws::QConnect
|
|
1695
2008
|
include Aws::Structure
|
1696
2009
|
end
|
1697
2010
|
|
1698
|
-
# @!attribute [rw] api_format
|
1699
|
-
# The API Format of the AI Prompt.
|
1700
|
-
# @return [String]
|
1701
|
-
#
|
1702
2011
|
# @!attribute [rw] assistant_id
|
1703
2012
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1704
2013
|
# the ID or the ARN. URLs cannot contain the ARN.
|
1705
2014
|
# @return [String]
|
1706
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
|
+
#
|
1707
2024
|
# @!attribute [rw] client_token
|
1708
2025
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1709
2026
|
# idempotency of the request. If not provided, the Amazon Web Services
|
@@ -1718,72 +2035,78 @@ module Aws::QConnect
|
|
1718
2035
|
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1719
2036
|
# @return [String]
|
1720
2037
|
#
|
1721
|
-
# @!attribute [rw]
|
1722
|
-
# The
|
1723
|
-
# @return [
|
2038
|
+
# @!attribute [rw] content_policy_config
|
2039
|
+
# The content filter policies to configure for the AI Guardrail.
|
2040
|
+
# @return [Types::AIGuardrailContentPolicyConfig]
|
1724
2041
|
#
|
1725
|
-
# @!attribute [rw]
|
1726
|
-
# The
|
1727
|
-
#
|
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.
|
1728
2049
|
# @return [String]
|
1729
2050
|
#
|
1730
2051
|
# @!attribute [rw] name
|
1731
|
-
# The name of the AI
|
2052
|
+
# The name of the AI Guardrail.
|
1732
2053
|
# @return [String]
|
1733
2054
|
#
|
2055
|
+
# @!attribute [rw] sensitive_information_policy_config
|
2056
|
+
# The sensitive information policy to configure for the AI Guardrail.
|
2057
|
+
# @return [Types::AIGuardrailSensitiveInformationPolicyConfig]
|
2058
|
+
#
|
1734
2059
|
# @!attribute [rw] tags
|
1735
2060
|
# The tags used to organize, track, or control access for this
|
1736
2061
|
# resource.
|
1737
2062
|
# @return [Hash<String,String>]
|
1738
2063
|
#
|
1739
|
-
# @!attribute [rw]
|
1740
|
-
# The
|
1741
|
-
# @return [Types::
|
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]
|
2064
|
+
# @!attribute [rw] topic_policy_config
|
2065
|
+
# The topic policies to configure for the AI Guardrail.
|
2066
|
+
# @return [Types::AIGuardrailTopicPolicyConfig]
|
1750
2067
|
#
|
1751
2068
|
# @!attribute [rw] visibility_status
|
1752
|
-
# The visibility status of the AI
|
2069
|
+
# The visibility status of the AI Guardrail.
|
1753
2070
|
# @return [String]
|
1754
2071
|
#
|
1755
|
-
#
|
2072
|
+
# @!attribute [rw] word_policy_config
|
2073
|
+
# The word policy you configure for the AI Guardrail.
|
2074
|
+
# @return [Types::AIGuardrailWordPolicyConfig]
|
1756
2075
|
#
|
1757
|
-
|
1758
|
-
|
2076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailRequest AWS API Documentation
|
2077
|
+
#
|
2078
|
+
class CreateAIGuardrailRequest < Struct.new(
|
1759
2079
|
:assistant_id,
|
2080
|
+
:blocked_input_messaging,
|
2081
|
+
:blocked_outputs_messaging,
|
1760
2082
|
:client_token,
|
2083
|
+
:content_policy_config,
|
2084
|
+
:contextual_grounding_policy_config,
|
1761
2085
|
:description,
|
1762
|
-
:model_id,
|
1763
2086
|
:name,
|
2087
|
+
:sensitive_information_policy_config,
|
1764
2088
|
:tags,
|
1765
|
-
:
|
1766
|
-
:
|
1767
|
-
:
|
1768
|
-
:
|
1769
|
-
SENSITIVE = []
|
2089
|
+
:topic_policy_config,
|
2090
|
+
:visibility_status,
|
2091
|
+
:word_policy_config)
|
2092
|
+
SENSITIVE = [:blocked_input_messaging, :blocked_outputs_messaging, :description]
|
1770
2093
|
include Aws::Structure
|
1771
2094
|
end
|
1772
2095
|
|
1773
|
-
# @!attribute [rw]
|
1774
|
-
# The data of the AI
|
1775
|
-
# @return [Types::
|
2096
|
+
# @!attribute [rw] ai_guardrail
|
2097
|
+
# The data of the AI Guardrail.
|
2098
|
+
# @return [Types::AIGuardrailData]
|
1776
2099
|
#
|
1777
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailResponse AWS API Documentation
|
1778
2101
|
#
|
1779
|
-
class
|
1780
|
-
:
|
2102
|
+
class CreateAIGuardrailResponse < Struct.new(
|
2103
|
+
:ai_guardrail)
|
1781
2104
|
SENSITIVE = []
|
1782
2105
|
include Aws::Structure
|
1783
2106
|
end
|
1784
2107
|
|
1785
|
-
# @!attribute [rw]
|
1786
|
-
# The identifier of the Amazon Q in Connect AI
|
2108
|
+
# @!attribute [rw] ai_guardrail_id
|
2109
|
+
# The identifier of the Amazon Q in Connect AI Guardrail.
|
1787
2110
|
# @return [String]
|
1788
2111
|
#
|
1789
2112
|
# @!attribute [rw] assistant_id
|
@@ -1806,13 +2129,13 @@ module Aws::QConnect
|
|
1806
2129
|
# @return [String]
|
1807
2130
|
#
|
1808
2131
|
# @!attribute [rw] modified_time
|
1809
|
-
# The time the AI
|
2132
|
+
# The time the AI Guardrail was last modified.
|
1810
2133
|
# @return [Time]
|
1811
2134
|
#
|
1812
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
2135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionRequest AWS API Documentation
|
1813
2136
|
#
|
1814
|
-
class
|
1815
|
-
:
|
2137
|
+
class CreateAIGuardrailVersionRequest < Struct.new(
|
2138
|
+
:ai_guardrail_id,
|
1816
2139
|
:assistant_id,
|
1817
2140
|
:client_token,
|
1818
2141
|
:modified_time)
|
@@ -1820,41 +2143,37 @@ module Aws::QConnect
|
|
1820
2143
|
include Aws::Structure
|
1821
2144
|
end
|
1822
2145
|
|
1823
|
-
# @!attribute [rw]
|
1824
|
-
# The data of the AI
|
1825
|
-
# @return [Types::
|
2146
|
+
# @!attribute [rw] ai_guardrail
|
2147
|
+
# The data of the AI Guardrail version.
|
2148
|
+
# @return [Types::AIGuardrailData]
|
1826
2149
|
#
|
1827
2150
|
# @!attribute [rw] version_number
|
1828
|
-
# The version number of the AI
|
2151
|
+
# The version number of the AI Guardrail version.
|
1829
2152
|
# @return [Integer]
|
1830
2153
|
#
|
1831
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
2154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIGuardrailVersionResponse AWS API Documentation
|
1832
2155
|
#
|
1833
|
-
class
|
1834
|
-
:
|
2156
|
+
class CreateAIGuardrailVersionResponse < Struct.new(
|
2157
|
+
:ai_guardrail,
|
1835
2158
|
:version_number)
|
1836
2159
|
SENSITIVE = []
|
1837
2160
|
include Aws::Structure
|
1838
2161
|
end
|
1839
2162
|
|
2163
|
+
# @!attribute [rw] api_format
|
2164
|
+
# The API Format of the AI Prompt.
|
2165
|
+
# @return [String]
|
2166
|
+
#
|
1840
2167
|
# @!attribute [rw] assistant_id
|
1841
2168
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
1842
2169
|
# the ID or the ARN. URLs cannot contain the ARN.
|
1843
2170
|
# @return [String]
|
1844
2171
|
#
|
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
2172
|
# @!attribute [rw] client_token
|
1854
2173
|
# A unique, case-sensitive identifier that you provide to ensure the
|
1855
2174
|
# idempotency of the request. If not provided, the Amazon Web Services
|
1856
2175
|
# SDK populates this field. For more information about idempotency,
|
1857
|
-
# see [Making retries safe with idempotent APIs][1]
|
2176
|
+
# see [Making retries safe with idempotent APIs][1]..
|
1858
2177
|
#
|
1859
2178
|
# **A suitable default value is auto-generated.** You should normally
|
1860
2179
|
# not need to pass this option.
|
@@ -1864,12 +2183,158 @@ module Aws::QConnect
|
|
1864
2183
|
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1865
2184
|
# @return [String]
|
1866
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
|
+
#
|
1867
2199
|
# @!attribute [rw] tags
|
1868
2200
|
# The tags used to organize, track, or control access for this
|
1869
2201
|
# resource.
|
1870
2202
|
# @return [Hash<String,String>]
|
1871
2203
|
#
|
1872
|
-
#
|
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)
|
2234
|
+
SENSITIVE = []
|
2235
|
+
include Aws::Structure
|
2236
|
+
end
|
2237
|
+
|
2238
|
+
# @!attribute [rw] ai_prompt
|
2239
|
+
# The data of the AI Prompt.
|
2240
|
+
# @return [Types::AIPromptData]
|
2241
|
+
#
|
2242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptResponse AWS API Documentation
|
2243
|
+
#
|
2244
|
+
class CreateAIPromptResponse < Struct.new(
|
2245
|
+
:ai_prompt)
|
2246
|
+
SENSITIVE = []
|
2247
|
+
include Aws::Structure
|
2248
|
+
end
|
2249
|
+
|
2250
|
+
# @!attribute [rw] ai_prompt_id
|
2251
|
+
# The identifier of the Amazon Q in Connect AI prompt.
|
2252
|
+
# @return [String]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] assistant_id
|
2255
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2256
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2257
|
+
# @return [String]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] client_token
|
2260
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
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]..
|
2264
|
+
#
|
2265
|
+
# **A suitable default value is auto-generated.** You should normally
|
2266
|
+
# not need to pass this option.
|
2267
|
+
#
|
2268
|
+
#
|
2269
|
+
#
|
2270
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2271
|
+
# @return [String]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] modified_time
|
2274
|
+
# The time the AI Prompt was last modified.
|
2275
|
+
# @return [Time]
|
2276
|
+
#
|
2277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionRequest AWS API Documentation
|
2278
|
+
#
|
2279
|
+
class CreateAIPromptVersionRequest < Struct.new(
|
2280
|
+
:ai_prompt_id,
|
2281
|
+
:assistant_id,
|
2282
|
+
:client_token,
|
2283
|
+
:modified_time)
|
2284
|
+
SENSITIVE = []
|
2285
|
+
include Aws::Structure
|
2286
|
+
end
|
2287
|
+
|
2288
|
+
# @!attribute [rw] ai_prompt
|
2289
|
+
# The data of the AI Prompt version.
|
2290
|
+
# @return [Types::AIPromptData]
|
2291
|
+
#
|
2292
|
+
# @!attribute [rw] version_number
|
2293
|
+
# The version number of the AI Prompt version.
|
2294
|
+
# @return [Integer]
|
2295
|
+
#
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptVersionResponse AWS API Documentation
|
2297
|
+
#
|
2298
|
+
class CreateAIPromptVersionResponse < Struct.new(
|
2299
|
+
:ai_prompt,
|
2300
|
+
:version_number)
|
2301
|
+
SENSITIVE = []
|
2302
|
+
include Aws::Structure
|
2303
|
+
end
|
2304
|
+
|
2305
|
+
# @!attribute [rw] assistant_id
|
2306
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
2307
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
2308
|
+
# @return [String]
|
2309
|
+
#
|
2310
|
+
# @!attribute [rw] association
|
2311
|
+
# The identifier of the associated resource.
|
2312
|
+
# @return [Types::AssistantAssociationInputData]
|
2313
|
+
#
|
2314
|
+
# @!attribute [rw] association_type
|
2315
|
+
# The type of association.
|
2316
|
+
# @return [String]
|
2317
|
+
#
|
2318
|
+
# @!attribute [rw] client_token
|
2319
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2320
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
2321
|
+
# SDK populates this field. For more information about idempotency,
|
2322
|
+
# see [Making retries safe with idempotent APIs][1].
|
2323
|
+
#
|
2324
|
+
# **A suitable default value is auto-generated.** You should normally
|
2325
|
+
# not need to pass this option.
|
2326
|
+
#
|
2327
|
+
#
|
2328
|
+
#
|
2329
|
+
# [1]: http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
2330
|
+
# @return [String]
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] tags
|
2333
|
+
# The tags used to organize, track, or control access for this
|
2334
|
+
# resource.
|
2335
|
+
# @return [Hash<String,String>]
|
2336
|
+
#
|
2337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAssistantAssociationRequest AWS API Documentation
|
1873
2338
|
#
|
1874
2339
|
class CreateAssistantAssociationRequest < Struct.new(
|
1875
2340
|
:assistant_id,
|
@@ -3060,6 +3525,56 @@ module Aws::QConnect
|
|
3060
3525
|
#
|
3061
3526
|
class DeleteAIAgentVersionResponse < Aws::EmptyStructure; end
|
3062
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
|
+
|
3063
3578
|
# @!attribute [rw] ai_prompt_id
|
3064
3579
|
# The identifier of the Amazon Q in Connect AI prompt. Can be either
|
3065
3580
|
# the ID or the ARN. URLs cannot contain the ARN.
|
@@ -3707,6 +4222,43 @@ module Aws::QConnect
|
|
3707
4222
|
include Aws::Structure
|
3708
4223
|
end
|
3709
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
|
+
|
3710
4262
|
# @!attribute [rw] ai_prompt_id
|
3711
4263
|
# The identifier of the Amazon Q in Connect AI prompt.
|
3712
4264
|
# @return [String]
|
@@ -3984,6 +4536,67 @@ module Aws::QConnect
|
|
3984
4536
|
include Aws::Structure
|
3985
4537
|
end
|
3986
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
|
+
|
3987
4600
|
# @!attribute [rw] knowledge_base_id
|
3988
4601
|
# The identifier of the knowledge base. This should be a
|
3989
4602
|
# QUICK\_RESPONSES type knowledge base.
|
@@ -4141,6 +4754,416 @@ module Aws::QConnect
|
|
4141
4754
|
include Aws::Structure
|
4142
4755
|
end
|
4143
4756
|
|
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.
|
4760
|
+
#
|
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).
|
4765
|
+
#
|
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.
|
4769
|
+
#
|
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.
|
4773
|
+
#
|
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]
|
4815
|
+
include Aws::Structure
|
4816
|
+
end
|
4817
|
+
|
4818
|
+
# The filter configuration details for the AI Guardrail's contextual
|
4819
|
+
# grounding filter.
|
4820
|
+
#
|
4821
|
+
# @!attribute [rw] threshold
|
4822
|
+
# The threshold details for the AI Guardrail's contextual grounding
|
4823
|
+
# filter.
|
4824
|
+
# @return [Float]
|
4825
|
+
#
|
4826
|
+
# @!attribute [rw] type
|
4827
|
+
# The filter type for the AI Guardrail's contextual grounding filter.
|
4828
|
+
# @return [String]
|
4829
|
+
#
|
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]
|
4836
|
+
include Aws::Structure
|
4837
|
+
end
|
4838
|
+
|
4839
|
+
# The managed word list to configure for the AI Guardrail.
|
4840
|
+
#
|
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
|
+
|
4144
5167
|
# Settings for hierarchical document chunking for a data source.
|
4145
5168
|
# Hierarchical chunking splits documents into layers of chunks where the
|
4146
5169
|
# first layer contains large chunks, and the second layer contains
|
@@ -4597,8 +5620,116 @@ module Aws::QConnect
|
|
4597
5620
|
include Aws::Structure
|
4598
5621
|
end
|
4599
5622
|
|
4600
|
-
# @!attribute [rw] ai_agent_id
|
4601
|
-
# The identifier of the Amazon Q in Connect AI Agent for which
|
5623
|
+
# @!attribute [rw] ai_agent_id
|
5624
|
+
# The identifier of the Amazon Q in Connect AI Agent for which
|
5625
|
+
# versions are to be listed.
|
5626
|
+
# @return [String]
|
5627
|
+
#
|
5628
|
+
# @!attribute [rw] assistant_id
|
5629
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
5630
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
5631
|
+
# @return [String]
|
5632
|
+
#
|
5633
|
+
# @!attribute [rw] max_results
|
5634
|
+
# The maximum number of results to return per page.
|
5635
|
+
# @return [Integer]
|
5636
|
+
#
|
5637
|
+
# @!attribute [rw] next_token
|
5638
|
+
# The token for the next set of results. Use the value returned in the
|
5639
|
+
# previous response in the next request to retrieve the next set of
|
5640
|
+
# results.
|
5641
|
+
# @return [String]
|
5642
|
+
#
|
5643
|
+
# @!attribute [rw] origin
|
5644
|
+
# The origin of the AI Agent versions to be listed. `SYSTEM` for a
|
5645
|
+
# default AI Agent created by Q in Connect or `CUSTOMER` for an AI
|
5646
|
+
# Agent created by calling AI Agent creation APIs.
|
5647
|
+
# @return [String]
|
5648
|
+
#
|
5649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsRequest AWS API Documentation
|
5650
|
+
#
|
5651
|
+
class ListAIAgentVersionsRequest < Struct.new(
|
5652
|
+
:ai_agent_id,
|
5653
|
+
:assistant_id,
|
5654
|
+
:max_results,
|
5655
|
+
:next_token,
|
5656
|
+
:origin)
|
5657
|
+
SENSITIVE = []
|
5658
|
+
include Aws::Structure
|
5659
|
+
end
|
5660
|
+
|
5661
|
+
# @!attribute [rw] ai_agent_version_summaries
|
5662
|
+
# The summaries of AI Agent versions.
|
5663
|
+
# @return [Array<Types::AIAgentVersionSummary>]
|
5664
|
+
#
|
5665
|
+
# @!attribute [rw] next_token
|
5666
|
+
# The token for the next set of results. Use the value returned in the
|
5667
|
+
# previous response in the next request to retrieve the next set of
|
5668
|
+
# results.
|
5669
|
+
# @return [String]
|
5670
|
+
#
|
5671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentVersionsResponse AWS API Documentation
|
5672
|
+
#
|
5673
|
+
class ListAIAgentVersionsResponse < Struct.new(
|
5674
|
+
:ai_agent_version_summaries,
|
5675
|
+
:next_token)
|
5676
|
+
SENSITIVE = []
|
5677
|
+
include Aws::Structure
|
5678
|
+
end
|
5679
|
+
|
5680
|
+
# @!attribute [rw] assistant_id
|
5681
|
+
# The identifier of the Amazon Q in Connect assistant. Can be either
|
5682
|
+
# the ID or the ARN. URLs cannot contain the ARN.
|
5683
|
+
# @return [String]
|
5684
|
+
#
|
5685
|
+
# @!attribute [rw] max_results
|
5686
|
+
# The maximum number of results to return per page.
|
5687
|
+
# @return [Integer]
|
5688
|
+
#
|
5689
|
+
# @!attribute [rw] next_token
|
5690
|
+
# The token for the next set of results. Use the value returned in the
|
5691
|
+
# previous response in the next request to retrieve the next set of
|
5692
|
+
# results.
|
5693
|
+
# @return [String]
|
5694
|
+
#
|
5695
|
+
# @!attribute [rw] origin
|
5696
|
+
# The origin of the AI Agents to be listed. `SYSTEM` for a default AI
|
5697
|
+
# Agent created by Q in Connect or `CUSTOMER` for an AI Agent created
|
5698
|
+
# by calling AI Agent creation APIs.
|
5699
|
+
# @return [String]
|
5700
|
+
#
|
5701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsRequest AWS API Documentation
|
5702
|
+
#
|
5703
|
+
class ListAIAgentsRequest < Struct.new(
|
5704
|
+
:assistant_id,
|
5705
|
+
:max_results,
|
5706
|
+
:next_token,
|
5707
|
+
:origin)
|
5708
|
+
SENSITIVE = []
|
5709
|
+
include Aws::Structure
|
5710
|
+
end
|
5711
|
+
|
5712
|
+
# @!attribute [rw] ai_agent_summaries
|
5713
|
+
# The summaries of AI Agents.
|
5714
|
+
# @return [Array<Types::AIAgentSummary>]
|
5715
|
+
#
|
5716
|
+
# @!attribute [rw] next_token
|
5717
|
+
# The token for the next set of results. Use the value returned in the
|
5718
|
+
# previous response in the next request to retrieve the next set of
|
5719
|
+
# results.
|
5720
|
+
# @return [String]
|
5721
|
+
#
|
5722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIAgentsResponse AWS API Documentation
|
5723
|
+
#
|
5724
|
+
class ListAIAgentsResponse < Struct.new(
|
5725
|
+
:ai_agent_summaries,
|
5726
|
+
:next_token)
|
5727
|
+
SENSITIVE = []
|
5728
|
+
include Aws::Structure
|
5729
|
+
end
|
5730
|
+
|
5731
|
+
# @!attribute [rw] ai_guardrail_id
|
5732
|
+
# The identifier of the Amazon Q in Connect AI Guardrail for which
|
4602
5733
|
# versions are to be listed.
|
4603
5734
|
# @return [String]
|
4604
5735
|
#
|
@@ -4617,27 +5748,20 @@ module Aws::QConnect
|
|
4617
5748
|
# results.
|
4618
5749
|
# @return [String]
|
4619
5750
|
#
|
4620
|
-
#
|
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
|
5751
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsRequest AWS API Documentation
|
4627
5752
|
#
|
4628
|
-
class
|
4629
|
-
:
|
5753
|
+
class ListAIGuardrailVersionsRequest < Struct.new(
|
5754
|
+
:ai_guardrail_id,
|
4630
5755
|
:assistant_id,
|
4631
5756
|
:max_results,
|
4632
|
-
:next_token
|
4633
|
-
:origin)
|
5757
|
+
:next_token)
|
4634
5758
|
SENSITIVE = []
|
4635
5759
|
include Aws::Structure
|
4636
5760
|
end
|
4637
5761
|
|
4638
|
-
# @!attribute [rw]
|
4639
|
-
# The summaries of AI
|
4640
|
-
# @return [Array<Types::
|
5762
|
+
# @!attribute [rw] ai_guardrail_version_summaries
|
5763
|
+
# The summaries of the AI Guardrail versions.
|
5764
|
+
# @return [Array<Types::AIGuardrailVersionSummary>]
|
4641
5765
|
#
|
4642
5766
|
# @!attribute [rw] next_token
|
4643
5767
|
# The token for the next set of results. Use the value returned in the
|
@@ -4645,10 +5769,10 @@ module Aws::QConnect
|
|
4645
5769
|
# results.
|
4646
5770
|
# @return [String]
|
4647
5771
|
#
|
4648
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
5772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailVersionsResponse AWS API Documentation
|
4649
5773
|
#
|
4650
|
-
class
|
4651
|
-
:
|
5774
|
+
class ListAIGuardrailVersionsResponse < Struct.new(
|
5775
|
+
:ai_guardrail_version_summaries,
|
4652
5776
|
:next_token)
|
4653
5777
|
SENSITIVE = []
|
4654
5778
|
include Aws::Structure
|
@@ -4669,26 +5793,19 @@ module Aws::QConnect
|
|
4669
5793
|
# results.
|
4670
5794
|
# @return [String]
|
4671
5795
|
#
|
4672
|
-
#
|
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
|
5796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsRequest AWS API Documentation
|
4679
5797
|
#
|
4680
|
-
class
|
5798
|
+
class ListAIGuardrailsRequest < Struct.new(
|
4681
5799
|
:assistant_id,
|
4682
5800
|
:max_results,
|
4683
|
-
:next_token
|
4684
|
-
:origin)
|
5801
|
+
:next_token)
|
4685
5802
|
SENSITIVE = []
|
4686
5803
|
include Aws::Structure
|
4687
5804
|
end
|
4688
5805
|
|
4689
|
-
# @!attribute [rw]
|
4690
|
-
# The summaries of AI
|
4691
|
-
# @return [Array<Types::
|
5806
|
+
# @!attribute [rw] ai_guardrail_summaries
|
5807
|
+
# The summaries of the AI Guardrails.
|
5808
|
+
# @return [Array<Types::AIGuardrailSummary>]
|
4692
5809
|
#
|
4693
5810
|
# @!attribute [rw] next_token
|
4694
5811
|
# The token for the next set of results. Use the value returned in the
|
@@ -4696,10 +5813,10 @@ module Aws::QConnect
|
|
4696
5813
|
# results.
|
4697
5814
|
# @return [String]
|
4698
5815
|
#
|
4699
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
5816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListAIGuardrailsResponse AWS API Documentation
|
4700
5817
|
#
|
4701
|
-
class
|
4702
|
-
:
|
5818
|
+
class ListAIGuardrailsResponse < Struct.new(
|
5819
|
+
:ai_guardrail_summaries,
|
4703
5820
|
:next_token)
|
4704
5821
|
SENSITIVE = []
|
4705
5822
|
include Aws::Structure
|
@@ -5157,6 +6274,54 @@ module Aws::QConnect
|
|
5157
6274
|
include Aws::Structure
|
5158
6275
|
end
|
5159
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
|
+
|
5160
6325
|
# @!attribute [rw] knowledge_base_id
|
5161
6326
|
# The identifier of the knowledge base. Can be either the ID or the
|
5162
6327
|
# ARN. URLs cannot contain the ARN.
|
@@ -5251,6 +6416,11 @@ module Aws::QConnect
|
|
5251
6416
|
|
5252
6417
|
# The configuration for the `MANUAL_SEARCH` AI Agent type.
|
5253
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
|
+
#
|
5254
6424
|
# @!attribute [rw] answer_generation_ai_prompt_id
|
5255
6425
|
# The AI Prompt identifier for the Answer Generation prompt used by
|
5256
6426
|
# the MANUAL\_SEARCH AI Agent.
|
@@ -5264,12 +6434,79 @@ module Aws::QConnect
|
|
5264
6434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ManualSearchAIAgentConfiguration AWS API Documentation
|
5265
6435
|
#
|
5266
6436
|
class ManualSearchAIAgentConfiguration < Struct.new(
|
6437
|
+
:answer_generation_ai_guardrail_id,
|
5267
6438
|
:answer_generation_ai_prompt_id,
|
5268
6439
|
:association_configurations)
|
5269
6440
|
SENSITIVE = []
|
5270
6441
|
include Aws::Structure
|
5271
6442
|
end
|
5272
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
|
+
|
5273
6510
|
# Information about the message template attachment.
|
5274
6511
|
#
|
5275
6512
|
# @!attribute [rw] attachment_id
|
@@ -7432,6 +8669,63 @@ module Aws::QConnect
|
|
7432
8669
|
include Aws::Structure
|
7433
8670
|
end
|
7434
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
|
+
|
7435
8729
|
# Settings for semantic document chunking for a data source. Semantic
|
7436
8730
|
# chunking splits a document into smaller documents based on groups of
|
7437
8731
|
# similar content derived from the text with natural language
|
@@ -7459,6 +8753,66 @@ module Aws::QConnect
|
|
7459
8753
|
include Aws::Structure
|
7460
8754
|
end
|
7461
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
|
+
|
7462
8816
|
# The configuration information for the customer managed key used for
|
7463
8817
|
# encryption.
|
7464
8818
|
#
|
@@ -7932,6 +9286,20 @@ module Aws::QConnect
|
|
7932
9286
|
include Aws::Structure
|
7933
9287
|
end
|
7934
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
|
+
|
7935
9303
|
# The throttling limit has been exceeded.
|
7936
9304
|
#
|
7937
9305
|
# @!attribute [rw] message
|
@@ -8045,6 +9413,97 @@ module Aws::QConnect
|
|
8045
9413
|
include Aws::Structure
|
8046
9414
|
end
|
8047
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
|
+
|
8048
9507
|
# @!attribute [rw] ai_prompt_id
|
8049
9508
|
# The identifier of the Amazon Q in Connect AI Prompt.
|
8050
9509
|
# @return [String]
|