aws-sdk-qconnect 1.42.0 → 1.44.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +1234 -41
- data/lib/aws-sdk-qconnect/client_api.rb +592 -6
- data/lib/aws-sdk-qconnect/errors.rb +16 -0
- data/lib/aws-sdk-qconnect/types.rb +2118 -86
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +459 -25
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +604 -27
- metadata +3 -3
|
@@ -44,6 +44,18 @@ module Aws::QConnect
|
|
|
44
44
|
# provides comprehensive knowledge-based answers for customer queries.
|
|
45
45
|
# @return [Types::EmailGenerativeAnswerAIAgentConfiguration]
|
|
46
46
|
#
|
|
47
|
+
# @!attribute [rw] orchestration_ai_agent_configuration
|
|
48
|
+
# The configuration for AI Agents of type `ORCHESTRATION`.
|
|
49
|
+
# @return [Types::OrchestrationAIAgentConfiguration]
|
|
50
|
+
#
|
|
51
|
+
# @!attribute [rw] note_taking_ai_agent_configuration
|
|
52
|
+
# The configuration for AI Agents of type `NOTE_TAKING`.
|
|
53
|
+
# @return [Types::NoteTakingAIAgentConfiguration]
|
|
54
|
+
#
|
|
55
|
+
# @!attribute [rw] case_summarization_ai_agent_configuration
|
|
56
|
+
# The configuration for AI Agents of type `CASE_SUMMARIZATION`.
|
|
57
|
+
# @return [Types::CaseSummarizationAIAgentConfiguration]
|
|
58
|
+
#
|
|
47
59
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentConfiguration AWS API Documentation
|
|
48
60
|
#
|
|
49
61
|
class AIAgentConfiguration < Struct.new(
|
|
@@ -53,6 +65,9 @@ module Aws::QConnect
|
|
|
53
65
|
:email_response_ai_agent_configuration,
|
|
54
66
|
:email_overview_ai_agent_configuration,
|
|
55
67
|
:email_generative_answer_ai_agent_configuration,
|
|
68
|
+
:orchestration_ai_agent_configuration,
|
|
69
|
+
:note_taking_ai_agent_configuration,
|
|
70
|
+
:case_summarization_ai_agent_configuration,
|
|
56
71
|
:unknown)
|
|
57
72
|
SENSITIVE = []
|
|
58
73
|
include Aws::Structure
|
|
@@ -64,6 +79,9 @@ module Aws::QConnect
|
|
|
64
79
|
class EmailResponseAiAgentConfiguration < AIAgentConfiguration; end
|
|
65
80
|
class EmailOverviewAiAgentConfiguration < AIAgentConfiguration; end
|
|
66
81
|
class EmailGenerativeAnswerAiAgentConfiguration < AIAgentConfiguration; end
|
|
82
|
+
class OrchestrationAiAgentConfiguration < AIAgentConfiguration; end
|
|
83
|
+
class NoteTakingAiAgentConfiguration < AIAgentConfiguration; end
|
|
84
|
+
class CaseSummarizationAiAgentConfiguration < AIAgentConfiguration; end
|
|
67
85
|
class Unknown < AIAgentConfiguration; end
|
|
68
86
|
end
|
|
69
87
|
|
|
@@ -258,6 +276,20 @@ module Aws::QConnect
|
|
|
258
276
|
include Aws::Structure
|
|
259
277
|
end
|
|
260
278
|
|
|
279
|
+
# The assessment information from the AI Guardrail.
|
|
280
|
+
#
|
|
281
|
+
# @!attribute [rw] blocked
|
|
282
|
+
# Indicates whether the AI Guardrail blocked the content.
|
|
283
|
+
# @return [Boolean]
|
|
284
|
+
#
|
|
285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIGuardrailAssessment AWS API Documentation
|
|
286
|
+
#
|
|
287
|
+
class AIGuardrailAssessment < Struct.new(
|
|
288
|
+
:blocked)
|
|
289
|
+
SENSITIVE = []
|
|
290
|
+
include Aws::Structure
|
|
291
|
+
end
|
|
292
|
+
|
|
261
293
|
# Contains details about how to handle harmful content.
|
|
262
294
|
#
|
|
263
295
|
# @!attribute [rw] filters_config
|
|
@@ -603,6 +635,10 @@ module Aws::QConnect
|
|
|
603
635
|
# The configuration of the prompt template for this AI Prompt.
|
|
604
636
|
# @return [Types::AIPromptTemplateConfiguration]
|
|
605
637
|
#
|
|
638
|
+
# @!attribute [rw] inference_configuration
|
|
639
|
+
# The configuration for inference parameters when using the AI Prompt.
|
|
640
|
+
# @return [Types::AIPromptInferenceConfiguration]
|
|
641
|
+
#
|
|
606
642
|
# @!attribute [rw] modified_time
|
|
607
643
|
# The time the AI Prompt was last modified.
|
|
608
644
|
# @return [Time]
|
|
@@ -643,6 +679,7 @@ module Aws::QConnect
|
|
|
643
679
|
:model_id,
|
|
644
680
|
:api_format,
|
|
645
681
|
:template_configuration,
|
|
682
|
+
:inference_configuration,
|
|
646
683
|
:modified_time,
|
|
647
684
|
:description,
|
|
648
685
|
:visibility_status,
|
|
@@ -653,6 +690,29 @@ module Aws::QConnect
|
|
|
653
690
|
include Aws::Structure
|
|
654
691
|
end
|
|
655
692
|
|
|
693
|
+
# The configuration for inference parameters when using AI Prompts.
|
|
694
|
+
#
|
|
695
|
+
# @note AIPromptInferenceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
696
|
+
#
|
|
697
|
+
# @note AIPromptInferenceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AIPromptInferenceConfiguration corresponding to the set member.
|
|
698
|
+
#
|
|
699
|
+
# @!attribute [rw] text_ai_prompt_inference_configuration
|
|
700
|
+
# The inference configuration for text-based AI Prompts.
|
|
701
|
+
# @return [Types::TextAIPromptInferenceConfiguration]
|
|
702
|
+
#
|
|
703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIPromptInferenceConfiguration AWS API Documentation
|
|
704
|
+
#
|
|
705
|
+
class AIPromptInferenceConfiguration < Struct.new(
|
|
706
|
+
:text_ai_prompt_inference_configuration,
|
|
707
|
+
:unknown)
|
|
708
|
+
SENSITIVE = []
|
|
709
|
+
include Aws::Structure
|
|
710
|
+
include Aws::Structure::Union
|
|
711
|
+
|
|
712
|
+
class TextAiPromptInferenceConfiguration < AIPromptInferenceConfiguration; end
|
|
713
|
+
class Unknown < AIPromptInferenceConfiguration; end
|
|
714
|
+
end
|
|
715
|
+
|
|
656
716
|
# The summary of the AI Prompt.
|
|
657
717
|
#
|
|
658
718
|
# @!attribute [rw] name
|
|
@@ -886,6 +946,26 @@ module Aws::QConnect
|
|
|
886
946
|
include Aws::Structure
|
|
887
947
|
end
|
|
888
948
|
|
|
949
|
+
# An annotation that provides additional context or metadata.
|
|
950
|
+
#
|
|
951
|
+
# @!attribute [rw] title
|
|
952
|
+
# The title of the annotation.
|
|
953
|
+
# @return [String]
|
|
954
|
+
#
|
|
955
|
+
# @!attribute [rw] destructive_hint
|
|
956
|
+
# A hint indicating that the annotation contains potentially
|
|
957
|
+
# destructive content.
|
|
958
|
+
# @return [Boolean]
|
|
959
|
+
#
|
|
960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Annotation AWS API Documentation
|
|
961
|
+
#
|
|
962
|
+
class Annotation < Struct.new(
|
|
963
|
+
:title,
|
|
964
|
+
:destructive_hint)
|
|
965
|
+
SENSITIVE = []
|
|
966
|
+
include Aws::Structure
|
|
967
|
+
end
|
|
968
|
+
|
|
889
969
|
# The configuration for the `ANSWER_RECOMMENDATION` AI Agent type.
|
|
890
970
|
#
|
|
891
971
|
# @!attribute [rw] intent_labeling_generation_ai_prompt_id
|
|
@@ -928,6 +1008,11 @@ module Aws::QConnect
|
|
|
928
1008
|
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#qic-notes-languages
|
|
929
1009
|
# @return [String]
|
|
930
1010
|
#
|
|
1011
|
+
# @!attribute [rw] suggested_messages
|
|
1012
|
+
# The suggested messages configuration for the Answer Recommendation
|
|
1013
|
+
# AI Agent.
|
|
1014
|
+
# @return [Array<String>]
|
|
1015
|
+
#
|
|
931
1016
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AnswerRecommendationAIAgentConfiguration AWS API Documentation
|
|
932
1017
|
#
|
|
933
1018
|
class AnswerRecommendationAIAgentConfiguration < Struct.new(
|
|
@@ -936,8 +1021,9 @@ module Aws::QConnect
|
|
|
936
1021
|
:answer_generation_ai_prompt_id,
|
|
937
1022
|
:answer_generation_ai_guardrail_id,
|
|
938
1023
|
:association_configurations,
|
|
939
|
-
:locale
|
|
940
|
-
|
|
1024
|
+
:locale,
|
|
1025
|
+
:suggested_messages)
|
|
1026
|
+
SENSITIVE = [:suggested_messages]
|
|
941
1027
|
include Aws::Structure
|
|
942
1028
|
end
|
|
943
1029
|
|
|
@@ -1077,16 +1163,23 @@ module Aws::QConnect
|
|
|
1077
1163
|
# QUICK\_RESPONSES type knowledge base.
|
|
1078
1164
|
# @return [String]
|
|
1079
1165
|
#
|
|
1166
|
+
# @!attribute [rw] external_bedrock_knowledge_base_config
|
|
1167
|
+
# The configuration for an external Bedrock knowledge base
|
|
1168
|
+
# association.
|
|
1169
|
+
# @return [Types::ExternalBedrockKnowledgeBaseConfig]
|
|
1170
|
+
#
|
|
1080
1171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationInputData AWS API Documentation
|
|
1081
1172
|
#
|
|
1082
1173
|
class AssistantAssociationInputData < Struct.new(
|
|
1083
1174
|
:knowledge_base_id,
|
|
1175
|
+
:external_bedrock_knowledge_base_config,
|
|
1084
1176
|
:unknown)
|
|
1085
1177
|
SENSITIVE = []
|
|
1086
1178
|
include Aws::Structure
|
|
1087
1179
|
include Aws::Structure::Union
|
|
1088
1180
|
|
|
1089
1181
|
class KnowledgeBaseId < AssistantAssociationInputData; end
|
|
1182
|
+
class ExternalBedrockKnowledgeBaseConfig < AssistantAssociationInputData; end
|
|
1090
1183
|
class Unknown < AssistantAssociationInputData; end
|
|
1091
1184
|
end
|
|
1092
1185
|
|
|
@@ -1098,16 +1191,23 @@ module Aws::QConnect
|
|
|
1098
1191
|
# The knowledge base where output data is sent.
|
|
1099
1192
|
# @return [Types::KnowledgeBaseAssociationData]
|
|
1100
1193
|
#
|
|
1194
|
+
# @!attribute [rw] external_bedrock_knowledge_base_config
|
|
1195
|
+
# The configuration for an external Bedrock knowledge base association
|
|
1196
|
+
# in the output data.
|
|
1197
|
+
# @return [Types::ExternalBedrockKnowledgeBaseConfig]
|
|
1198
|
+
#
|
|
1101
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantAssociationOutputData AWS API Documentation
|
|
1102
1200
|
#
|
|
1103
1201
|
class AssistantAssociationOutputData < Struct.new(
|
|
1104
1202
|
:knowledge_base_association,
|
|
1203
|
+
:external_bedrock_knowledge_base_config,
|
|
1105
1204
|
:unknown)
|
|
1106
1205
|
SENSITIVE = []
|
|
1107
1206
|
include Aws::Structure
|
|
1108
1207
|
include Aws::Structure::Union
|
|
1109
1208
|
|
|
1110
1209
|
class KnowledgeBaseAssociation < AssistantAssociationOutputData; end
|
|
1210
|
+
class ExternalBedrockKnowledgeBaseConfig < AssistantAssociationOutputData; end
|
|
1111
1211
|
class Unknown < AssistantAssociationOutputData; end
|
|
1112
1212
|
end
|
|
1113
1213
|
|
|
@@ -1237,6 +1337,10 @@ module Aws::QConnect
|
|
|
1237
1337
|
# Agent version) that is set on the Amazon Q in Connect Assistant.
|
|
1238
1338
|
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
|
1239
1339
|
#
|
|
1340
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
1341
|
+
# The list of orchestrator configurations for the assistant.
|
|
1342
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
1343
|
+
#
|
|
1240
1344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantData AWS API Documentation
|
|
1241
1345
|
#
|
|
1242
1346
|
class AssistantData < Struct.new(
|
|
@@ -1250,7 +1354,8 @@ module Aws::QConnect
|
|
|
1250
1354
|
:server_side_encryption_configuration,
|
|
1251
1355
|
:integration_configuration,
|
|
1252
1356
|
:capability_configuration,
|
|
1253
|
-
:ai_agent_configuration
|
|
1357
|
+
:ai_agent_configuration,
|
|
1358
|
+
:orchestrator_configuration_list)
|
|
1254
1359
|
SENSITIVE = []
|
|
1255
1360
|
include Aws::Structure
|
|
1256
1361
|
end
|
|
@@ -1338,6 +1443,10 @@ module Aws::QConnect
|
|
|
1338
1443
|
# Agent version) that is set on the Amazon Q in Connect Assistant.
|
|
1339
1444
|
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
|
1340
1445
|
#
|
|
1446
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
1447
|
+
# The list of orchestrator configurations for the assistant.
|
|
1448
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
1449
|
+
#
|
|
1341
1450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AssistantSummary AWS API Documentation
|
|
1342
1451
|
#
|
|
1343
1452
|
class AssistantSummary < Struct.new(
|
|
@@ -1351,7 +1460,8 @@ module Aws::QConnect
|
|
|
1351
1460
|
:server_side_encryption_configuration,
|
|
1352
1461
|
:integration_configuration,
|
|
1353
1462
|
:capability_configuration,
|
|
1354
|
-
:ai_agent_configuration
|
|
1463
|
+
:ai_agent_configuration,
|
|
1464
|
+
:orchestrator_configuration_list)
|
|
1355
1465
|
SENSITIVE = []
|
|
1356
1466
|
include Aws::Structure
|
|
1357
1467
|
end
|
|
@@ -1427,6 +1537,64 @@ module Aws::QConnect
|
|
|
1427
1537
|
include Aws::Structure
|
|
1428
1538
|
end
|
|
1429
1539
|
|
|
1540
|
+
# The configuration for AI Agents of type `CASE_SUMMARIZATION`.
|
|
1541
|
+
#
|
|
1542
|
+
# @!attribute [rw] case_summarization_ai_prompt_id
|
|
1543
|
+
# The AI Prompt identifier used by the Case Summarization AI Agent.
|
|
1544
|
+
# @return [String]
|
|
1545
|
+
#
|
|
1546
|
+
# @!attribute [rw] case_summarization_ai_guardrail_id
|
|
1547
|
+
# The AI Guardrail identifier used by the Case Summarization AI Agent.
|
|
1548
|
+
# @return [String]
|
|
1549
|
+
#
|
|
1550
|
+
# @!attribute [rw] locale
|
|
1551
|
+
# The locale setting for the Case Summarization AI Agent.
|
|
1552
|
+
# @return [String]
|
|
1553
|
+
#
|
|
1554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CaseSummarizationAIAgentConfiguration AWS API Documentation
|
|
1555
|
+
#
|
|
1556
|
+
class CaseSummarizationAIAgentConfiguration < Struct.new(
|
|
1557
|
+
:case_summarization_ai_prompt_id,
|
|
1558
|
+
:case_summarization_ai_guardrail_id,
|
|
1559
|
+
:locale)
|
|
1560
|
+
SENSITIVE = []
|
|
1561
|
+
include Aws::Structure
|
|
1562
|
+
end
|
|
1563
|
+
|
|
1564
|
+
# Details about case summarization chunk data.
|
|
1565
|
+
#
|
|
1566
|
+
# @!attribute [rw] completion
|
|
1567
|
+
# A chunk of the case summarization completion.
|
|
1568
|
+
# @return [String]
|
|
1569
|
+
#
|
|
1570
|
+
# @!attribute [rw] next_chunk_token
|
|
1571
|
+
# Token for retrieving the next chunk of streaming summarization data,
|
|
1572
|
+
# if available.
|
|
1573
|
+
# @return [String]
|
|
1574
|
+
#
|
|
1575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CaseSummarizationChunkDataDetails AWS API Documentation
|
|
1576
|
+
#
|
|
1577
|
+
class CaseSummarizationChunkDataDetails < Struct.new(
|
|
1578
|
+
:completion,
|
|
1579
|
+
:next_chunk_token)
|
|
1580
|
+
SENSITIVE = []
|
|
1581
|
+
include Aws::Structure
|
|
1582
|
+
end
|
|
1583
|
+
|
|
1584
|
+
# Input data for case summarization.
|
|
1585
|
+
#
|
|
1586
|
+
# @!attribute [rw] case_arn
|
|
1587
|
+
# The Amazon Resource Name (ARN) of the case for summarization.
|
|
1588
|
+
# @return [String]
|
|
1589
|
+
#
|
|
1590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CaseSummarizationInputData AWS API Documentation
|
|
1591
|
+
#
|
|
1592
|
+
class CaseSummarizationInputData < Struct.new(
|
|
1593
|
+
:case_arn)
|
|
1594
|
+
SENSITIVE = []
|
|
1595
|
+
include Aws::Structure
|
|
1596
|
+
end
|
|
1597
|
+
|
|
1430
1598
|
# Details about how to chunk the documents in the data source. A chunk
|
|
1431
1599
|
# refers to an excerpt from a data source that is returned when the
|
|
1432
1600
|
# knowledge base that it belongs to is queried.
|
|
@@ -1470,6 +1638,46 @@ module Aws::QConnect
|
|
|
1470
1638
|
include Aws::Structure
|
|
1471
1639
|
end
|
|
1472
1640
|
|
|
1641
|
+
# A citation that references source content.
|
|
1642
|
+
#
|
|
1643
|
+
# @!attribute [rw] content_id
|
|
1644
|
+
# The identifier of the content being cited.
|
|
1645
|
+
# @return [String]
|
|
1646
|
+
#
|
|
1647
|
+
# @!attribute [rw] title
|
|
1648
|
+
# The title of the cited content.
|
|
1649
|
+
# @return [String]
|
|
1650
|
+
#
|
|
1651
|
+
# @!attribute [rw] knowledge_base_id
|
|
1652
|
+
# The identifier of the knowledge base containing the cited content.
|
|
1653
|
+
# @return [String]
|
|
1654
|
+
#
|
|
1655
|
+
# @!attribute [rw] citation_span
|
|
1656
|
+
# Contains information about where the text with a citation begins and
|
|
1657
|
+
# ends in the generated output.
|
|
1658
|
+
# @return [Types::CitationSpan]
|
|
1659
|
+
#
|
|
1660
|
+
# @!attribute [rw] source_url
|
|
1661
|
+
# The source URL for the citation.
|
|
1662
|
+
# @return [String]
|
|
1663
|
+
#
|
|
1664
|
+
# @!attribute [rw] reference_type
|
|
1665
|
+
# A type to define the KB origin of a cited content
|
|
1666
|
+
# @return [String]
|
|
1667
|
+
#
|
|
1668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Citation AWS API Documentation
|
|
1669
|
+
#
|
|
1670
|
+
class Citation < Struct.new(
|
|
1671
|
+
:content_id,
|
|
1672
|
+
:title,
|
|
1673
|
+
:knowledge_base_id,
|
|
1674
|
+
:citation_span,
|
|
1675
|
+
:source_url,
|
|
1676
|
+
:reference_type)
|
|
1677
|
+
SENSITIVE = [:title, :source_url]
|
|
1678
|
+
include Aws::Structure
|
|
1679
|
+
end
|
|
1680
|
+
|
|
1473
1681
|
# Contains information about where the text with a citation begins and
|
|
1474
1682
|
# ends in the generated output.
|
|
1475
1683
|
#
|
|
@@ -2304,6 +2512,10 @@ module Aws::QConnect
|
|
|
2304
2512
|
# The description of the AI Prompt.
|
|
2305
2513
|
# @return [String]
|
|
2306
2514
|
#
|
|
2515
|
+
# @!attribute [rw] inference_configuration
|
|
2516
|
+
# The inference configuration for the AI Prompt being created.
|
|
2517
|
+
# @return [Types::AIPromptInferenceConfiguration]
|
|
2518
|
+
#
|
|
2307
2519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateAIPromptRequest AWS API Documentation
|
|
2308
2520
|
#
|
|
2309
2521
|
class CreateAIPromptRequest < Struct.new(
|
|
@@ -2317,7 +2529,8 @@ module Aws::QConnect
|
|
|
2317
2529
|
:model_id,
|
|
2318
2530
|
:api_format,
|
|
2319
2531
|
:tags,
|
|
2320
|
-
:description
|
|
2532
|
+
:description,
|
|
2533
|
+
:inference_configuration)
|
|
2321
2534
|
SENSITIVE = []
|
|
2322
2535
|
include Aws::Structure
|
|
2323
2536
|
end
|
|
@@ -2854,6 +3067,11 @@ module Aws::QConnect
|
|
|
2854
3067
|
# `zh_CN`, `zh_TW`
|
|
2855
3068
|
# @return [String]
|
|
2856
3069
|
#
|
|
3070
|
+
# @!attribute [rw] source_configuration
|
|
3071
|
+
# The source configuration of the message template. Only set this
|
|
3072
|
+
# argument for WHATSAPP channel subtype.
|
|
3073
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
3074
|
+
#
|
|
2857
3075
|
# @!attribute [rw] default_attributes
|
|
2858
3076
|
# An object that specifies the default values to use for variables in
|
|
2859
3077
|
# the message template. This object contains different categories of
|
|
@@ -2895,6 +3113,7 @@ module Aws::QConnect
|
|
|
2895
3113
|
:description,
|
|
2896
3114
|
:channel_subtype,
|
|
2897
3115
|
:language,
|
|
3116
|
+
:source_configuration,
|
|
2898
3117
|
:default_attributes,
|
|
2899
3118
|
:grouping_configuration,
|
|
2900
3119
|
:client_token,
|
|
@@ -3107,6 +3326,15 @@ module Aws::QConnect
|
|
|
3107
3326
|
# context for AI-powered email assistance.
|
|
3108
3327
|
# @return [String]
|
|
3109
3328
|
#
|
|
3329
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
3330
|
+
# The list of orchestrator configurations for the session being
|
|
3331
|
+
# created.
|
|
3332
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
3333
|
+
#
|
|
3334
|
+
# @!attribute [rw] remove_orchestrator_configuration_list
|
|
3335
|
+
# The list of orchestrator configurations to remove from the session.
|
|
3336
|
+
# @return [Boolean]
|
|
3337
|
+
#
|
|
3110
3338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionRequest AWS API Documentation
|
|
3111
3339
|
#
|
|
3112
3340
|
class CreateSessionRequest < Struct.new(
|
|
@@ -3117,7 +3345,9 @@ module Aws::QConnect
|
|
|
3117
3345
|
:tags,
|
|
3118
3346
|
:tag_filter,
|
|
3119
3347
|
:ai_agent_configuration,
|
|
3120
|
-
:contact_arn
|
|
3348
|
+
:contact_arn,
|
|
3349
|
+
:orchestrator_configuration_list,
|
|
3350
|
+
:remove_orchestrator_configuration_list)
|
|
3121
3351
|
SENSITIVE = []
|
|
3122
3352
|
include Aws::Structure
|
|
3123
3353
|
end
|
|
@@ -3475,6 +3705,22 @@ module Aws::QConnect
|
|
|
3475
3705
|
# knowledge-based response content.
|
|
3476
3706
|
# @return [Types::EmailGenerativeAnswerChunkDataDetails]
|
|
3477
3707
|
#
|
|
3708
|
+
# @!attribute [rw] case_summarization_chunk_data
|
|
3709
|
+
# Details about case summarization chunk data.
|
|
3710
|
+
# @return [Types::CaseSummarizationChunkDataDetails]
|
|
3711
|
+
#
|
|
3712
|
+
# @!attribute [rw] suggested_message_data
|
|
3713
|
+
# Details about suggested message data.
|
|
3714
|
+
# @return [Types::SuggestedMessageDataDetails]
|
|
3715
|
+
#
|
|
3716
|
+
# @!attribute [rw] notes_data
|
|
3717
|
+
# Details about notes data.
|
|
3718
|
+
# @return [Types::NotesDataDetails]
|
|
3719
|
+
#
|
|
3720
|
+
# @!attribute [rw] notes_chunk_data
|
|
3721
|
+
# Details about notes chunk data.
|
|
3722
|
+
# @return [Types::NotesChunkDataDetails]
|
|
3723
|
+
#
|
|
3478
3724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
|
|
3479
3725
|
#
|
|
3480
3726
|
class DataDetails < Struct.new(
|
|
@@ -3486,6 +3732,10 @@ module Aws::QConnect
|
|
|
3486
3732
|
:email_response_chunk_data,
|
|
3487
3733
|
:email_overview_chunk_data,
|
|
3488
3734
|
:email_generative_answer_chunk_data,
|
|
3735
|
+
:case_summarization_chunk_data,
|
|
3736
|
+
:suggested_message_data,
|
|
3737
|
+
:notes_data,
|
|
3738
|
+
:notes_chunk_data,
|
|
3489
3739
|
:unknown)
|
|
3490
3740
|
SENSITIVE = []
|
|
3491
3741
|
include Aws::Structure
|
|
@@ -3499,6 +3749,10 @@ module Aws::QConnect
|
|
|
3499
3749
|
class EmailResponseChunkData < DataDetails; end
|
|
3500
3750
|
class EmailOverviewChunkData < DataDetails; end
|
|
3501
3751
|
class EmailGenerativeAnswerChunkData < DataDetails; end
|
|
3752
|
+
class CaseSummarizationChunkData < DataDetails; end
|
|
3753
|
+
class SuggestedMessageData < DataDetails; end
|
|
3754
|
+
class NotesData < DataDetails; end
|
|
3755
|
+
class NotesChunkData < DataDetails; end
|
|
3502
3756
|
class Unknown < DataDetails; end
|
|
3503
3757
|
end
|
|
3504
3758
|
|
|
@@ -3514,11 +3768,16 @@ module Aws::QConnect
|
|
|
3514
3768
|
# Reference information about the generative content.
|
|
3515
3769
|
# @return [Types::GenerativeReference]
|
|
3516
3770
|
#
|
|
3771
|
+
# @!attribute [rw] suggested_message_reference
|
|
3772
|
+
# Reference information for suggested messages.
|
|
3773
|
+
# @return [Types::SuggestedMessageReference]
|
|
3774
|
+
#
|
|
3517
3775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataReference AWS API Documentation
|
|
3518
3776
|
#
|
|
3519
3777
|
class DataReference < Struct.new(
|
|
3520
3778
|
:content_reference,
|
|
3521
3779
|
:generative_reference,
|
|
3780
|
+
:suggested_message_reference,
|
|
3522
3781
|
:unknown)
|
|
3523
3782
|
SENSITIVE = []
|
|
3524
3783
|
include Aws::Structure
|
|
@@ -3526,6 +3785,7 @@ module Aws::QConnect
|
|
|
3526
3785
|
|
|
3527
3786
|
class ContentReference < DataReference; end
|
|
3528
3787
|
class GenerativeReference < DataReference; end
|
|
3788
|
+
class SuggestedMessageReference < DataReference; end
|
|
3529
3789
|
class Unknown < DataReference; end
|
|
3530
3790
|
end
|
|
3531
3791
|
|
|
@@ -3947,8 +4207,7 @@ module Aws::QConnect
|
|
|
3947
4207
|
#
|
|
3948
4208
|
class DeleteQuickResponseResponse < Aws::EmptyStructure; end
|
|
3949
4209
|
|
|
3950
|
-
#
|
|
3951
|
-
# `connect:DecribeContact` as part of `CreateSession` with a contactArn.
|
|
4210
|
+
# The request failed because it depends on another request that failed.
|
|
3952
4211
|
#
|
|
3953
4212
|
# @!attribute [rw] message
|
|
3954
4213
|
# @return [String]
|
|
@@ -4258,6 +4517,10 @@ module Aws::QConnect
|
|
|
4258
4517
|
# The name of the message template.
|
|
4259
4518
|
# @return [String]
|
|
4260
4519
|
#
|
|
4520
|
+
# @!attribute [rw] channel
|
|
4521
|
+
# The channel of the message template.
|
|
4522
|
+
# @return [String]
|
|
4523
|
+
#
|
|
4261
4524
|
# @!attribute [rw] channel_subtype
|
|
4262
4525
|
# The channel subtype this message template applies to.
|
|
4263
4526
|
# @return [String]
|
|
@@ -4290,6 +4553,10 @@ module Aws::QConnect
|
|
|
4290
4553
|
# `zh_CN`, `zh_TW`
|
|
4291
4554
|
# @return [String]
|
|
4292
4555
|
#
|
|
4556
|
+
# @!attribute [rw] source_configuration_summary
|
|
4557
|
+
# The source configuration summary of the message template.
|
|
4558
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
4559
|
+
#
|
|
4293
4560
|
# @!attribute [rw] grouping_configuration
|
|
4294
4561
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
4295
4562
|
# users.
|
|
@@ -4340,6 +4607,7 @@ module Aws::QConnect
|
|
|
4340
4607
|
:knowledge_base_arn,
|
|
4341
4608
|
:knowledge_base_id,
|
|
4342
4609
|
:name,
|
|
4610
|
+
:channel,
|
|
4343
4611
|
:channel_subtype,
|
|
4344
4612
|
:created_time,
|
|
4345
4613
|
:last_modified_time,
|
|
@@ -4347,6 +4615,7 @@ module Aws::QConnect
|
|
|
4347
4615
|
:content,
|
|
4348
4616
|
:description,
|
|
4349
4617
|
:language,
|
|
4618
|
+
:source_configuration_summary,
|
|
4350
4619
|
:grouping_configuration,
|
|
4351
4620
|
:default_attributes,
|
|
4352
4621
|
:attribute_types,
|
|
@@ -4355,6 +4624,27 @@ module Aws::QConnect
|
|
|
4355
4624
|
:version_number,
|
|
4356
4625
|
:message_template_content_sha_256,
|
|
4357
4626
|
:tags)
|
|
4627
|
+
SENSITIVE = [:channel]
|
|
4628
|
+
include Aws::Structure
|
|
4629
|
+
end
|
|
4630
|
+
|
|
4631
|
+
# Configuration for an external Bedrock knowledge base.
|
|
4632
|
+
#
|
|
4633
|
+
# @!attribute [rw] bedrock_knowledge_base_arn
|
|
4634
|
+
# The Amazon Resource Name (ARN) of the external Bedrock knowledge
|
|
4635
|
+
# base.
|
|
4636
|
+
# @return [String]
|
|
4637
|
+
#
|
|
4638
|
+
# @!attribute [rw] access_role_arn
|
|
4639
|
+
# The Amazon Resource Name (ARN) of the IAM role used to access the
|
|
4640
|
+
# external Bedrock knowledge base.
|
|
4641
|
+
# @return [String]
|
|
4642
|
+
#
|
|
4643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ExternalBedrockKnowledgeBaseConfig AWS API Documentation
|
|
4644
|
+
#
|
|
4645
|
+
class ExternalBedrockKnowledgeBaseConfig < Struct.new(
|
|
4646
|
+
:bedrock_knowledge_base_arn,
|
|
4647
|
+
:access_role_arn)
|
|
4358
4648
|
SENSITIVE = []
|
|
4359
4649
|
include Aws::Structure
|
|
4360
4650
|
end
|
|
@@ -4403,6 +4693,25 @@ module Aws::QConnect
|
|
|
4403
4693
|
include Aws::Structure
|
|
4404
4694
|
end
|
|
4405
4695
|
|
|
4696
|
+
# An attribute used for filtering.
|
|
4697
|
+
#
|
|
4698
|
+
# @!attribute [rw] key
|
|
4699
|
+
# The key of the filter attribute.
|
|
4700
|
+
# @return [String]
|
|
4701
|
+
#
|
|
4702
|
+
# @!attribute [rw] value
|
|
4703
|
+
# The value of the filter attribute.
|
|
4704
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
4705
|
+
#
|
|
4706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/FilterAttribute AWS API Documentation
|
|
4707
|
+
#
|
|
4708
|
+
class FilterAttribute < Struct.new(
|
|
4709
|
+
:key,
|
|
4710
|
+
:value)
|
|
4711
|
+
SENSITIVE = []
|
|
4712
|
+
include Aws::Structure
|
|
4713
|
+
end
|
|
4714
|
+
|
|
4406
4715
|
# Configurations for when you choose fixed-size chunking. If you set the
|
|
4407
4716
|
# `chunkingStrategy` as `NONE`, exclude this field.
|
|
4408
4717
|
#
|
|
@@ -4907,6 +5216,10 @@ module Aws::QConnect
|
|
|
4907
5216
|
# The conversation data stored on an Amazon Q in Connect Session.
|
|
4908
5217
|
# @return [Array<Types::RuntimeSessionData>]
|
|
4909
5218
|
#
|
|
5219
|
+
# @!attribute [rw] chunked_response_terminated
|
|
5220
|
+
# Indicates whether the chunked response has been terminated.
|
|
5221
|
+
# @return [Boolean]
|
|
5222
|
+
#
|
|
4910
5223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageResponse AWS API Documentation
|
|
4911
5224
|
#
|
|
4912
5225
|
class GetNextMessageResponse < Struct.new(
|
|
@@ -4915,7 +5228,8 @@ module Aws::QConnect
|
|
|
4915
5228
|
:request_message_id,
|
|
4916
5229
|
:conversation_state,
|
|
4917
5230
|
:next_message_token,
|
|
4918
|
-
:conversation_session_data
|
|
5231
|
+
:conversation_session_data,
|
|
5232
|
+
:chunked_response_terminated)
|
|
4919
5233
|
SENSITIVE = []
|
|
4920
5234
|
include Aws::Structure
|
|
4921
5235
|
end
|
|
@@ -4978,6 +5292,10 @@ module Aws::QConnect
|
|
|
4978
5292
|
# chunks.
|
|
4979
5293
|
# @return [String]
|
|
4980
5294
|
#
|
|
5295
|
+
# @!attribute [rw] recommendation_type
|
|
5296
|
+
# The type of recommendation being requested.
|
|
5297
|
+
# @return [String]
|
|
5298
|
+
#
|
|
4981
5299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendationsRequest AWS API Documentation
|
|
4982
5300
|
#
|
|
4983
5301
|
class GetRecommendationsRequest < Struct.new(
|
|
@@ -4985,7 +5303,8 @@ module Aws::QConnect
|
|
|
4985
5303
|
:session_id,
|
|
4986
5304
|
:max_results,
|
|
4987
5305
|
:wait_time_seconds,
|
|
4988
|
-
:next_chunk_token
|
|
5306
|
+
:next_chunk_token,
|
|
5307
|
+
:recommendation_type)
|
|
4989
5308
|
SENSITIVE = []
|
|
4990
5309
|
include Aws::Structure
|
|
4991
5310
|
end
|
|
@@ -5706,11 +6025,16 @@ module Aws::QConnect
|
|
|
5706
6025
|
# The identifier of the detected intent.
|
|
5707
6026
|
# @return [String]
|
|
5708
6027
|
#
|
|
6028
|
+
# @!attribute [rw] relevance_level
|
|
6029
|
+
# The relevance level of the detected intent.
|
|
6030
|
+
# @return [String]
|
|
6031
|
+
#
|
|
5709
6032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/IntentDetectedDataDetails AWS API Documentation
|
|
5710
6033
|
#
|
|
5711
6034
|
class IntentDetectedDataDetails < Struct.new(
|
|
5712
6035
|
:intent,
|
|
5713
|
-
:intent_id
|
|
6036
|
+
:intent_id,
|
|
6037
|
+
:relevance_level)
|
|
5714
6038
|
SENSITIVE = [:intent]
|
|
5715
6039
|
include Aws::Structure
|
|
5716
6040
|
end
|
|
@@ -5950,6 +6274,28 @@ module Aws::QConnect
|
|
|
5950
6274
|
include Aws::Structure
|
|
5951
6275
|
end
|
|
5952
6276
|
|
|
6277
|
+
# A knowledge source that provides content for recommendations.
|
|
6278
|
+
#
|
|
6279
|
+
# @note KnowledgeSource is a union - when making an API calls you must set exactly one of the members.
|
|
6280
|
+
#
|
|
6281
|
+
# @!attribute [rw] assistant_association_ids
|
|
6282
|
+
# The list of assistant association identifiers for the knowledge
|
|
6283
|
+
# source.
|
|
6284
|
+
# @return [Array<String>]
|
|
6285
|
+
#
|
|
6286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/KnowledgeSource AWS API Documentation
|
|
6287
|
+
#
|
|
6288
|
+
class KnowledgeSource < Struct.new(
|
|
6289
|
+
:assistant_association_ids,
|
|
6290
|
+
:unknown)
|
|
6291
|
+
SENSITIVE = []
|
|
6292
|
+
include Aws::Structure
|
|
6293
|
+
include Aws::Structure::Union
|
|
6294
|
+
|
|
6295
|
+
class AssistantAssociationIds < KnowledgeSource; end
|
|
6296
|
+
class Unknown < KnowledgeSource; end
|
|
6297
|
+
end
|
|
6298
|
+
|
|
5953
6299
|
# @!attribute [rw] assistant_id
|
|
5954
6300
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
|
5955
6301
|
# the ID or the ARN. URLs cannot contain the ARN.
|
|
@@ -6622,13 +6968,18 @@ module Aws::QConnect
|
|
|
6622
6968
|
# The maximum number of results to return per page.
|
|
6623
6969
|
# @return [Integer]
|
|
6624
6970
|
#
|
|
6971
|
+
# @!attribute [rw] filter
|
|
6972
|
+
# The filter criteria for listing messages.
|
|
6973
|
+
# @return [String]
|
|
6974
|
+
#
|
|
6625
6975
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesRequest AWS API Documentation
|
|
6626
6976
|
#
|
|
6627
6977
|
class ListMessagesRequest < Struct.new(
|
|
6628
6978
|
:assistant_id,
|
|
6629
6979
|
:session_id,
|
|
6630
6980
|
:next_token,
|
|
6631
|
-
:max_results
|
|
6981
|
+
:max_results,
|
|
6982
|
+
:filter)
|
|
6632
6983
|
SENSITIVE = []
|
|
6633
6984
|
include Aws::Structure
|
|
6634
6985
|
end
|
|
@@ -6696,6 +7047,50 @@ module Aws::QConnect
|
|
|
6696
7047
|
include Aws::Structure
|
|
6697
7048
|
end
|
|
6698
7049
|
|
|
7050
|
+
# @!attribute [rw] assistant_id
|
|
7051
|
+
# UUID or ARN of the Connect AI Assistant resource
|
|
7052
|
+
# @return [String]
|
|
7053
|
+
#
|
|
7054
|
+
# @!attribute [rw] session_id
|
|
7055
|
+
# UUID or ARN of the Connect AI Session resource
|
|
7056
|
+
# @return [String]
|
|
7057
|
+
#
|
|
7058
|
+
# @!attribute [rw] next_token
|
|
7059
|
+
# Pagination token for retrieving the next page of results
|
|
7060
|
+
# @return [String]
|
|
7061
|
+
#
|
|
7062
|
+
# @!attribute [rw] max_results
|
|
7063
|
+
# Maximum number of spans to return per page
|
|
7064
|
+
# @return [Integer]
|
|
7065
|
+
#
|
|
7066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListSpansRequest AWS API Documentation
|
|
7067
|
+
#
|
|
7068
|
+
class ListSpansRequest < Struct.new(
|
|
7069
|
+
:assistant_id,
|
|
7070
|
+
:session_id,
|
|
7071
|
+
:next_token,
|
|
7072
|
+
:max_results)
|
|
7073
|
+
SENSITIVE = []
|
|
7074
|
+
include Aws::Structure
|
|
7075
|
+
end
|
|
7076
|
+
|
|
7077
|
+
# @!attribute [rw] spans
|
|
7078
|
+
# Array of span objects for the session
|
|
7079
|
+
# @return [Array<Types::Span>]
|
|
7080
|
+
#
|
|
7081
|
+
# @!attribute [rw] next_token
|
|
7082
|
+
# Pagination token for retrieving additional results
|
|
7083
|
+
# @return [String]
|
|
7084
|
+
#
|
|
7085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListSpansResponse AWS API Documentation
|
|
7086
|
+
#
|
|
7087
|
+
class ListSpansResponse < Struct.new(
|
|
7088
|
+
:spans,
|
|
7089
|
+
:next_token)
|
|
7090
|
+
SENSITIVE = []
|
|
7091
|
+
include Aws::Structure
|
|
7092
|
+
end
|
|
7093
|
+
|
|
6699
7094
|
# @!attribute [rw] resource_arn
|
|
6700
7095
|
# The Amazon Resource Name (ARN) of the resource.
|
|
6701
7096
|
# @return [String]
|
|
@@ -6797,10 +7192,15 @@ module Aws::QConnect
|
|
|
6797
7192
|
# Generates a filler response when tool selection is `QUESTION`.
|
|
6798
7193
|
# @return [Boolean]
|
|
6799
7194
|
#
|
|
7195
|
+
# @!attribute [rw] generate_chunked_message
|
|
7196
|
+
# Configuration for generating chunked messages.
|
|
7197
|
+
# @return [Boolean]
|
|
7198
|
+
#
|
|
6800
7199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageConfiguration AWS API Documentation
|
|
6801
7200
|
#
|
|
6802
7201
|
class MessageConfiguration < Struct.new(
|
|
6803
|
-
:generate_filler_message
|
|
7202
|
+
:generate_filler_message,
|
|
7203
|
+
:generate_chunked_message)
|
|
6804
7204
|
SENSITIVE = []
|
|
6805
7205
|
include Aws::Structure
|
|
6806
7206
|
end
|
|
@@ -6815,16 +7215,22 @@ module Aws::QConnect
|
|
|
6815
7215
|
# The message data in text type.
|
|
6816
7216
|
# @return [Types::TextMessage]
|
|
6817
7217
|
#
|
|
7218
|
+
# @!attribute [rw] tool_use_result
|
|
7219
|
+
# The result of tool usage in the message.
|
|
7220
|
+
# @return [Types::ToolUseResultData]
|
|
7221
|
+
#
|
|
6818
7222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageData AWS API Documentation
|
|
6819
7223
|
#
|
|
6820
7224
|
class MessageData < Struct.new(
|
|
6821
7225
|
:text,
|
|
7226
|
+
:tool_use_result,
|
|
6822
7227
|
:unknown)
|
|
6823
7228
|
SENSITIVE = []
|
|
6824
7229
|
include Aws::Structure
|
|
6825
7230
|
include Aws::Structure::Union
|
|
6826
7231
|
|
|
6827
7232
|
class Text < MessageData; end
|
|
7233
|
+
class ToolUseResult < MessageData; end
|
|
6828
7234
|
class Unknown < MessageData; end
|
|
6829
7235
|
end
|
|
6830
7236
|
|
|
@@ -6981,11 +7387,23 @@ module Aws::QConnect
|
|
|
6981
7387
|
# subtype.
|
|
6982
7388
|
# @return [Types::SMSMessageTemplateContent]
|
|
6983
7389
|
#
|
|
7390
|
+
# @!attribute [rw] whats_app
|
|
7391
|
+
# The content of the message template that applies to the WHATSAPP
|
|
7392
|
+
# channel subtype.
|
|
7393
|
+
# @return [Types::WhatsAppMessageTemplateContent]
|
|
7394
|
+
#
|
|
7395
|
+
# @!attribute [rw] push
|
|
7396
|
+
# The content of the message template that applies to the push channel
|
|
7397
|
+
# subtype.
|
|
7398
|
+
# @return [Types::PushMessageTemplateContent]
|
|
7399
|
+
#
|
|
6984
7400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateContentProvider AWS API Documentation
|
|
6985
7401
|
#
|
|
6986
7402
|
class MessageTemplateContentProvider < Struct.new(
|
|
6987
7403
|
:email,
|
|
6988
7404
|
:sms,
|
|
7405
|
+
:whats_app,
|
|
7406
|
+
:push,
|
|
6989
7407
|
:unknown)
|
|
6990
7408
|
SENSITIVE = []
|
|
6991
7409
|
include Aws::Structure
|
|
@@ -6993,6 +7411,8 @@ module Aws::QConnect
|
|
|
6993
7411
|
|
|
6994
7412
|
class Email < MessageTemplateContentProvider; end
|
|
6995
7413
|
class Sms < MessageTemplateContentProvider; end
|
|
7414
|
+
class WhatsApp < MessageTemplateContentProvider; end
|
|
7415
|
+
class Push < MessageTemplateContentProvider; end
|
|
6996
7416
|
class Unknown < MessageTemplateContentProvider; end
|
|
6997
7417
|
end
|
|
6998
7418
|
|
|
@@ -7018,6 +7438,10 @@ module Aws::QConnect
|
|
|
7018
7438
|
# The name of the message template.
|
|
7019
7439
|
# @return [String]
|
|
7020
7440
|
#
|
|
7441
|
+
# @!attribute [rw] channel
|
|
7442
|
+
# The channel of the message template.
|
|
7443
|
+
# @return [String]
|
|
7444
|
+
#
|
|
7021
7445
|
# @!attribute [rw] channel_subtype
|
|
7022
7446
|
# The channel subtype this message template applies to.
|
|
7023
7447
|
# @return [String]
|
|
@@ -7050,6 +7474,10 @@ module Aws::QConnect
|
|
|
7050
7474
|
# `zh_CN`, `zh_TW`
|
|
7051
7475
|
# @return [String]
|
|
7052
7476
|
#
|
|
7477
|
+
# @!attribute [rw] source_configuration_summary
|
|
7478
|
+
# The source configuration summary of the message template.
|
|
7479
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
7480
|
+
#
|
|
7053
7481
|
# @!attribute [rw] grouping_configuration
|
|
7054
7482
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
7055
7483
|
# users.
|
|
@@ -7088,6 +7516,7 @@ module Aws::QConnect
|
|
|
7088
7516
|
:knowledge_base_arn,
|
|
7089
7517
|
:knowledge_base_id,
|
|
7090
7518
|
:name,
|
|
7519
|
+
:channel,
|
|
7091
7520
|
:channel_subtype,
|
|
7092
7521
|
:created_time,
|
|
7093
7522
|
:last_modified_time,
|
|
@@ -7095,12 +7524,13 @@ module Aws::QConnect
|
|
|
7095
7524
|
:content,
|
|
7096
7525
|
:description,
|
|
7097
7526
|
:language,
|
|
7527
|
+
:source_configuration_summary,
|
|
7098
7528
|
:grouping_configuration,
|
|
7099
7529
|
:default_attributes,
|
|
7100
7530
|
:attribute_types,
|
|
7101
7531
|
:message_template_content_sha_256,
|
|
7102
7532
|
:tags)
|
|
7103
|
-
SENSITIVE = []
|
|
7533
|
+
SENSITIVE = [:channel]
|
|
7104
7534
|
include Aws::Structure
|
|
7105
7535
|
end
|
|
7106
7536
|
|
|
@@ -7290,6 +7720,10 @@ module Aws::QConnect
|
|
|
7290
7720
|
# The name of the message template.
|
|
7291
7721
|
# @return [String]
|
|
7292
7722
|
#
|
|
7723
|
+
# @!attribute [rw] channel
|
|
7724
|
+
# The channel of the message template.
|
|
7725
|
+
# @return [String]
|
|
7726
|
+
#
|
|
7293
7727
|
# @!attribute [rw] channel_subtype
|
|
7294
7728
|
# The channel subtype this message template applies to.
|
|
7295
7729
|
# @return [String]
|
|
@@ -7319,6 +7753,10 @@ module Aws::QConnect
|
|
|
7319
7753
|
# The description of the message template.
|
|
7320
7754
|
# @return [String]
|
|
7321
7755
|
#
|
|
7756
|
+
# @!attribute [rw] source_configuration_summary
|
|
7757
|
+
# The source configuration summary of the message template.
|
|
7758
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
7759
|
+
#
|
|
7322
7760
|
# @!attribute [rw] grouping_configuration
|
|
7323
7761
|
# The configuration information of the grouping of Amazon Q in Connect
|
|
7324
7762
|
# users.
|
|
@@ -7344,6 +7782,7 @@ module Aws::QConnect
|
|
|
7344
7782
|
:knowledge_base_arn,
|
|
7345
7783
|
:knowledge_base_id,
|
|
7346
7784
|
:name,
|
|
7785
|
+
:channel,
|
|
7347
7786
|
:channel_subtype,
|
|
7348
7787
|
:created_time,
|
|
7349
7788
|
:last_modified_time,
|
|
@@ -7351,11 +7790,58 @@ module Aws::QConnect
|
|
|
7351
7790
|
:is_active,
|
|
7352
7791
|
:version_number,
|
|
7353
7792
|
:description,
|
|
7793
|
+
:source_configuration_summary,
|
|
7354
7794
|
:grouping_configuration,
|
|
7355
7795
|
:language,
|
|
7356
7796
|
:tags)
|
|
7797
|
+
SENSITIVE = [:channel]
|
|
7798
|
+
include Aws::Structure
|
|
7799
|
+
end
|
|
7800
|
+
|
|
7801
|
+
# The container of message template source configuration.
|
|
7802
|
+
#
|
|
7803
|
+
# @note MessageTemplateSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
7804
|
+
#
|
|
7805
|
+
# @note MessageTemplateSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateSourceConfiguration corresponding to the set member.
|
|
7806
|
+
#
|
|
7807
|
+
# @!attribute [rw] whats_app
|
|
7808
|
+
# The sourceConfiguration of the message template that applies to the
|
|
7809
|
+
# WHATSAPP channel subtype.
|
|
7810
|
+
# @return [Types::WhatsAppMessageTemplateSourceConfiguration]
|
|
7811
|
+
#
|
|
7812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSourceConfiguration AWS API Documentation
|
|
7813
|
+
#
|
|
7814
|
+
class MessageTemplateSourceConfiguration < Struct.new(
|
|
7815
|
+
:whats_app,
|
|
7816
|
+
:unknown)
|
|
7817
|
+
SENSITIVE = []
|
|
7818
|
+
include Aws::Structure
|
|
7819
|
+
include Aws::Structure::Union
|
|
7820
|
+
|
|
7821
|
+
class WhatsApp < MessageTemplateSourceConfiguration; end
|
|
7822
|
+
class Unknown < MessageTemplateSourceConfiguration; end
|
|
7823
|
+
end
|
|
7824
|
+
|
|
7825
|
+
# The container of message template source configuration summary.
|
|
7826
|
+
#
|
|
7827
|
+
# @note MessageTemplateSourceConfigurationSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of MessageTemplateSourceConfigurationSummary corresponding to the set member.
|
|
7828
|
+
#
|
|
7829
|
+
# @!attribute [rw] whats_app
|
|
7830
|
+
# The sourceConfiguration summary of the message template that applies
|
|
7831
|
+
# to the WHATSAPP channel subtype.
|
|
7832
|
+
# @return [Types::WhatsAppMessageTemplateSourceConfigurationSummary]
|
|
7833
|
+
#
|
|
7834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageTemplateSourceConfigurationSummary AWS API Documentation
|
|
7835
|
+
#
|
|
7836
|
+
class MessageTemplateSourceConfigurationSummary < Struct.new(
|
|
7837
|
+
:whats_app,
|
|
7838
|
+
:unknown)
|
|
7357
7839
|
SENSITIVE = []
|
|
7358
7840
|
include Aws::Structure
|
|
7841
|
+
include Aws::Structure::Union
|
|
7842
|
+
|
|
7843
|
+
class WhatsApp < MessageTemplateSourceConfigurationSummary; end
|
|
7844
|
+
class Unknown < MessageTemplateSourceConfigurationSummary; end
|
|
7359
7845
|
end
|
|
7360
7846
|
|
|
7361
7847
|
# The summary of the message template.
|
|
@@ -7380,6 +7866,10 @@ module Aws::QConnect
|
|
|
7380
7866
|
# The name of the message template.
|
|
7381
7867
|
# @return [String]
|
|
7382
7868
|
#
|
|
7869
|
+
# @!attribute [rw] channel
|
|
7870
|
+
# The channel this message template applies to.
|
|
7871
|
+
# @return [String]
|
|
7872
|
+
#
|
|
7383
7873
|
# @!attribute [rw] channel_subtype
|
|
7384
7874
|
# The channel subtype this message template applies to.
|
|
7385
7875
|
# @return [String]
|
|
@@ -7397,6 +7887,10 @@ module Aws::QConnect
|
|
|
7397
7887
|
# message template data.
|
|
7398
7888
|
# @return [String]
|
|
7399
7889
|
#
|
|
7890
|
+
# @!attribute [rw] source_configuration
|
|
7891
|
+
# The container of message template source configuration.
|
|
7892
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
7893
|
+
#
|
|
7400
7894
|
# @!attribute [rw] active_version_number
|
|
7401
7895
|
# The version number of the message template version that is
|
|
7402
7896
|
# activated.
|
|
@@ -7419,14 +7913,16 @@ module Aws::QConnect
|
|
|
7419
7913
|
:knowledge_base_arn,
|
|
7420
7914
|
:knowledge_base_id,
|
|
7421
7915
|
:name,
|
|
7916
|
+
:channel,
|
|
7422
7917
|
:channel_subtype,
|
|
7423
7918
|
:created_time,
|
|
7424
7919
|
:last_modified_time,
|
|
7425
7920
|
:last_modified_by,
|
|
7921
|
+
:source_configuration,
|
|
7426
7922
|
:active_version_number,
|
|
7427
7923
|
:description,
|
|
7428
7924
|
:tags)
|
|
7429
|
-
SENSITIVE = []
|
|
7925
|
+
SENSITIVE = [:channel]
|
|
7430
7926
|
include Aws::Structure
|
|
7431
7927
|
end
|
|
7432
7928
|
|
|
@@ -7452,6 +7948,10 @@ module Aws::QConnect
|
|
|
7452
7948
|
# The name of the message template.
|
|
7453
7949
|
# @return [String]
|
|
7454
7950
|
#
|
|
7951
|
+
# @!attribute [rw] channel
|
|
7952
|
+
# The channel of the message template.
|
|
7953
|
+
# @return [String]
|
|
7954
|
+
#
|
|
7455
7955
|
# @!attribute [rw] channel_subtype
|
|
7456
7956
|
# The channel subtype this message template applies to.
|
|
7457
7957
|
# @return [String]
|
|
@@ -7472,14 +7972,73 @@ module Aws::QConnect
|
|
|
7472
7972
|
:knowledge_base_arn,
|
|
7473
7973
|
:knowledge_base_id,
|
|
7474
7974
|
:name,
|
|
7975
|
+
:channel,
|
|
7475
7976
|
:channel_subtype,
|
|
7476
7977
|
:is_active,
|
|
7477
7978
|
:version_number)
|
|
7478
|
-
SENSITIVE = []
|
|
7979
|
+
SENSITIVE = [:channel]
|
|
7479
7980
|
include Aws::Structure
|
|
7480
7981
|
end
|
|
7481
7982
|
|
|
7482
|
-
#
|
|
7983
|
+
# The configuration for AI Agents of type `NOTE_TAKING`.
|
|
7984
|
+
#
|
|
7985
|
+
# @!attribute [rw] note_taking_ai_prompt_id
|
|
7986
|
+
# The AI Prompt identifier used by the Note Taking AI Agent.
|
|
7987
|
+
# @return [String]
|
|
7988
|
+
#
|
|
7989
|
+
# @!attribute [rw] note_taking_ai_guardrail_id
|
|
7990
|
+
# The AI Guardrail identifier used by the Note Taking AI Agent.
|
|
7991
|
+
# @return [String]
|
|
7992
|
+
#
|
|
7993
|
+
# @!attribute [rw] locale
|
|
7994
|
+
# The locale setting for language-specific case summarization
|
|
7995
|
+
# generation (for example, en\_US, es\_ES).
|
|
7996
|
+
# @return [String]
|
|
7997
|
+
#
|
|
7998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NoteTakingAIAgentConfiguration AWS API Documentation
|
|
7999
|
+
#
|
|
8000
|
+
class NoteTakingAIAgentConfiguration < Struct.new(
|
|
8001
|
+
:note_taking_ai_prompt_id,
|
|
8002
|
+
:note_taking_ai_guardrail_id,
|
|
8003
|
+
:locale)
|
|
8004
|
+
SENSITIVE = []
|
|
8005
|
+
include Aws::Structure
|
|
8006
|
+
end
|
|
8007
|
+
|
|
8008
|
+
# Details about notes chunk data.
|
|
8009
|
+
#
|
|
8010
|
+
# @!attribute [rw] completion
|
|
8011
|
+
# A chunk of the notes completion.
|
|
8012
|
+
# @return [String]
|
|
8013
|
+
#
|
|
8014
|
+
# @!attribute [rw] next_chunk_token
|
|
8015
|
+
# The token for the next chunk of notes data.
|
|
8016
|
+
# @return [String]
|
|
8017
|
+
#
|
|
8018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotesChunkDataDetails AWS API Documentation
|
|
8019
|
+
#
|
|
8020
|
+
class NotesChunkDataDetails < Struct.new(
|
|
8021
|
+
:completion,
|
|
8022
|
+
:next_chunk_token)
|
|
8023
|
+
SENSITIVE = [:completion]
|
|
8024
|
+
include Aws::Structure
|
|
8025
|
+
end
|
|
8026
|
+
|
|
8027
|
+
# Details about notes data.
|
|
8028
|
+
#
|
|
8029
|
+
# @!attribute [rw] completion
|
|
8030
|
+
# The completion data for notes.
|
|
8031
|
+
# @return [String]
|
|
8032
|
+
#
|
|
8033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/NotesDataDetails AWS API Documentation
|
|
8034
|
+
#
|
|
8035
|
+
class NotesDataDetails < Struct.new(
|
|
8036
|
+
:completion)
|
|
8037
|
+
SENSITIVE = [:completion]
|
|
8038
|
+
include Aws::Structure
|
|
8039
|
+
end
|
|
8040
|
+
|
|
8041
|
+
# An error occurred when creating a recommendation.
|
|
7483
8042
|
#
|
|
7484
8043
|
# @!attribute [rw] recommendation_id
|
|
7485
8044
|
# The identifier of the recommendation that is in error.
|
|
@@ -7570,6 +8129,61 @@ module Aws::QConnect
|
|
|
7570
8129
|
class Unknown < OrCondition; end
|
|
7571
8130
|
end
|
|
7572
8131
|
|
|
8132
|
+
# The configuration for AI Agents of type `ORCHESTRATION`.
|
|
8133
|
+
#
|
|
8134
|
+
# @!attribute [rw] orchestration_ai_prompt_id
|
|
8135
|
+
# The AI Prompt identifier used by the Orchestration AI Agent.
|
|
8136
|
+
# @return [String]
|
|
8137
|
+
#
|
|
8138
|
+
# @!attribute [rw] orchestration_ai_guardrail_id
|
|
8139
|
+
# The AI Guardrail identifier used by the Orchestration AI Agent.
|
|
8140
|
+
# @return [String]
|
|
8141
|
+
#
|
|
8142
|
+
# @!attribute [rw] tool_configurations
|
|
8143
|
+
# The tool configurations used by the Orchestration AI Agent.
|
|
8144
|
+
# @return [Array<Types::ToolConfiguration>]
|
|
8145
|
+
#
|
|
8146
|
+
# @!attribute [rw] connect_instance_arn
|
|
8147
|
+
# The Amazon Resource Name (ARN) of the Amazon Connect instance used
|
|
8148
|
+
# by the Orchestration AI Agent.
|
|
8149
|
+
# @return [String]
|
|
8150
|
+
#
|
|
8151
|
+
# @!attribute [rw] locale
|
|
8152
|
+
# The locale setting for the Orchestration AI Agent.
|
|
8153
|
+
# @return [String]
|
|
8154
|
+
#
|
|
8155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/OrchestrationAIAgentConfiguration AWS API Documentation
|
|
8156
|
+
#
|
|
8157
|
+
class OrchestrationAIAgentConfiguration < Struct.new(
|
|
8158
|
+
:orchestration_ai_prompt_id,
|
|
8159
|
+
:orchestration_ai_guardrail_id,
|
|
8160
|
+
:tool_configurations,
|
|
8161
|
+
:connect_instance_arn,
|
|
8162
|
+
:locale)
|
|
8163
|
+
SENSITIVE = []
|
|
8164
|
+
include Aws::Structure
|
|
8165
|
+
end
|
|
8166
|
+
|
|
8167
|
+
# An entry in the orchestrator configuration list.
|
|
8168
|
+
#
|
|
8169
|
+
# @!attribute [rw] ai_agent_id
|
|
8170
|
+
# The identifier of the AI Agent in the orchestrator configuration.
|
|
8171
|
+
# @return [String]
|
|
8172
|
+
#
|
|
8173
|
+
# @!attribute [rw] orchestrator_use_case
|
|
8174
|
+
# The use case for the orchestrator configuration. (for example
|
|
8175
|
+
# Connect.SelfService, Connect.AgentAssistance)
|
|
8176
|
+
# @return [String]
|
|
8177
|
+
#
|
|
8178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/OrchestratorConfigurationEntry AWS API Documentation
|
|
8179
|
+
#
|
|
8180
|
+
class OrchestratorConfigurationEntry < Struct.new(
|
|
8181
|
+
:ai_agent_id,
|
|
8182
|
+
:orchestrator_use_case)
|
|
8183
|
+
SENSITIVE = []
|
|
8184
|
+
include Aws::Structure
|
|
8185
|
+
end
|
|
8186
|
+
|
|
7573
8187
|
# Settings for parsing document contents. By default, the service
|
|
7574
8188
|
# converts the contents of each document into text before splitting it
|
|
7575
8189
|
# into chunks. To improve processing of PDF files with tables and
|
|
@@ -7622,6 +8236,352 @@ module Aws::QConnect
|
|
|
7622
8236
|
include Aws::Structure
|
|
7623
8237
|
end
|
|
7624
8238
|
|
|
8239
|
+
# The content of the push message template that applies to ADM (Amazon
|
|
8240
|
+
# Device Messaging) notification service.
|
|
8241
|
+
#
|
|
8242
|
+
# @!attribute [rw] title
|
|
8243
|
+
# The title to use in a push notification that's based on the message
|
|
8244
|
+
# template. This title appears above the notification message on a
|
|
8245
|
+
# recipient's device.
|
|
8246
|
+
# @return [String]
|
|
8247
|
+
#
|
|
8248
|
+
# @!attribute [rw] body
|
|
8249
|
+
# The message body to use in a push notification that is based on the
|
|
8250
|
+
# message template.
|
|
8251
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8252
|
+
#
|
|
8253
|
+
# @!attribute [rw] action
|
|
8254
|
+
# The action to occur if a recipient taps a push notification that is
|
|
8255
|
+
# based on the message template. Valid values are:
|
|
8256
|
+
#
|
|
8257
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
8258
|
+
# was sent to the background. This is the default action.
|
|
8259
|
+
#
|
|
8260
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
8261
|
+
# interface in the app. This action uses the deep-linking features
|
|
8262
|
+
# of the Android platform.
|
|
8263
|
+
#
|
|
8264
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
8265
|
+
# opens and loads the web page at a URL that you specify.
|
|
8266
|
+
# @return [String]
|
|
8267
|
+
#
|
|
8268
|
+
# @!attribute [rw] sound
|
|
8269
|
+
# The sound to play when a recipient receives a push notification
|
|
8270
|
+
# that's based on the message template. You can use the default
|
|
8271
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
8272
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
8273
|
+
# `/res/raw/`.
|
|
8274
|
+
# @return [String]
|
|
8275
|
+
#
|
|
8276
|
+
# @!attribute [rw] url
|
|
8277
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
8278
|
+
# recipient taps a push notification that's based on the message
|
|
8279
|
+
# template and the value of the `action` property is `URL`.
|
|
8280
|
+
# @return [String]
|
|
8281
|
+
#
|
|
8282
|
+
# @!attribute [rw] image_url
|
|
8283
|
+
# The URL of an image to display in a push notification that's based
|
|
8284
|
+
# on the message template.
|
|
8285
|
+
# @return [String]
|
|
8286
|
+
#
|
|
8287
|
+
# @!attribute [rw] image_icon_url
|
|
8288
|
+
# The URL of the large icon image to display in the content view of a
|
|
8289
|
+
# push notification that's based on the message template.
|
|
8290
|
+
# @return [String]
|
|
8291
|
+
#
|
|
8292
|
+
# @!attribute [rw] small_image_icon_url
|
|
8293
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8294
|
+
# content view of a push notification that's based on the message
|
|
8295
|
+
# template.
|
|
8296
|
+
# @return [String]
|
|
8297
|
+
#
|
|
8298
|
+
# @!attribute [rw] raw_content
|
|
8299
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8300
|
+
# content view of a push notification that's based on the message
|
|
8301
|
+
# template.
|
|
8302
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8303
|
+
#
|
|
8304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushADMMessageTemplateContent AWS API Documentation
|
|
8305
|
+
#
|
|
8306
|
+
class PushADMMessageTemplateContent < Struct.new(
|
|
8307
|
+
:title,
|
|
8308
|
+
:body,
|
|
8309
|
+
:action,
|
|
8310
|
+
:sound,
|
|
8311
|
+
:url,
|
|
8312
|
+
:image_url,
|
|
8313
|
+
:image_icon_url,
|
|
8314
|
+
:small_image_icon_url,
|
|
8315
|
+
:raw_content)
|
|
8316
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
8317
|
+
include Aws::Structure
|
|
8318
|
+
end
|
|
8319
|
+
|
|
8320
|
+
# The content of the push message template that applies to APNS (Apple
|
|
8321
|
+
# Push Notification service) notification service.
|
|
8322
|
+
#
|
|
8323
|
+
# @!attribute [rw] title
|
|
8324
|
+
# The title to use in a push notification that's based on the message
|
|
8325
|
+
# template. This title appears above the notification message on a
|
|
8326
|
+
# recipient's device.
|
|
8327
|
+
# @return [String]
|
|
8328
|
+
#
|
|
8329
|
+
# @!attribute [rw] body
|
|
8330
|
+
# The message body to use in a push notification that is based on the
|
|
8331
|
+
# message template.
|
|
8332
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8333
|
+
#
|
|
8334
|
+
# @!attribute [rw] action
|
|
8335
|
+
# The action to occur if a recipient taps a push notification that is
|
|
8336
|
+
# based on the message template. Valid values are:
|
|
8337
|
+
#
|
|
8338
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
8339
|
+
# was sent to the background. This is the default action.
|
|
8340
|
+
#
|
|
8341
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
8342
|
+
# interface in the app. This action uses the deep-linking features
|
|
8343
|
+
# of the iOS platform.
|
|
8344
|
+
#
|
|
8345
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
8346
|
+
# opens and loads the web page at a URL that you specify.
|
|
8347
|
+
# @return [String]
|
|
8348
|
+
#
|
|
8349
|
+
# @!attribute [rw] sound
|
|
8350
|
+
# The key for the sound to play when the recipient receives a push
|
|
8351
|
+
# notification that's based on the message template. The value for
|
|
8352
|
+
# this key is the name of a sound file in your app's main bundle or
|
|
8353
|
+
# the `Library/Sounds` folder in your app's data container. If the
|
|
8354
|
+
# sound file can't be found or you specify `default` for the value,
|
|
8355
|
+
# the system plays the default alert sound.
|
|
8356
|
+
# @return [String]
|
|
8357
|
+
#
|
|
8358
|
+
# @!attribute [rw] url
|
|
8359
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
8360
|
+
# recipient taps a push notification that's based on the message
|
|
8361
|
+
# template and the value of the `action` property is `URL`.
|
|
8362
|
+
# @return [String]
|
|
8363
|
+
#
|
|
8364
|
+
# @!attribute [rw] media_url
|
|
8365
|
+
# The URL of an image or video to display in push notifications that
|
|
8366
|
+
# are based on the message template.
|
|
8367
|
+
# @return [String]
|
|
8368
|
+
#
|
|
8369
|
+
# @!attribute [rw] raw_content
|
|
8370
|
+
# The raw, JSON-formatted string to use as the payload for a push
|
|
8371
|
+
# notification that's based on the message template. If specified,
|
|
8372
|
+
# this value overrides all other content for the message template.
|
|
8373
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8374
|
+
#
|
|
8375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushAPNSMessageTemplateContent AWS API Documentation
|
|
8376
|
+
#
|
|
8377
|
+
class PushAPNSMessageTemplateContent < Struct.new(
|
|
8378
|
+
:title,
|
|
8379
|
+
:body,
|
|
8380
|
+
:action,
|
|
8381
|
+
:sound,
|
|
8382
|
+
:url,
|
|
8383
|
+
:media_url,
|
|
8384
|
+
:raw_content)
|
|
8385
|
+
SENSITIVE = [:title, :sound, :url, :media_url]
|
|
8386
|
+
include Aws::Structure
|
|
8387
|
+
end
|
|
8388
|
+
|
|
8389
|
+
# The content of the push message template that applies to Baidu
|
|
8390
|
+
# notification service.
|
|
8391
|
+
#
|
|
8392
|
+
# @!attribute [rw] title
|
|
8393
|
+
# The title to use in a push notification that's based on the message
|
|
8394
|
+
# template. This title appears above the notification message on a
|
|
8395
|
+
# recipient's device.
|
|
8396
|
+
# @return [String]
|
|
8397
|
+
#
|
|
8398
|
+
# @!attribute [rw] body
|
|
8399
|
+
# The message body to use in a push notification that is based on the
|
|
8400
|
+
# message template.
|
|
8401
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8402
|
+
#
|
|
8403
|
+
# @!attribute [rw] action
|
|
8404
|
+
# The action to occur if a recipient taps a push notification that is
|
|
8405
|
+
# based on the message template. Valid values are:
|
|
8406
|
+
#
|
|
8407
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
8408
|
+
# was sent to the background. This is the default action.
|
|
8409
|
+
#
|
|
8410
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
8411
|
+
# interface in the app. This action uses the deep-linking features
|
|
8412
|
+
# of the Android platform.
|
|
8413
|
+
#
|
|
8414
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
8415
|
+
# opens and loads the web page at a URL that you specify.
|
|
8416
|
+
# @return [String]
|
|
8417
|
+
#
|
|
8418
|
+
# @!attribute [rw] sound
|
|
8419
|
+
# The sound to play when a recipient receives a push notification
|
|
8420
|
+
# that's based on the message template. You can use the default
|
|
8421
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
8422
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
8423
|
+
# `/res/raw/`.
|
|
8424
|
+
# @return [String]
|
|
8425
|
+
#
|
|
8426
|
+
# @!attribute [rw] url
|
|
8427
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
8428
|
+
# recipient taps a push notification that's based on the message
|
|
8429
|
+
# template and the value of the `action` property is `URL`.
|
|
8430
|
+
# @return [String]
|
|
8431
|
+
#
|
|
8432
|
+
# @!attribute [rw] image_url
|
|
8433
|
+
# The URL of an image to display in a push notification that's based
|
|
8434
|
+
# on the message template.
|
|
8435
|
+
# @return [String]
|
|
8436
|
+
#
|
|
8437
|
+
# @!attribute [rw] image_icon_url
|
|
8438
|
+
# The URL of the large icon image to display in the content view of a
|
|
8439
|
+
# push notification that's based on the message template.
|
|
8440
|
+
# @return [String]
|
|
8441
|
+
#
|
|
8442
|
+
# @!attribute [rw] small_image_icon_url
|
|
8443
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8444
|
+
# content view of a push notification that's based on the message
|
|
8445
|
+
# template.
|
|
8446
|
+
# @return [String]
|
|
8447
|
+
#
|
|
8448
|
+
# @!attribute [rw] raw_content
|
|
8449
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8450
|
+
# content view of a push notification that's based on the message
|
|
8451
|
+
# template.
|
|
8452
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8453
|
+
#
|
|
8454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushBaiduMessageTemplateContent AWS API Documentation
|
|
8455
|
+
#
|
|
8456
|
+
class PushBaiduMessageTemplateContent < Struct.new(
|
|
8457
|
+
:title,
|
|
8458
|
+
:body,
|
|
8459
|
+
:action,
|
|
8460
|
+
:sound,
|
|
8461
|
+
:url,
|
|
8462
|
+
:image_url,
|
|
8463
|
+
:image_icon_url,
|
|
8464
|
+
:small_image_icon_url,
|
|
8465
|
+
:raw_content)
|
|
8466
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
8467
|
+
include Aws::Structure
|
|
8468
|
+
end
|
|
8469
|
+
|
|
8470
|
+
# The content of the push message template that applies to FCM (Firebase
|
|
8471
|
+
# Cloud Messaging) notification service.
|
|
8472
|
+
#
|
|
8473
|
+
# @!attribute [rw] title
|
|
8474
|
+
# The title to use in a push notification that's based on the message
|
|
8475
|
+
# template. This title appears above the notification message on a
|
|
8476
|
+
# recipient's device.
|
|
8477
|
+
# @return [String]
|
|
8478
|
+
#
|
|
8479
|
+
# @!attribute [rw] body
|
|
8480
|
+
# The message body to use in a push notification that is based on the
|
|
8481
|
+
# message template.
|
|
8482
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8483
|
+
#
|
|
8484
|
+
# @!attribute [rw] action
|
|
8485
|
+
# The action to occur if a recipient taps a push notification that is
|
|
8486
|
+
# based on the message template. Valid values are:
|
|
8487
|
+
#
|
|
8488
|
+
# * `OPEN_APP` - Your app opens or it becomes the foreground app if it
|
|
8489
|
+
# was sent to the background. This is the default action.
|
|
8490
|
+
#
|
|
8491
|
+
# * `DEEP_LINK` - Your app opens and displays a designated user
|
|
8492
|
+
# interface in the app. This action uses the deep-linking features
|
|
8493
|
+
# of the Android platform.
|
|
8494
|
+
#
|
|
8495
|
+
# * `URL` - The default mobile browser on the recipient's device
|
|
8496
|
+
# opens and loads the web page at a URL that you specify.
|
|
8497
|
+
# @return [String]
|
|
8498
|
+
#
|
|
8499
|
+
# @!attribute [rw] sound
|
|
8500
|
+
# The sound to play when a recipient receives a push notification
|
|
8501
|
+
# that's based on the message template. You can use the default
|
|
8502
|
+
# stream or specify the file name of a sound resource that's bundled
|
|
8503
|
+
# in your app. On an Android platform, the sound file must reside in
|
|
8504
|
+
# `/res/raw/`.
|
|
8505
|
+
# @return [String]
|
|
8506
|
+
#
|
|
8507
|
+
# @!attribute [rw] url
|
|
8508
|
+
# The URL to open in a recipient's default mobile browser, if a
|
|
8509
|
+
# recipient taps a push notification that's based on the message
|
|
8510
|
+
# template and the value of the `action` property is `URL`.
|
|
8511
|
+
# @return [String]
|
|
8512
|
+
#
|
|
8513
|
+
# @!attribute [rw] image_url
|
|
8514
|
+
# The URL of an image to display in a push notification that's based
|
|
8515
|
+
# on the message template.
|
|
8516
|
+
# @return [String]
|
|
8517
|
+
#
|
|
8518
|
+
# @!attribute [rw] image_icon_url
|
|
8519
|
+
# The URL of the large icon image to display in the content view of a
|
|
8520
|
+
# push notification that's based on the message template.
|
|
8521
|
+
# @return [String]
|
|
8522
|
+
#
|
|
8523
|
+
# @!attribute [rw] small_image_icon_url
|
|
8524
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8525
|
+
# content view of a push notification that's based on the message
|
|
8526
|
+
# template.
|
|
8527
|
+
# @return [String]
|
|
8528
|
+
#
|
|
8529
|
+
# @!attribute [rw] raw_content
|
|
8530
|
+
# The URL of the small icon image to display in the status bar and the
|
|
8531
|
+
# content view of a push notification that's based on the message
|
|
8532
|
+
# template.
|
|
8533
|
+
# @return [Types::MessageTemplateBodyContentProvider]
|
|
8534
|
+
#
|
|
8535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushFCMMessageTemplateContent AWS API Documentation
|
|
8536
|
+
#
|
|
8537
|
+
class PushFCMMessageTemplateContent < Struct.new(
|
|
8538
|
+
:title,
|
|
8539
|
+
:body,
|
|
8540
|
+
:action,
|
|
8541
|
+
:sound,
|
|
8542
|
+
:url,
|
|
8543
|
+
:image_url,
|
|
8544
|
+
:image_icon_url,
|
|
8545
|
+
:small_image_icon_url,
|
|
8546
|
+
:raw_content)
|
|
8547
|
+
SENSITIVE = [:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]
|
|
8548
|
+
include Aws::Structure
|
|
8549
|
+
end
|
|
8550
|
+
|
|
8551
|
+
# The content of the message template that applies to the push channel
|
|
8552
|
+
# subtype.
|
|
8553
|
+
#
|
|
8554
|
+
# @!attribute [rw] adm
|
|
8555
|
+
# The content of the message template that applies to ADM (Amazon
|
|
8556
|
+
# Device Messaging) notification service.
|
|
8557
|
+
# @return [Types::PushADMMessageTemplateContent]
|
|
8558
|
+
#
|
|
8559
|
+
# @!attribute [rw] apns
|
|
8560
|
+
# The content of the message template that applies to APNS(Apple Push
|
|
8561
|
+
# Notification service) notification service.
|
|
8562
|
+
# @return [Types::PushAPNSMessageTemplateContent]
|
|
8563
|
+
#
|
|
8564
|
+
# @!attribute [rw] fcm
|
|
8565
|
+
# The content of the message template that applies to FCM (Firebase
|
|
8566
|
+
# Cloud Messaging) notification service.
|
|
8567
|
+
# @return [Types::PushFCMMessageTemplateContent]
|
|
8568
|
+
#
|
|
8569
|
+
# @!attribute [rw] baidu
|
|
8570
|
+
# The content of the message template that applies to Baidu
|
|
8571
|
+
# notification service.
|
|
8572
|
+
# @return [Types::PushBaiduMessageTemplateContent]
|
|
8573
|
+
#
|
|
8574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/PushMessageTemplateContent AWS API Documentation
|
|
8575
|
+
#
|
|
8576
|
+
class PushMessageTemplateContent < Struct.new(
|
|
8577
|
+
:adm,
|
|
8578
|
+
:apns,
|
|
8579
|
+
:fcm,
|
|
8580
|
+
:baidu)
|
|
8581
|
+
SENSITIVE = []
|
|
8582
|
+
include Aws::Structure
|
|
8583
|
+
end
|
|
8584
|
+
|
|
7625
8585
|
# @!attribute [rw] assistant_id
|
|
7626
8586
|
# The identifier of the Amazon Q in Connect assistant.
|
|
7627
8587
|
# @return [String]
|
|
@@ -7809,11 +8769,16 @@ module Aws::QConnect
|
|
|
7809
8769
|
# Input information for the intent.
|
|
7810
8770
|
# @return [Types::IntentInputData]
|
|
7811
8771
|
#
|
|
8772
|
+
# @!attribute [rw] case_summarization_input_data
|
|
8773
|
+
# Input data for case summarization queries.
|
|
8774
|
+
# @return [Types::CaseSummarizationInputData]
|
|
8775
|
+
#
|
|
7812
8776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryInputData AWS API Documentation
|
|
7813
8777
|
#
|
|
7814
8778
|
class QueryInputData < Struct.new(
|
|
7815
8779
|
:query_text_input_data,
|
|
7816
8780
|
:intent_input_data,
|
|
8781
|
+
:case_summarization_input_data,
|
|
7817
8782
|
:unknown)
|
|
7818
8783
|
SENSITIVE = []
|
|
7819
8784
|
include Aws::Structure
|
|
@@ -7821,6 +8786,7 @@ module Aws::QConnect
|
|
|
7821
8786
|
|
|
7822
8787
|
class QueryTextInputData < QueryInputData; end
|
|
7823
8788
|
class IntentInputData < QueryInputData; end
|
|
8789
|
+
class CaseSummarizationInputData < QueryInputData; end
|
|
7824
8790
|
class Unknown < QueryInputData; end
|
|
7825
8791
|
end
|
|
7826
8792
|
|
|
@@ -8549,11 +9515,16 @@ module Aws::QConnect
|
|
|
8549
9515
|
# Amazon Q in Connect Assistant.
|
|
8550
9516
|
# @return [String]
|
|
8551
9517
|
#
|
|
9518
|
+
# @!attribute [rw] orchestrator_use_case
|
|
9519
|
+
# The orchestrator use case for the AI Agent being removed.
|
|
9520
|
+
# @return [String]
|
|
9521
|
+
#
|
|
8552
9522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveAssistantAIAgentRequest AWS API Documentation
|
|
8553
9523
|
#
|
|
8554
9524
|
class RemoveAssistantAIAgentRequest < Struct.new(
|
|
8555
9525
|
:assistant_id,
|
|
8556
|
-
:ai_agent_type
|
|
9526
|
+
:ai_agent_type,
|
|
9527
|
+
:orchestrator_use_case)
|
|
8557
9528
|
SENSITIVE = []
|
|
8558
9529
|
include Aws::Structure
|
|
8559
9530
|
end
|
|
@@ -8611,6 +9582,10 @@ module Aws::QConnect
|
|
|
8611
9582
|
# The content of the message template.
|
|
8612
9583
|
# @return [Types::MessageTemplateContentProvider]
|
|
8613
9584
|
#
|
|
9585
|
+
# @!attribute [rw] source_configuration_summary
|
|
9586
|
+
# The source configuration of the message template.
|
|
9587
|
+
# @return [Types::MessageTemplateSourceConfigurationSummary]
|
|
9588
|
+
#
|
|
8614
9589
|
# @!attribute [rw] attributes_not_interpolated
|
|
8615
9590
|
# The attribute keys that are not resolved.
|
|
8616
9591
|
# @return [Array<String>]
|
|
@@ -8623,6 +9598,7 @@ module Aws::QConnect
|
|
|
8623
9598
|
#
|
|
8624
9599
|
class RenderMessageTemplateResponse < Struct.new(
|
|
8625
9600
|
:content,
|
|
9601
|
+
:source_configuration_summary,
|
|
8626
9602
|
:attributes_not_interpolated,
|
|
8627
9603
|
:attachments)
|
|
8628
9604
|
SENSITIVE = [:attributes_not_interpolated]
|
|
@@ -8729,50 +9705,239 @@ module Aws::QConnect
|
|
|
8729
9705
|
include Aws::Structure
|
|
8730
9706
|
end
|
|
8731
9707
|
|
|
8732
|
-
#
|
|
9708
|
+
# Configuration for content retrieval operations.
|
|
8733
9709
|
#
|
|
8734
|
-
# @!attribute [rw]
|
|
8735
|
-
# The
|
|
8736
|
-
# @return [
|
|
9710
|
+
# @!attribute [rw] knowledge_source
|
|
9711
|
+
# The knowledge source configuration for content retrieval.
|
|
9712
|
+
# @return [Types::KnowledgeSource]
|
|
8737
9713
|
#
|
|
8738
|
-
# @!attribute [rw]
|
|
8739
|
-
# The
|
|
8740
|
-
# @return [Types::
|
|
9714
|
+
# @!attribute [rw] filter
|
|
9715
|
+
# The filter configuration for content retrieval.
|
|
9716
|
+
# @return [Types::RetrievalFilterConfiguration]
|
|
8741
9717
|
#
|
|
8742
|
-
#
|
|
9718
|
+
# @!attribute [rw] number_of_results
|
|
9719
|
+
# The number of results to retrieve.
|
|
9720
|
+
# @return [Integer]
|
|
8743
9721
|
#
|
|
8744
|
-
|
|
8745
|
-
|
|
8746
|
-
|
|
8747
|
-
|
|
9722
|
+
# @!attribute [rw] override_knowledge_base_search_type
|
|
9723
|
+
# Override setting for the knowledge base search type during
|
|
9724
|
+
# retrieval.
|
|
9725
|
+
# @return [String]
|
|
9726
|
+
#
|
|
9727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RetrievalConfiguration AWS API Documentation
|
|
9728
|
+
#
|
|
9729
|
+
class RetrievalConfiguration < Struct.new(
|
|
9730
|
+
:knowledge_source,
|
|
9731
|
+
:filter,
|
|
9732
|
+
:number_of_results,
|
|
9733
|
+
:override_knowledge_base_search_type)
|
|
9734
|
+
SENSITIVE = []
|
|
8748
9735
|
include Aws::Structure
|
|
8749
9736
|
end
|
|
8750
9737
|
|
|
8751
|
-
#
|
|
9738
|
+
# Configuration for filtering content during retrieval operations.
|
|
8752
9739
|
#
|
|
8753
|
-
# @note
|
|
9740
|
+
# @note RetrievalFilterConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
8754
9741
|
#
|
|
8755
|
-
#
|
|
9742
|
+
# @!attribute [rw] and_all
|
|
9743
|
+
# Filter configuration that requires all conditions to be met.
|
|
9744
|
+
# @return [Array<Types::RetrievalFilterConfiguration>]
|
|
8756
9745
|
#
|
|
8757
|
-
# @!attribute [rw]
|
|
8758
|
-
#
|
|
8759
|
-
# @return [
|
|
9746
|
+
# @!attribute [rw] equals
|
|
9747
|
+
# Filter configuration for exact equality matching.
|
|
9748
|
+
# @return [Types::FilterAttribute]
|
|
8760
9749
|
#
|
|
8761
|
-
#
|
|
9750
|
+
# @!attribute [rw] greater_than
|
|
9751
|
+
# Filter configuration for greater than comparison.
|
|
9752
|
+
# @return [Types::FilterAttribute]
|
|
8762
9753
|
#
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
|
|
8766
|
-
|
|
8767
|
-
|
|
8768
|
-
|
|
8769
|
-
|
|
8770
|
-
|
|
8771
|
-
|
|
8772
|
-
|
|
8773
|
-
|
|
8774
|
-
#
|
|
8775
|
-
#
|
|
9754
|
+
# @!attribute [rw] greater_than_or_equals
|
|
9755
|
+
# Filter configuration for greater than or equal comparison.
|
|
9756
|
+
# @return [Types::FilterAttribute]
|
|
9757
|
+
#
|
|
9758
|
+
# @!attribute [rw] in
|
|
9759
|
+
# Filter configuration for membership in a set of values.
|
|
9760
|
+
# @return [Types::FilterAttribute]
|
|
9761
|
+
#
|
|
9762
|
+
# @!attribute [rw] less_than
|
|
9763
|
+
# Filter configuration for less than comparison.
|
|
9764
|
+
# @return [Types::FilterAttribute]
|
|
9765
|
+
#
|
|
9766
|
+
# @!attribute [rw] less_than_or_equals
|
|
9767
|
+
# Filter configuration for less than or equal comparison.
|
|
9768
|
+
# @return [Types::FilterAttribute]
|
|
9769
|
+
#
|
|
9770
|
+
# @!attribute [rw] list_contains
|
|
9771
|
+
# Filter configuration for checking if a list contains a value.
|
|
9772
|
+
# @return [Types::FilterAttribute]
|
|
9773
|
+
#
|
|
9774
|
+
# @!attribute [rw] not_equals
|
|
9775
|
+
# Filter configuration for inequality matching.
|
|
9776
|
+
# @return [Types::FilterAttribute]
|
|
9777
|
+
#
|
|
9778
|
+
# @!attribute [rw] not_in
|
|
9779
|
+
# Filter configuration for exclusion from a set of values.
|
|
9780
|
+
# @return [Types::FilterAttribute]
|
|
9781
|
+
#
|
|
9782
|
+
# @!attribute [rw] or_all
|
|
9783
|
+
# Filter configuration where any condition can be met.
|
|
9784
|
+
# @return [Array<Types::RetrievalFilterConfiguration>]
|
|
9785
|
+
#
|
|
9786
|
+
# @!attribute [rw] starts_with
|
|
9787
|
+
# Filter configuration for prefix matching.
|
|
9788
|
+
# @return [Types::FilterAttribute]
|
|
9789
|
+
#
|
|
9790
|
+
# @!attribute [rw] string_contains
|
|
9791
|
+
# Filter configuration for substring matching.
|
|
9792
|
+
# @return [Types::FilterAttribute]
|
|
9793
|
+
#
|
|
9794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RetrievalFilterConfiguration AWS API Documentation
|
|
9795
|
+
#
|
|
9796
|
+
class RetrievalFilterConfiguration < Struct.new(
|
|
9797
|
+
:and_all,
|
|
9798
|
+
:equals,
|
|
9799
|
+
:greater_than,
|
|
9800
|
+
:greater_than_or_equals,
|
|
9801
|
+
:in,
|
|
9802
|
+
:less_than,
|
|
9803
|
+
:less_than_or_equals,
|
|
9804
|
+
:list_contains,
|
|
9805
|
+
:not_equals,
|
|
9806
|
+
:not_in,
|
|
9807
|
+
:or_all,
|
|
9808
|
+
:starts_with,
|
|
9809
|
+
:string_contains,
|
|
9810
|
+
:unknown)
|
|
9811
|
+
SENSITIVE = []
|
|
9812
|
+
include Aws::Structure
|
|
9813
|
+
include Aws::Structure::Union
|
|
9814
|
+
|
|
9815
|
+
class AndAll < RetrievalFilterConfiguration; end
|
|
9816
|
+
class Equals < RetrievalFilterConfiguration; end
|
|
9817
|
+
class GreaterThan < RetrievalFilterConfiguration; end
|
|
9818
|
+
class GreaterThanOrEquals < RetrievalFilterConfiguration; end
|
|
9819
|
+
class In < RetrievalFilterConfiguration; end
|
|
9820
|
+
class LessThan < RetrievalFilterConfiguration; end
|
|
9821
|
+
class LessThanOrEquals < RetrievalFilterConfiguration; end
|
|
9822
|
+
class ListContains < RetrievalFilterConfiguration; end
|
|
9823
|
+
class NotEquals < RetrievalFilterConfiguration; end
|
|
9824
|
+
class NotIn < RetrievalFilterConfiguration; end
|
|
9825
|
+
class OrAll < RetrievalFilterConfiguration; end
|
|
9826
|
+
class StartsWith < RetrievalFilterConfiguration; end
|
|
9827
|
+
class StringContains < RetrievalFilterConfiguration; end
|
|
9828
|
+
class Unknown < RetrievalFilterConfiguration; end
|
|
9829
|
+
end
|
|
9830
|
+
|
|
9831
|
+
# @!attribute [rw] assistant_id
|
|
9832
|
+
# The identifier of the Amazon Q in Connect assistant for content
|
|
9833
|
+
# retrieval.
|
|
9834
|
+
# @return [String]
|
|
9835
|
+
#
|
|
9836
|
+
# @!attribute [rw] retrieval_configuration
|
|
9837
|
+
# The configuration for the content retrieval operation.
|
|
9838
|
+
# @return [Types::RetrievalConfiguration]
|
|
9839
|
+
#
|
|
9840
|
+
# @!attribute [rw] retrieval_query
|
|
9841
|
+
# The query for content retrieval.
|
|
9842
|
+
# @return [String]
|
|
9843
|
+
#
|
|
9844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RetrieveRequest AWS API Documentation
|
|
9845
|
+
#
|
|
9846
|
+
class RetrieveRequest < Struct.new(
|
|
9847
|
+
:assistant_id,
|
|
9848
|
+
:retrieval_configuration,
|
|
9849
|
+
:retrieval_query)
|
|
9850
|
+
SENSITIVE = [:retrieval_query]
|
|
9851
|
+
include Aws::Structure
|
|
9852
|
+
end
|
|
9853
|
+
|
|
9854
|
+
# @!attribute [rw] results
|
|
9855
|
+
# The results of the content retrieval operation.
|
|
9856
|
+
# @return [Array<Types::RetrieveResult>]
|
|
9857
|
+
#
|
|
9858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RetrieveResponse AWS API Documentation
|
|
9859
|
+
#
|
|
9860
|
+
class RetrieveResponse < Struct.new(
|
|
9861
|
+
:results)
|
|
9862
|
+
SENSITIVE = []
|
|
9863
|
+
include Aws::Structure
|
|
9864
|
+
end
|
|
9865
|
+
|
|
9866
|
+
# A single result from a content retrieval operation.
|
|
9867
|
+
#
|
|
9868
|
+
# @!attribute [rw] association_id
|
|
9869
|
+
# The identifier of the assistant association for the retrieved
|
|
9870
|
+
# result.
|
|
9871
|
+
# @return [String]
|
|
9872
|
+
#
|
|
9873
|
+
# @!attribute [rw] source_id
|
|
9874
|
+
# The URL, URI, or ID of the retrieved content when available, or a
|
|
9875
|
+
# UUID when unavailable.
|
|
9876
|
+
# @return [String]
|
|
9877
|
+
#
|
|
9878
|
+
# @!attribute [rw] reference_type
|
|
9879
|
+
# A type to define the KB origin of a retrieved content.
|
|
9880
|
+
# @return [String]
|
|
9881
|
+
#
|
|
9882
|
+
# @!attribute [rw] content_text
|
|
9883
|
+
# The text content of the retrieved result.
|
|
9884
|
+
# @return [String]
|
|
9885
|
+
#
|
|
9886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RetrieveResult AWS API Documentation
|
|
9887
|
+
#
|
|
9888
|
+
class RetrieveResult < Struct.new(
|
|
9889
|
+
:association_id,
|
|
9890
|
+
:source_id,
|
|
9891
|
+
:reference_type,
|
|
9892
|
+
:content_text)
|
|
9893
|
+
SENSITIVE = [:source_id, :content_text]
|
|
9894
|
+
include Aws::Structure
|
|
9895
|
+
end
|
|
9896
|
+
|
|
9897
|
+
# The list of key-value pairs that are stored on the session.
|
|
9898
|
+
#
|
|
9899
|
+
# @!attribute [rw] key
|
|
9900
|
+
# The key of the data stored on the session.
|
|
9901
|
+
# @return [String]
|
|
9902
|
+
#
|
|
9903
|
+
# @!attribute [rw] value
|
|
9904
|
+
# The value of the data stored on the session.
|
|
9905
|
+
# @return [Types::RuntimeSessionDataValue]
|
|
9906
|
+
#
|
|
9907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RuntimeSessionData AWS API Documentation
|
|
9908
|
+
#
|
|
9909
|
+
class RuntimeSessionData < Struct.new(
|
|
9910
|
+
:key,
|
|
9911
|
+
:value)
|
|
9912
|
+
SENSITIVE = [:key]
|
|
9913
|
+
include Aws::Structure
|
|
9914
|
+
end
|
|
9915
|
+
|
|
9916
|
+
# A union type that specifies the data stored on the session.
|
|
9917
|
+
#
|
|
9918
|
+
# @note RuntimeSessionDataValue is a union - when making an API calls you must set exactly one of the members.
|
|
9919
|
+
#
|
|
9920
|
+
# @note RuntimeSessionDataValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RuntimeSessionDataValue corresponding to the set member.
|
|
9921
|
+
#
|
|
9922
|
+
# @!attribute [rw] string_value
|
|
9923
|
+
# The string value of the data stored on the session.
|
|
9924
|
+
# @return [String]
|
|
9925
|
+
#
|
|
9926
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RuntimeSessionDataValue AWS API Documentation
|
|
9927
|
+
#
|
|
9928
|
+
class RuntimeSessionDataValue < Struct.new(
|
|
9929
|
+
:string_value,
|
|
9930
|
+
:unknown)
|
|
9931
|
+
SENSITIVE = [:string_value]
|
|
9932
|
+
include Aws::Structure
|
|
9933
|
+
include Aws::Structure::Union
|
|
9934
|
+
|
|
9935
|
+
class StringValue < RuntimeSessionDataValue; end
|
|
9936
|
+
class Unknown < RuntimeSessionDataValue; end
|
|
9937
|
+
end
|
|
9938
|
+
|
|
9939
|
+
# The content of the message template that applies to the SMS channel
|
|
9940
|
+
# subtype.
|
|
8776
9941
|
#
|
|
8777
9942
|
# @!attribute [rw] body
|
|
8778
9943
|
# The body to use in SMS messages.
|
|
@@ -9080,12 +10245,17 @@ module Aws::QConnect
|
|
|
9080
10245
|
# The bot response of the conversation history data.
|
|
9081
10246
|
# @return [String]
|
|
9082
10247
|
#
|
|
10248
|
+
# @!attribute [rw] timestamp
|
|
10249
|
+
# The timestamp of the conversation history entry.
|
|
10250
|
+
# @return [Time]
|
|
10251
|
+
#
|
|
9083
10252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceConversationHistory AWS API Documentation
|
|
9084
10253
|
#
|
|
9085
10254
|
class SelfServiceConversationHistory < Struct.new(
|
|
9086
10255
|
:turn_number,
|
|
9087
10256
|
:input_transcript,
|
|
9088
|
-
:bot_response
|
|
10257
|
+
:bot_response,
|
|
10258
|
+
:timestamp)
|
|
9089
10259
|
SENSITIVE = [:input_transcript, :bot_response]
|
|
9090
10260
|
include Aws::Structure
|
|
9091
10261
|
end
|
|
@@ -9133,6 +10303,10 @@ module Aws::QConnect
|
|
|
9133
10303
|
# The message data to submit to the Amazon Q in Connect session.
|
|
9134
10304
|
# @return [Types::MessageInput]
|
|
9135
10305
|
#
|
|
10306
|
+
# @!attribute [rw] ai_agent_id
|
|
10307
|
+
# The identifier of the AI Agent to use for processing the message.
|
|
10308
|
+
# @return [String]
|
|
10309
|
+
#
|
|
9136
10310
|
# @!attribute [rw] conversation_context
|
|
9137
10311
|
# The conversation context before the Amazon Q in Connect session.
|
|
9138
10312
|
# @return [Types::ConversationContext]
|
|
@@ -9155,6 +10329,14 @@ module Aws::QConnect
|
|
|
9155
10329
|
# not need to pass this option.
|
|
9156
10330
|
# @return [String]
|
|
9157
10331
|
#
|
|
10332
|
+
# @!attribute [rw] orchestrator_use_case
|
|
10333
|
+
# The orchestrator use case for message processing.
|
|
10334
|
+
# @return [String]
|
|
10335
|
+
#
|
|
10336
|
+
# @!attribute [rw] metadata
|
|
10337
|
+
# Additional metadata for the message.
|
|
10338
|
+
# @return [Hash<String,String>]
|
|
10339
|
+
#
|
|
9158
10340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageRequest AWS API Documentation
|
|
9159
10341
|
#
|
|
9160
10342
|
class SendMessageRequest < Struct.new(
|
|
@@ -9162,9 +10344,12 @@ module Aws::QConnect
|
|
|
9162
10344
|
:session_id,
|
|
9163
10345
|
:type,
|
|
9164
10346
|
:message,
|
|
10347
|
+
:ai_agent_id,
|
|
9165
10348
|
:conversation_context,
|
|
9166
10349
|
:configuration,
|
|
9167
|
-
:client_token
|
|
10350
|
+
:client_token,
|
|
10351
|
+
:orchestrator_use_case,
|
|
10352
|
+
:metadata)
|
|
9168
10353
|
SENSITIVE = []
|
|
9169
10354
|
include Aws::Structure
|
|
9170
10355
|
end
|
|
@@ -9280,6 +10465,10 @@ module Aws::QConnect
|
|
|
9280
10465
|
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_CreateSession.html
|
|
9281
10466
|
# @return [String]
|
|
9282
10467
|
#
|
|
10468
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
10469
|
+
# The list of orchestrator configurations for the session.
|
|
10470
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
10471
|
+
#
|
|
9283
10472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionData AWS API Documentation
|
|
9284
10473
|
#
|
|
9285
10474
|
class SessionData < Struct.new(
|
|
@@ -9291,7 +10480,8 @@ module Aws::QConnect
|
|
|
9291
10480
|
:integration_configuration,
|
|
9292
10481
|
:tag_filter,
|
|
9293
10482
|
:ai_agent_configuration,
|
|
9294
|
-
:origin
|
|
10483
|
+
:origin,
|
|
10484
|
+
:orchestrator_configuration_list)
|
|
9295
10485
|
SENSITIVE = []
|
|
9296
10486
|
include Aws::Structure
|
|
9297
10487
|
end
|
|
@@ -9363,44 +10553,454 @@ module Aws::QConnect
|
|
|
9363
10553
|
:unknown)
|
|
9364
10554
|
SENSITIVE = []
|
|
9365
10555
|
include Aws::Structure
|
|
9366
|
-
include Aws::Structure::Union
|
|
9367
|
-
|
|
9368
|
-
class AppIntegrations < SourceConfiguration; end
|
|
9369
|
-
class ManagedSourceConfiguration < SourceConfiguration; end
|
|
9370
|
-
class Unknown < SourceConfiguration; end
|
|
10556
|
+
include Aws::Structure::Union
|
|
10557
|
+
|
|
10558
|
+
class AppIntegrations < SourceConfiguration; end
|
|
10559
|
+
class ManagedSourceConfiguration < SourceConfiguration; end
|
|
10560
|
+
class Unknown < SourceConfiguration; end
|
|
10561
|
+
end
|
|
10562
|
+
|
|
10563
|
+
# Details about the source content data.
|
|
10564
|
+
#
|
|
10565
|
+
# @!attribute [rw] id
|
|
10566
|
+
# The identifier of the source content.
|
|
10567
|
+
# @return [String]
|
|
10568
|
+
#
|
|
10569
|
+
# @!attribute [rw] type
|
|
10570
|
+
# The type of the source content.
|
|
10571
|
+
# @return [String]
|
|
10572
|
+
#
|
|
10573
|
+
# @!attribute [rw] text_data
|
|
10574
|
+
# Details about the source content text data.
|
|
10575
|
+
# @return [Types::TextData]
|
|
10576
|
+
#
|
|
10577
|
+
# @!attribute [rw] ranking_data
|
|
10578
|
+
# Details about the source content ranking data.
|
|
10579
|
+
# @return [Types::RankingData]
|
|
10580
|
+
#
|
|
10581
|
+
# @!attribute [rw] citation_span
|
|
10582
|
+
# Contains information about where the text with a citation begins and
|
|
10583
|
+
# ends in the generated output.
|
|
10584
|
+
# @return [Types::CitationSpan]
|
|
10585
|
+
#
|
|
10586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SourceContentDataDetails AWS API Documentation
|
|
10587
|
+
#
|
|
10588
|
+
class SourceContentDataDetails < Struct.new(
|
|
10589
|
+
:id,
|
|
10590
|
+
:type,
|
|
10591
|
+
:text_data,
|
|
10592
|
+
:ranking_data,
|
|
10593
|
+
:citation_span)
|
|
10594
|
+
SENSITIVE = []
|
|
10595
|
+
include Aws::Structure
|
|
10596
|
+
end
|
|
10597
|
+
|
|
10598
|
+
# A span represents a unit of work during AI agent execution, capturing
|
|
10599
|
+
# timing, status, and contextual attributes.
|
|
10600
|
+
#
|
|
10601
|
+
# @!attribute [rw] span_id
|
|
10602
|
+
# Unique span identifier
|
|
10603
|
+
# @return [String]
|
|
10604
|
+
#
|
|
10605
|
+
# @!attribute [rw] assistant_id
|
|
10606
|
+
# UUID of the Connect AI Assistant resource
|
|
10607
|
+
# @return [String]
|
|
10608
|
+
#
|
|
10609
|
+
# @!attribute [rw] session_id
|
|
10610
|
+
# UUID of the Connect AI Session resource
|
|
10611
|
+
# @return [String]
|
|
10612
|
+
#
|
|
10613
|
+
# @!attribute [rw] parent_span_id
|
|
10614
|
+
# Parent span identifier for hierarchy. Null for root spans.
|
|
10615
|
+
# @return [String]
|
|
10616
|
+
#
|
|
10617
|
+
# @!attribute [rw] span_name
|
|
10618
|
+
# Service-defined operation name
|
|
10619
|
+
# @return [String]
|
|
10620
|
+
#
|
|
10621
|
+
# @!attribute [rw] span_type
|
|
10622
|
+
# Operation relationship type
|
|
10623
|
+
# @return [String]
|
|
10624
|
+
#
|
|
10625
|
+
# @!attribute [rw] start_timestamp
|
|
10626
|
+
# Operation start time in milliseconds since epoch
|
|
10627
|
+
# @return [Time]
|
|
10628
|
+
#
|
|
10629
|
+
# @!attribute [rw] end_timestamp
|
|
10630
|
+
# Operation end time in milliseconds since epoch
|
|
10631
|
+
# @return [Time]
|
|
10632
|
+
#
|
|
10633
|
+
# @!attribute [rw] status
|
|
10634
|
+
# Span completion status
|
|
10635
|
+
# @return [String]
|
|
10636
|
+
#
|
|
10637
|
+
# @!attribute [rw] request_id
|
|
10638
|
+
# The service request ID that initiated the operation
|
|
10639
|
+
# @return [String]
|
|
10640
|
+
#
|
|
10641
|
+
# @!attribute [rw] attributes
|
|
10642
|
+
# Span-specific contextual attributes
|
|
10643
|
+
# @return [Types::SpanAttributes]
|
|
10644
|
+
#
|
|
10645
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/Span AWS API Documentation
|
|
10646
|
+
#
|
|
10647
|
+
class Span < Struct.new(
|
|
10648
|
+
:span_id,
|
|
10649
|
+
:assistant_id,
|
|
10650
|
+
:session_id,
|
|
10651
|
+
:parent_span_id,
|
|
10652
|
+
:span_name,
|
|
10653
|
+
:span_type,
|
|
10654
|
+
:start_timestamp,
|
|
10655
|
+
:end_timestamp,
|
|
10656
|
+
:status,
|
|
10657
|
+
:request_id,
|
|
10658
|
+
:attributes)
|
|
10659
|
+
SENSITIVE = []
|
|
10660
|
+
include Aws::Structure
|
|
10661
|
+
end
|
|
10662
|
+
|
|
10663
|
+
# Contextual attributes capturing operation details, LLM configuration,
|
|
10664
|
+
# usage metrics, and conversation data
|
|
10665
|
+
#
|
|
10666
|
+
# @!attribute [rw] operation_name
|
|
10667
|
+
# Action being performed
|
|
10668
|
+
# @return [String]
|
|
10669
|
+
#
|
|
10670
|
+
# @!attribute [rw] provider_name
|
|
10671
|
+
# Model provider identifier (e.g., aws.bedrock)
|
|
10672
|
+
# @return [String]
|
|
10673
|
+
#
|
|
10674
|
+
# @!attribute [rw] error_type
|
|
10675
|
+
# Error classification if span failed (e.g., throttle, timeout)
|
|
10676
|
+
# @return [String]
|
|
10677
|
+
#
|
|
10678
|
+
# @!attribute [rw] agent_id
|
|
10679
|
+
# Amazon Connect agent ID
|
|
10680
|
+
# @return [String]
|
|
10681
|
+
#
|
|
10682
|
+
# @!attribute [rw] instance_arn
|
|
10683
|
+
# Amazon Connect instance ARN
|
|
10684
|
+
# @return [String]
|
|
10685
|
+
#
|
|
10686
|
+
# @!attribute [rw] contact_id
|
|
10687
|
+
# Amazon Connect contact identifier
|
|
10688
|
+
# @return [String]
|
|
10689
|
+
#
|
|
10690
|
+
# @!attribute [rw] initial_contact_id
|
|
10691
|
+
# Amazon Connect contact identifier
|
|
10692
|
+
# @return [String]
|
|
10693
|
+
#
|
|
10694
|
+
# @!attribute [rw] session_name
|
|
10695
|
+
# Session name
|
|
10696
|
+
# @return [String]
|
|
10697
|
+
#
|
|
10698
|
+
# @!attribute [rw] ai_agent_arn
|
|
10699
|
+
# AI agent ARN
|
|
10700
|
+
# @return [String]
|
|
10701
|
+
#
|
|
10702
|
+
# @!attribute [rw] ai_agent_type
|
|
10703
|
+
# AI agent type
|
|
10704
|
+
# @return [String]
|
|
10705
|
+
#
|
|
10706
|
+
# @!attribute [rw] ai_agent_name
|
|
10707
|
+
# AI agent name
|
|
10708
|
+
# @return [String]
|
|
10709
|
+
#
|
|
10710
|
+
# @!attribute [rw] ai_agent_id
|
|
10711
|
+
# AI agent identifier
|
|
10712
|
+
# @return [String]
|
|
10713
|
+
#
|
|
10714
|
+
# @!attribute [rw] ai_agent_version
|
|
10715
|
+
# AI agent version number
|
|
10716
|
+
# @return [Integer]
|
|
10717
|
+
#
|
|
10718
|
+
# @!attribute [rw] ai_agent_invoker
|
|
10719
|
+
# Entity that invoked the AI agent
|
|
10720
|
+
# @return [String]
|
|
10721
|
+
#
|
|
10722
|
+
# @!attribute [rw] ai_agent_orchestrator_use_case
|
|
10723
|
+
# AI agent orchestrator use case
|
|
10724
|
+
# @return [String]
|
|
10725
|
+
#
|
|
10726
|
+
# @!attribute [rw] request_model
|
|
10727
|
+
# LLM model ID for request (e.g., anthropic.claude-3-sonnet)
|
|
10728
|
+
# @return [String]
|
|
10729
|
+
#
|
|
10730
|
+
# @!attribute [rw] request_max_tokens
|
|
10731
|
+
# Maximum tokens configured for generation
|
|
10732
|
+
# @return [Integer]
|
|
10733
|
+
#
|
|
10734
|
+
# @!attribute [rw] temperature
|
|
10735
|
+
# Sampling temperature for generation
|
|
10736
|
+
# @return [Float]
|
|
10737
|
+
#
|
|
10738
|
+
# @!attribute [rw] top_p
|
|
10739
|
+
# Top-p sampling parameter for generation
|
|
10740
|
+
# @return [Float]
|
|
10741
|
+
#
|
|
10742
|
+
# @!attribute [rw] response_model
|
|
10743
|
+
# Actual model used for response (usually matches requestModel)
|
|
10744
|
+
# @return [String]
|
|
10745
|
+
#
|
|
10746
|
+
# @!attribute [rw] response_finish_reasons
|
|
10747
|
+
# Generation termination reasons (e.g., stop, max\_tokens)
|
|
10748
|
+
# @return [Array<String>]
|
|
10749
|
+
#
|
|
10750
|
+
# @!attribute [rw] usage_input_tokens
|
|
10751
|
+
# Number of input tokens in prompt
|
|
10752
|
+
# @return [Integer]
|
|
10753
|
+
#
|
|
10754
|
+
# @!attribute [rw] usage_output_tokens
|
|
10755
|
+
# Number of output tokens in response
|
|
10756
|
+
# @return [Integer]
|
|
10757
|
+
#
|
|
10758
|
+
# @!attribute [rw] usage_total_tokens
|
|
10759
|
+
# Total tokens consumed (input + output)
|
|
10760
|
+
# @return [Integer]
|
|
10761
|
+
#
|
|
10762
|
+
# @!attribute [rw] cache_read_input_tokens
|
|
10763
|
+
# Number of input tokens that were retrieved from cache
|
|
10764
|
+
# @return [Integer]
|
|
10765
|
+
#
|
|
10766
|
+
# @!attribute [rw] cache_write_input_tokens
|
|
10767
|
+
# Number of input tokens that were written to cache in this request
|
|
10768
|
+
# @return [Integer]
|
|
10769
|
+
#
|
|
10770
|
+
# @!attribute [rw] input_messages
|
|
10771
|
+
# Input message collection sent to LLM
|
|
10772
|
+
# @return [Array<Types::SpanMessage>]
|
|
10773
|
+
#
|
|
10774
|
+
# @!attribute [rw] output_messages
|
|
10775
|
+
# Output message collection received from LLM
|
|
10776
|
+
# @return [Array<Types::SpanMessage>]
|
|
10777
|
+
#
|
|
10778
|
+
# @!attribute [rw] system_instructions
|
|
10779
|
+
# System prompt instructions
|
|
10780
|
+
# @return [Array<Types::SpanMessageValue>]
|
|
10781
|
+
#
|
|
10782
|
+
# @!attribute [rw] prompt_arn
|
|
10783
|
+
# AI prompt ARN
|
|
10784
|
+
# @return [String]
|
|
10785
|
+
#
|
|
10786
|
+
# @!attribute [rw] prompt_id
|
|
10787
|
+
# AI prompt identifier
|
|
10788
|
+
# @return [String]
|
|
10789
|
+
#
|
|
10790
|
+
# @!attribute [rw] prompt_type
|
|
10791
|
+
# AI prompt type
|
|
10792
|
+
# @return [String]
|
|
10793
|
+
#
|
|
10794
|
+
# @!attribute [rw] prompt_name
|
|
10795
|
+
# AI prompt name
|
|
10796
|
+
# @return [String]
|
|
10797
|
+
#
|
|
10798
|
+
# @!attribute [rw] prompt_version
|
|
10799
|
+
# AI prompt version number
|
|
10800
|
+
# @return [Integer]
|
|
10801
|
+
#
|
|
10802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanAttributes AWS API Documentation
|
|
10803
|
+
#
|
|
10804
|
+
class SpanAttributes < Struct.new(
|
|
10805
|
+
:operation_name,
|
|
10806
|
+
:provider_name,
|
|
10807
|
+
:error_type,
|
|
10808
|
+
:agent_id,
|
|
10809
|
+
:instance_arn,
|
|
10810
|
+
:contact_id,
|
|
10811
|
+
:initial_contact_id,
|
|
10812
|
+
:session_name,
|
|
10813
|
+
:ai_agent_arn,
|
|
10814
|
+
:ai_agent_type,
|
|
10815
|
+
:ai_agent_name,
|
|
10816
|
+
:ai_agent_id,
|
|
10817
|
+
:ai_agent_version,
|
|
10818
|
+
:ai_agent_invoker,
|
|
10819
|
+
:ai_agent_orchestrator_use_case,
|
|
10820
|
+
:request_model,
|
|
10821
|
+
:request_max_tokens,
|
|
10822
|
+
:temperature,
|
|
10823
|
+
:top_p,
|
|
10824
|
+
:response_model,
|
|
10825
|
+
:response_finish_reasons,
|
|
10826
|
+
:usage_input_tokens,
|
|
10827
|
+
:usage_output_tokens,
|
|
10828
|
+
:usage_total_tokens,
|
|
10829
|
+
:cache_read_input_tokens,
|
|
10830
|
+
:cache_write_input_tokens,
|
|
10831
|
+
:input_messages,
|
|
10832
|
+
:output_messages,
|
|
10833
|
+
:system_instructions,
|
|
10834
|
+
:prompt_arn,
|
|
10835
|
+
:prompt_id,
|
|
10836
|
+
:prompt_type,
|
|
10837
|
+
:prompt_name,
|
|
10838
|
+
:prompt_version)
|
|
10839
|
+
SENSITIVE = []
|
|
10840
|
+
include Aws::Structure
|
|
10841
|
+
end
|
|
10842
|
+
|
|
10843
|
+
# A citation that spans a specific range of text.
|
|
10844
|
+
#
|
|
10845
|
+
# @!attribute [rw] content_id
|
|
10846
|
+
# The identifier of the content being cited in the span.
|
|
10847
|
+
# @return [String]
|
|
10848
|
+
#
|
|
10849
|
+
# @!attribute [rw] title
|
|
10850
|
+
# The title of the content being cited in the span.
|
|
10851
|
+
# @return [String]
|
|
10852
|
+
#
|
|
10853
|
+
# @!attribute [rw] knowledge_base_id
|
|
10854
|
+
# The identifier of the knowledge base containing the cited content.
|
|
10855
|
+
# @return [String]
|
|
10856
|
+
#
|
|
10857
|
+
# @!attribute [rw] knowledge_base_arn
|
|
10858
|
+
# The Amazon Resource Name (ARN) of the knowledge base containing the
|
|
10859
|
+
# cited content.
|
|
10860
|
+
# @return [String]
|
|
10861
|
+
#
|
|
10862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanCitation AWS API Documentation
|
|
10863
|
+
#
|
|
10864
|
+
class SpanCitation < Struct.new(
|
|
10865
|
+
:content_id,
|
|
10866
|
+
:title,
|
|
10867
|
+
:knowledge_base_id,
|
|
10868
|
+
:knowledge_base_arn)
|
|
10869
|
+
SENSITIVE = [:title]
|
|
10870
|
+
include Aws::Structure
|
|
10871
|
+
end
|
|
10872
|
+
|
|
10873
|
+
# A message in the conversation history with participant role and
|
|
10874
|
+
# content values
|
|
10875
|
+
#
|
|
10876
|
+
# @!attribute [rw] message_id
|
|
10877
|
+
# Unique message identifier
|
|
10878
|
+
# @return [String]
|
|
10879
|
+
#
|
|
10880
|
+
# @!attribute [rw] participant
|
|
10881
|
+
# Message source role
|
|
10882
|
+
# @return [String]
|
|
10883
|
+
#
|
|
10884
|
+
# @!attribute [rw] timestamp
|
|
10885
|
+
# Message timestamp
|
|
10886
|
+
# @return [Time]
|
|
10887
|
+
#
|
|
10888
|
+
# @!attribute [rw] values
|
|
10889
|
+
# Message content values (text, tool use, tool result)
|
|
10890
|
+
# @return [Array<Types::SpanMessageValue>]
|
|
10891
|
+
#
|
|
10892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanMessage AWS API Documentation
|
|
10893
|
+
#
|
|
10894
|
+
class SpanMessage < Struct.new(
|
|
10895
|
+
:message_id,
|
|
10896
|
+
:participant,
|
|
10897
|
+
:timestamp,
|
|
10898
|
+
:values)
|
|
10899
|
+
SENSITIVE = []
|
|
10900
|
+
include Aws::Structure
|
|
10901
|
+
end
|
|
10902
|
+
|
|
10903
|
+
# Message content value - can be text, tool invocation, or tool result
|
|
10904
|
+
#
|
|
10905
|
+
# @note SpanMessageValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of SpanMessageValue corresponding to the set member.
|
|
10906
|
+
#
|
|
10907
|
+
# @!attribute [rw] text
|
|
10908
|
+
# Text message content
|
|
10909
|
+
# @return [Types::SpanTextValue]
|
|
10910
|
+
#
|
|
10911
|
+
# @!attribute [rw] tool_use
|
|
10912
|
+
# Tool invocation message content
|
|
10913
|
+
# @return [Types::SpanToolUseValue]
|
|
10914
|
+
#
|
|
10915
|
+
# @!attribute [rw] tool_result
|
|
10916
|
+
# Tool result message content
|
|
10917
|
+
# @return [Types::SpanToolResultValue]
|
|
10918
|
+
#
|
|
10919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanMessageValue AWS API Documentation
|
|
10920
|
+
#
|
|
10921
|
+
class SpanMessageValue < Struct.new(
|
|
10922
|
+
:text,
|
|
10923
|
+
:tool_use,
|
|
10924
|
+
:tool_result,
|
|
10925
|
+
:unknown)
|
|
10926
|
+
SENSITIVE = []
|
|
10927
|
+
include Aws::Structure
|
|
10928
|
+
include Aws::Structure::Union
|
|
10929
|
+
|
|
10930
|
+
class Text < SpanMessageValue; end
|
|
10931
|
+
class ToolUse < SpanMessageValue; end
|
|
10932
|
+
class ToolResult < SpanMessageValue; end
|
|
10933
|
+
class Unknown < SpanMessageValue; end
|
|
10934
|
+
end
|
|
10935
|
+
|
|
10936
|
+
# Text message content
|
|
10937
|
+
#
|
|
10938
|
+
# @!attribute [rw] value
|
|
10939
|
+
# String content of the message text
|
|
10940
|
+
# @return [String]
|
|
10941
|
+
#
|
|
10942
|
+
# @!attribute [rw] citations
|
|
10943
|
+
# The citations associated with the span text.
|
|
10944
|
+
# @return [Array<Types::SpanCitation>]
|
|
10945
|
+
#
|
|
10946
|
+
# @!attribute [rw] ai_guardrail_assessment
|
|
10947
|
+
# The AI Guardrail assessment for the span text.
|
|
10948
|
+
# @return [Types::AIGuardrailAssessment]
|
|
10949
|
+
#
|
|
10950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanTextValue AWS API Documentation
|
|
10951
|
+
#
|
|
10952
|
+
class SpanTextValue < Struct.new(
|
|
10953
|
+
:value,
|
|
10954
|
+
:citations,
|
|
10955
|
+
:ai_guardrail_assessment)
|
|
10956
|
+
SENSITIVE = [:value]
|
|
10957
|
+
include Aws::Structure
|
|
10958
|
+
end
|
|
10959
|
+
|
|
10960
|
+
# Tool result message content
|
|
10961
|
+
#
|
|
10962
|
+
# @!attribute [rw] tool_use_id
|
|
10963
|
+
# Relates this result back to the tool invocation
|
|
10964
|
+
# @return [String]
|
|
10965
|
+
#
|
|
10966
|
+
# @!attribute [rw] values
|
|
10967
|
+
# The tool results
|
|
10968
|
+
# @return [Array<Types::SpanMessageValue>]
|
|
10969
|
+
#
|
|
10970
|
+
# @!attribute [rw] error
|
|
10971
|
+
# The tool invocation error if failed
|
|
10972
|
+
# @return [String]
|
|
10973
|
+
#
|
|
10974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanToolResultValue AWS API Documentation
|
|
10975
|
+
#
|
|
10976
|
+
class SpanToolResultValue < Struct.new(
|
|
10977
|
+
:tool_use_id,
|
|
10978
|
+
:values,
|
|
10979
|
+
:error)
|
|
10980
|
+
SENSITIVE = []
|
|
10981
|
+
include Aws::Structure
|
|
9371
10982
|
end
|
|
9372
10983
|
|
|
9373
|
-
#
|
|
10984
|
+
# Tool invocation message content
|
|
9374
10985
|
#
|
|
9375
|
-
# @!attribute [rw]
|
|
9376
|
-
#
|
|
10986
|
+
# @!attribute [rw] tool_use_id
|
|
10987
|
+
# Unique ID for this tool invocation
|
|
9377
10988
|
# @return [String]
|
|
9378
10989
|
#
|
|
9379
|
-
# @!attribute [rw]
|
|
9380
|
-
# The
|
|
10990
|
+
# @!attribute [rw] name
|
|
10991
|
+
# The tool name
|
|
9381
10992
|
# @return [String]
|
|
9382
10993
|
#
|
|
9383
|
-
# @!attribute [rw]
|
|
9384
|
-
#
|
|
9385
|
-
# @return [
|
|
9386
|
-
#
|
|
9387
|
-
# @!attribute [rw] ranking_data
|
|
9388
|
-
# Details about the source content ranking data.
|
|
9389
|
-
# @return [Types::RankingData]
|
|
9390
|
-
#
|
|
9391
|
-
# @!attribute [rw] citation_span
|
|
9392
|
-
# Contains information about where the text with a citation begins and
|
|
9393
|
-
# ends in the generated output.
|
|
9394
|
-
# @return [Types::CitationSpan]
|
|
10994
|
+
# @!attribute [rw] arguments
|
|
10995
|
+
# The tool input arguments
|
|
10996
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
9395
10997
|
#
|
|
9396
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/
|
|
10998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanToolUseValue AWS API Documentation
|
|
9397
10999
|
#
|
|
9398
|
-
class
|
|
9399
|
-
:
|
|
9400
|
-
:
|
|
9401
|
-
:
|
|
9402
|
-
:ranking_data,
|
|
9403
|
-
:citation_span)
|
|
11000
|
+
class SpanToolUseValue < Struct.new(
|
|
11001
|
+
:tool_use_id,
|
|
11002
|
+
:name,
|
|
11003
|
+
:arguments)
|
|
9404
11004
|
SENSITIVE = []
|
|
9405
11005
|
include Aws::Structure
|
|
9406
11006
|
end
|
|
@@ -9526,6 +11126,40 @@ module Aws::QConnect
|
|
|
9526
11126
|
include Aws::Structure
|
|
9527
11127
|
end
|
|
9528
11128
|
|
|
11129
|
+
# Details about suggested message data.
|
|
11130
|
+
#
|
|
11131
|
+
# @!attribute [rw] message_text
|
|
11132
|
+
# The text content of the suggested message.
|
|
11133
|
+
# @return [String]
|
|
11134
|
+
#
|
|
11135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SuggestedMessageDataDetails AWS API Documentation
|
|
11136
|
+
#
|
|
11137
|
+
class SuggestedMessageDataDetails < Struct.new(
|
|
11138
|
+
:message_text)
|
|
11139
|
+
SENSITIVE = [:message_text]
|
|
11140
|
+
include Aws::Structure
|
|
11141
|
+
end
|
|
11142
|
+
|
|
11143
|
+
# Reference information for a suggested message.
|
|
11144
|
+
#
|
|
11145
|
+
# @!attribute [rw] ai_agent_id
|
|
11146
|
+
# The identifier of the AI Agent that generated the suggested message.
|
|
11147
|
+
# @return [String]
|
|
11148
|
+
#
|
|
11149
|
+
# @!attribute [rw] ai_agent_arn
|
|
11150
|
+
# The Amazon Resource Name (ARN) of the AI Agent that generated the
|
|
11151
|
+
# suggested message.
|
|
11152
|
+
# @return [String]
|
|
11153
|
+
#
|
|
11154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SuggestedMessageReference AWS API Documentation
|
|
11155
|
+
#
|
|
11156
|
+
class SuggestedMessageReference < Struct.new(
|
|
11157
|
+
:ai_agent_id,
|
|
11158
|
+
:ai_agent_arn)
|
|
11159
|
+
SENSITIVE = []
|
|
11160
|
+
include Aws::Structure
|
|
11161
|
+
end
|
|
11162
|
+
|
|
9529
11163
|
# The system attributes that are used with the message template.
|
|
9530
11164
|
#
|
|
9531
11165
|
# @!attribute [rw] name
|
|
@@ -9645,6 +11279,36 @@ module Aws::QConnect
|
|
|
9645
11279
|
#
|
|
9646
11280
|
class TagResourceResponse < Aws::EmptyStructure; end
|
|
9647
11281
|
|
|
11282
|
+
# Inference configuration for text-based AI Prompts.
|
|
11283
|
+
#
|
|
11284
|
+
# @!attribute [rw] temperature
|
|
11285
|
+
# The temperature setting for controlling randomness in the generated
|
|
11286
|
+
# response.
|
|
11287
|
+
# @return [Float]
|
|
11288
|
+
#
|
|
11289
|
+
# @!attribute [rw] top_p
|
|
11290
|
+
# The top-P sampling parameter for nucleus sampling.
|
|
11291
|
+
# @return [Float]
|
|
11292
|
+
#
|
|
11293
|
+
# @!attribute [rw] top_k
|
|
11294
|
+
# The top-K sampling parameter for token selection.
|
|
11295
|
+
# @return [Integer]
|
|
11296
|
+
#
|
|
11297
|
+
# @!attribute [rw] max_tokens_to_sample
|
|
11298
|
+
# The maximum number of tokens to generate in the response.
|
|
11299
|
+
# @return [Integer]
|
|
11300
|
+
#
|
|
11301
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextAIPromptInferenceConfiguration AWS API Documentation
|
|
11302
|
+
#
|
|
11303
|
+
class TextAIPromptInferenceConfiguration < Struct.new(
|
|
11304
|
+
:temperature,
|
|
11305
|
+
:top_p,
|
|
11306
|
+
:top_k,
|
|
11307
|
+
:max_tokens_to_sample)
|
|
11308
|
+
SENSITIVE = [:temperature, :top_p, :top_k, :max_tokens_to_sample]
|
|
11309
|
+
include Aws::Structure
|
|
11310
|
+
end
|
|
11311
|
+
|
|
9648
11312
|
# Details about the source content text data.
|
|
9649
11313
|
#
|
|
9650
11314
|
# @!attribute [rw] title
|
|
@@ -9685,10 +11349,20 @@ module Aws::QConnect
|
|
|
9685
11349
|
# The value of the message data in text type.
|
|
9686
11350
|
# @return [String]
|
|
9687
11351
|
#
|
|
11352
|
+
# @!attribute [rw] citations
|
|
11353
|
+
# The citations associated with the text message.
|
|
11354
|
+
# @return [Array<Types::Citation>]
|
|
11355
|
+
#
|
|
11356
|
+
# @!attribute [rw] ai_guardrail_assessment
|
|
11357
|
+
# The AI Guardrail assessment for the text message.
|
|
11358
|
+
# @return [Types::AIGuardrailAssessment]
|
|
11359
|
+
#
|
|
9688
11360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextMessage AWS API Documentation
|
|
9689
11361
|
#
|
|
9690
11362
|
class TextMessage < Struct.new(
|
|
9691
|
-
:value
|
|
11363
|
+
:value,
|
|
11364
|
+
:citations,
|
|
11365
|
+
:ai_guardrail_assessment)
|
|
9692
11366
|
SENSITIVE = [:value]
|
|
9693
11367
|
include Aws::Structure
|
|
9694
11368
|
end
|
|
@@ -9725,6 +11399,223 @@ module Aws::QConnect
|
|
|
9725
11399
|
include Aws::Structure
|
|
9726
11400
|
end
|
|
9727
11401
|
|
|
11402
|
+
# Configuration settings for a tool used by AI Agents.
|
|
11403
|
+
#
|
|
11404
|
+
# @!attribute [rw] tool_name
|
|
11405
|
+
# The name of the tool.
|
|
11406
|
+
# @return [String]
|
|
11407
|
+
#
|
|
11408
|
+
# @!attribute [rw] tool_type
|
|
11409
|
+
# The type of the tool.
|
|
11410
|
+
# @return [String]
|
|
11411
|
+
#
|
|
11412
|
+
# @!attribute [rw] title
|
|
11413
|
+
# The title of the tool configuration.
|
|
11414
|
+
# @return [String]
|
|
11415
|
+
#
|
|
11416
|
+
# @!attribute [rw] tool_id
|
|
11417
|
+
# The identifier of the tool, for example toolName from Model Context
|
|
11418
|
+
# Provider server.
|
|
11419
|
+
# @return [String]
|
|
11420
|
+
#
|
|
11421
|
+
# @!attribute [rw] description
|
|
11422
|
+
# The description of the tool configuration.
|
|
11423
|
+
# @return [String]
|
|
11424
|
+
#
|
|
11425
|
+
# @!attribute [rw] instruction
|
|
11426
|
+
# Instructions for using the tool.
|
|
11427
|
+
# @return [Types::ToolInstruction]
|
|
11428
|
+
#
|
|
11429
|
+
# @!attribute [rw] override_input_values
|
|
11430
|
+
# Override input values for the tool configuration.
|
|
11431
|
+
# @return [Array<Types::ToolOverrideInputValue>]
|
|
11432
|
+
#
|
|
11433
|
+
# @!attribute [rw] output_filters
|
|
11434
|
+
# Output filters applies to the tool result.
|
|
11435
|
+
# @return [Array<Types::ToolOutputFilter>]
|
|
11436
|
+
#
|
|
11437
|
+
# @!attribute [rw] input_schema
|
|
11438
|
+
# The input schema for the tool configuration.
|
|
11439
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
11440
|
+
#
|
|
11441
|
+
# @!attribute [rw] output_schema
|
|
11442
|
+
# The output schema for the tool configuration.
|
|
11443
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
11444
|
+
#
|
|
11445
|
+
# @!attribute [rw] annotations
|
|
11446
|
+
# Annotations for the tool configuration.
|
|
11447
|
+
# @return [Types::Annotation]
|
|
11448
|
+
#
|
|
11449
|
+
# @!attribute [rw] user_interaction_configuration
|
|
11450
|
+
# Configuration for user interaction with the tool.
|
|
11451
|
+
# @return [Types::UserInteractionConfiguration]
|
|
11452
|
+
#
|
|
11453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolConfiguration AWS API Documentation
|
|
11454
|
+
#
|
|
11455
|
+
class ToolConfiguration < Struct.new(
|
|
11456
|
+
:tool_name,
|
|
11457
|
+
:tool_type,
|
|
11458
|
+
:title,
|
|
11459
|
+
:tool_id,
|
|
11460
|
+
:description,
|
|
11461
|
+
:instruction,
|
|
11462
|
+
:override_input_values,
|
|
11463
|
+
:output_filters,
|
|
11464
|
+
:input_schema,
|
|
11465
|
+
:output_schema,
|
|
11466
|
+
:annotations,
|
|
11467
|
+
:user_interaction_configuration)
|
|
11468
|
+
SENSITIVE = []
|
|
11469
|
+
include Aws::Structure
|
|
11470
|
+
end
|
|
11471
|
+
|
|
11472
|
+
# Instructions for using a tool.
|
|
11473
|
+
#
|
|
11474
|
+
# @!attribute [rw] instruction
|
|
11475
|
+
# The instruction text for the tool.
|
|
11476
|
+
# @return [String]
|
|
11477
|
+
#
|
|
11478
|
+
# @!attribute [rw] examples
|
|
11479
|
+
# Examples for using the tool.
|
|
11480
|
+
# @return [Array<String>]
|
|
11481
|
+
#
|
|
11482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolInstruction AWS API Documentation
|
|
11483
|
+
#
|
|
11484
|
+
class ToolInstruction < Struct.new(
|
|
11485
|
+
:instruction,
|
|
11486
|
+
:examples)
|
|
11487
|
+
SENSITIVE = []
|
|
11488
|
+
include Aws::Structure
|
|
11489
|
+
end
|
|
11490
|
+
|
|
11491
|
+
# Configuration for tool output handling.
|
|
11492
|
+
#
|
|
11493
|
+
# @!attribute [rw] output_variable_name_override
|
|
11494
|
+
# Override the tool output results to different variable name.
|
|
11495
|
+
# @return [String]
|
|
11496
|
+
#
|
|
11497
|
+
# @!attribute [rw] session_data_namespace
|
|
11498
|
+
# The session data namespace for tool output.
|
|
11499
|
+
# @return [String]
|
|
11500
|
+
#
|
|
11501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolOutputConfiguration AWS API Documentation
|
|
11502
|
+
#
|
|
11503
|
+
class ToolOutputConfiguration < Struct.new(
|
|
11504
|
+
:output_variable_name_override,
|
|
11505
|
+
:session_data_namespace)
|
|
11506
|
+
SENSITIVE = []
|
|
11507
|
+
include Aws::Structure
|
|
11508
|
+
end
|
|
11509
|
+
|
|
11510
|
+
# Filter configuration for tool output.
|
|
11511
|
+
#
|
|
11512
|
+
# @!attribute [rw] json_path
|
|
11513
|
+
# The JSON path for filtering tool output.
|
|
11514
|
+
# @return [String]
|
|
11515
|
+
#
|
|
11516
|
+
# @!attribute [rw] output_configuration
|
|
11517
|
+
# The output configuration for the filter.
|
|
11518
|
+
# @return [Types::ToolOutputConfiguration]
|
|
11519
|
+
#
|
|
11520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolOutputFilter AWS API Documentation
|
|
11521
|
+
#
|
|
11522
|
+
class ToolOutputFilter < Struct.new(
|
|
11523
|
+
:json_path,
|
|
11524
|
+
:output_configuration)
|
|
11525
|
+
SENSITIVE = []
|
|
11526
|
+
include Aws::Structure
|
|
11527
|
+
end
|
|
11528
|
+
|
|
11529
|
+
# A constant input value for tool override.
|
|
11530
|
+
#
|
|
11531
|
+
# @!attribute [rw] type
|
|
11532
|
+
# Override tool input value with constant values
|
|
11533
|
+
# @return [String]
|
|
11534
|
+
#
|
|
11535
|
+
# @!attribute [rw] value
|
|
11536
|
+
# The constant input override value.
|
|
11537
|
+
# @return [String]
|
|
11538
|
+
#
|
|
11539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolOverrideConstantInputValue AWS API Documentation
|
|
11540
|
+
#
|
|
11541
|
+
class ToolOverrideConstantInputValue < Struct.new(
|
|
11542
|
+
:type,
|
|
11543
|
+
:value)
|
|
11544
|
+
SENSITIVE = [:value]
|
|
11545
|
+
include Aws::Structure
|
|
11546
|
+
end
|
|
11547
|
+
|
|
11548
|
+
# An input value override for tools.
|
|
11549
|
+
#
|
|
11550
|
+
# @!attribute [rw] json_path
|
|
11551
|
+
# The JSON path for the input value override.
|
|
11552
|
+
# @return [String]
|
|
11553
|
+
#
|
|
11554
|
+
# @!attribute [rw] value
|
|
11555
|
+
# The override input value.
|
|
11556
|
+
# @return [Types::ToolOverrideInputValueConfiguration]
|
|
11557
|
+
#
|
|
11558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolOverrideInputValue AWS API Documentation
|
|
11559
|
+
#
|
|
11560
|
+
class ToolOverrideInputValue < Struct.new(
|
|
11561
|
+
:json_path,
|
|
11562
|
+
:value)
|
|
11563
|
+
SENSITIVE = []
|
|
11564
|
+
include Aws::Structure
|
|
11565
|
+
end
|
|
11566
|
+
|
|
11567
|
+
# Configuration for overriding tool input values.
|
|
11568
|
+
#
|
|
11569
|
+
# @note ToolOverrideInputValueConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
11570
|
+
#
|
|
11571
|
+
# @note ToolOverrideInputValueConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ToolOverrideInputValueConfiguration corresponding to the set member.
|
|
11572
|
+
#
|
|
11573
|
+
# @!attribute [rw] constant
|
|
11574
|
+
# Constant input value configuration for tool override.
|
|
11575
|
+
# @return [Types::ToolOverrideConstantInputValue]
|
|
11576
|
+
#
|
|
11577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolOverrideInputValueConfiguration AWS API Documentation
|
|
11578
|
+
#
|
|
11579
|
+
class ToolOverrideInputValueConfiguration < Struct.new(
|
|
11580
|
+
:constant,
|
|
11581
|
+
:unknown)
|
|
11582
|
+
SENSITIVE = []
|
|
11583
|
+
include Aws::Structure
|
|
11584
|
+
include Aws::Structure::Union
|
|
11585
|
+
|
|
11586
|
+
class Constant < ToolOverrideInputValueConfiguration; end
|
|
11587
|
+
class Unknown < ToolOverrideInputValueConfiguration; end
|
|
11588
|
+
end
|
|
11589
|
+
|
|
11590
|
+
# Data about the result of tool usage.
|
|
11591
|
+
#
|
|
11592
|
+
# @!attribute [rw] tool_use_id
|
|
11593
|
+
# The identifier of the tool use instance.
|
|
11594
|
+
# @return [String]
|
|
11595
|
+
#
|
|
11596
|
+
# @!attribute [rw] tool_name
|
|
11597
|
+
# The name of the tool that was used.
|
|
11598
|
+
# @return [String]
|
|
11599
|
+
#
|
|
11600
|
+
# @!attribute [rw] tool_result
|
|
11601
|
+
# The result of the tool usage.
|
|
11602
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
11603
|
+
#
|
|
11604
|
+
# @!attribute [rw] input_schema
|
|
11605
|
+
# The input schema for the tool use result.
|
|
11606
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
11607
|
+
#
|
|
11608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ToolUseResultData AWS API Documentation
|
|
11609
|
+
#
|
|
11610
|
+
class ToolUseResultData < Struct.new(
|
|
11611
|
+
:tool_use_id,
|
|
11612
|
+
:tool_name,
|
|
11613
|
+
:tool_result,
|
|
11614
|
+
:input_schema)
|
|
11615
|
+
SENSITIVE = []
|
|
11616
|
+
include Aws::Structure
|
|
11617
|
+
end
|
|
11618
|
+
|
|
9728
11619
|
# You do not have permission to perform this action.
|
|
9729
11620
|
#
|
|
9730
11621
|
# @!attribute [rw] message
|
|
@@ -9738,6 +11629,19 @@ module Aws::QConnect
|
|
|
9738
11629
|
include Aws::Structure
|
|
9739
11630
|
end
|
|
9740
11631
|
|
|
11632
|
+
# The server has a failure of processing the message
|
|
11633
|
+
#
|
|
11634
|
+
# @!attribute [rw] message
|
|
11635
|
+
# @return [String]
|
|
11636
|
+
#
|
|
11637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UnprocessableContentException AWS API Documentation
|
|
11638
|
+
#
|
|
11639
|
+
class UnprocessableContentException < Struct.new(
|
|
11640
|
+
:message)
|
|
11641
|
+
SENSITIVE = []
|
|
11642
|
+
include Aws::Structure
|
|
11643
|
+
end
|
|
11644
|
+
|
|
9741
11645
|
# @!attribute [rw] resource_arn
|
|
9742
11646
|
# The Amazon Resource Name (ARN) of the resource.
|
|
9743
11647
|
# @return [String]
|
|
@@ -9959,6 +11863,10 @@ module Aws::QConnect
|
|
|
9959
11863
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt
|
|
9960
11864
|
# @return [String]
|
|
9961
11865
|
#
|
|
11866
|
+
# @!attribute [rw] inference_configuration
|
|
11867
|
+
# The updated inference configuration for the AI Prompt.
|
|
11868
|
+
# @return [Types::AIPromptInferenceConfiguration]
|
|
11869
|
+
#
|
|
9962
11870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPromptRequest AWS API Documentation
|
|
9963
11871
|
#
|
|
9964
11872
|
class UpdateAIPromptRequest < Struct.new(
|
|
@@ -9968,7 +11876,8 @@ module Aws::QConnect
|
|
|
9968
11876
|
:visibility_status,
|
|
9969
11877
|
:template_configuration,
|
|
9970
11878
|
:description,
|
|
9971
|
-
:model_id
|
|
11879
|
+
:model_id,
|
|
11880
|
+
:inference_configuration)
|
|
9972
11881
|
SENSITIVE = []
|
|
9973
11882
|
include Aws::Structure
|
|
9974
11883
|
end
|
|
@@ -10000,12 +11909,18 @@ module Aws::QConnect
|
|
|
10000
11909
|
# on the Amazon Q in Connect Assistant.
|
|
10001
11910
|
# @return [Types::AIAgentConfigurationData]
|
|
10002
11911
|
#
|
|
11912
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
11913
|
+
# The updated list of orchestrator configurations for the assistant AI
|
|
11914
|
+
# Agent.
|
|
11915
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
11916
|
+
#
|
|
10003
11917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAssistantAIAgentRequest AWS API Documentation
|
|
10004
11918
|
#
|
|
10005
11919
|
class UpdateAssistantAIAgentRequest < Struct.new(
|
|
10006
11920
|
:assistant_id,
|
|
10007
11921
|
:ai_agent_type,
|
|
10008
|
-
:configuration
|
|
11922
|
+
:configuration,
|
|
11923
|
+
:orchestrator_configuration_list)
|
|
10009
11924
|
SENSITIVE = []
|
|
10010
11925
|
include Aws::Structure
|
|
10011
11926
|
end
|
|
@@ -10199,6 +12114,11 @@ module Aws::QConnect
|
|
|
10199
12114
|
# `zh_CN`, `zh_TW`
|
|
10200
12115
|
# @return [String]
|
|
10201
12116
|
#
|
|
12117
|
+
# @!attribute [rw] source_configuration
|
|
12118
|
+
# The source configuration of the message template. Only set this
|
|
12119
|
+
# argument for WHATSAPP channel subtype.
|
|
12120
|
+
# @return [Types::MessageTemplateSourceConfiguration]
|
|
12121
|
+
#
|
|
10202
12122
|
# @!attribute [rw] default_attributes
|
|
10203
12123
|
# An object that specifies the default values to use for variables in
|
|
10204
12124
|
# the message template. This object contains different categories of
|
|
@@ -10214,6 +12134,7 @@ module Aws::QConnect
|
|
|
10214
12134
|
:message_template_id,
|
|
10215
12135
|
:content,
|
|
10216
12136
|
:language,
|
|
12137
|
+
:source_configuration,
|
|
10217
12138
|
:default_attributes)
|
|
10218
12139
|
SENSITIVE = []
|
|
10219
12140
|
include Aws::Structure
|
|
@@ -10414,6 +12335,14 @@ module Aws::QConnect
|
|
|
10414
12335
|
# Session.
|
|
10415
12336
|
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
|
10416
12337
|
#
|
|
12338
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
12339
|
+
# The updated list of orchestrator configurations for the session.
|
|
12340
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
12341
|
+
#
|
|
12342
|
+
# @!attribute [rw] remove_orchestrator_configuration_list
|
|
12343
|
+
# The list of orchestrator configurations to remove from the session.
|
|
12344
|
+
# @return [Boolean]
|
|
12345
|
+
#
|
|
10417
12346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionRequest AWS API Documentation
|
|
10418
12347
|
#
|
|
10419
12348
|
class UpdateSessionRequest < Struct.new(
|
|
@@ -10421,7 +12350,9 @@ module Aws::QConnect
|
|
|
10421
12350
|
:session_id,
|
|
10422
12351
|
:description,
|
|
10423
12352
|
:tag_filter,
|
|
10424
|
-
:ai_agent_configuration
|
|
12353
|
+
:ai_agent_configuration,
|
|
12354
|
+
:orchestrator_configuration_list,
|
|
12355
|
+
:remove_orchestrator_configuration_list)
|
|
10425
12356
|
SENSITIVE = []
|
|
10426
12357
|
include Aws::Structure
|
|
10427
12358
|
end
|
|
@@ -10453,6 +12384,20 @@ module Aws::QConnect
|
|
|
10453
12384
|
include Aws::Structure
|
|
10454
12385
|
end
|
|
10455
12386
|
|
|
12387
|
+
# Configuration for user interaction settings.
|
|
12388
|
+
#
|
|
12389
|
+
# @!attribute [rw] is_user_confirmation_required
|
|
12390
|
+
# Indicates whether user confirmation is required for the interaction.
|
|
12391
|
+
# @return [Boolean]
|
|
12392
|
+
#
|
|
12393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UserInteractionConfiguration AWS API Documentation
|
|
12394
|
+
#
|
|
12395
|
+
class UserInteractionConfiguration < Struct.new(
|
|
12396
|
+
:is_user_confirmation_required)
|
|
12397
|
+
SENSITIVE = []
|
|
12398
|
+
include Aws::Structure
|
|
12399
|
+
end
|
|
12400
|
+
|
|
10456
12401
|
# The input fails to satisfy the constraints specified by a service.
|
|
10457
12402
|
#
|
|
10458
12403
|
# @!attribute [rw] message
|
|
@@ -10548,6 +12493,93 @@ module Aws::QConnect
|
|
|
10548
12493
|
include Aws::Structure
|
|
10549
12494
|
end
|
|
10550
12495
|
|
|
12496
|
+
# The content of the message template that applies to the WHATSAPP
|
|
12497
|
+
# channel subtype.
|
|
12498
|
+
#
|
|
12499
|
+
# @!attribute [rw] data
|
|
12500
|
+
# The data.
|
|
12501
|
+
# @return [String]
|
|
12502
|
+
#
|
|
12503
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateContent AWS API Documentation
|
|
12504
|
+
#
|
|
12505
|
+
class WhatsAppMessageTemplateContent < Struct.new(
|
|
12506
|
+
:data)
|
|
12507
|
+
SENSITIVE = []
|
|
12508
|
+
include Aws::Structure
|
|
12509
|
+
end
|
|
12510
|
+
|
|
12511
|
+
# Configuration information about the external data source.
|
|
12512
|
+
#
|
|
12513
|
+
# @!attribute [rw] business_account_id
|
|
12514
|
+
# The ID of the End User Messaging WhatsApp Business Account to
|
|
12515
|
+
# associate with this template.
|
|
12516
|
+
# @return [String]
|
|
12517
|
+
#
|
|
12518
|
+
# @!attribute [rw] template_id
|
|
12519
|
+
# The WhatsApp template ID.
|
|
12520
|
+
# @return [String]
|
|
12521
|
+
#
|
|
12522
|
+
# @!attribute [rw] components
|
|
12523
|
+
# The list of component mapping from WhatsApp template parameters to
|
|
12524
|
+
# Message Template attributes.
|
|
12525
|
+
# @return [Array<String>]
|
|
12526
|
+
#
|
|
12527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfiguration AWS API Documentation
|
|
12528
|
+
#
|
|
12529
|
+
class WhatsAppMessageTemplateSourceConfiguration < Struct.new(
|
|
12530
|
+
:business_account_id,
|
|
12531
|
+
:template_id,
|
|
12532
|
+
:components)
|
|
12533
|
+
SENSITIVE = []
|
|
12534
|
+
include Aws::Structure
|
|
12535
|
+
end
|
|
12536
|
+
|
|
12537
|
+
# Configuration information about the external data source.
|
|
12538
|
+
#
|
|
12539
|
+
# @!attribute [rw] business_account_id
|
|
12540
|
+
# The ID of the End User Messaging WhatsApp Business Account to
|
|
12541
|
+
# associate with this template.
|
|
12542
|
+
# @return [String]
|
|
12543
|
+
#
|
|
12544
|
+
# @!attribute [rw] template_id
|
|
12545
|
+
# The ID of WhatsApp template.
|
|
12546
|
+
# @return [String]
|
|
12547
|
+
#
|
|
12548
|
+
# @!attribute [rw] name
|
|
12549
|
+
# The name of the WhatsApp template.
|
|
12550
|
+
# @return [String]
|
|
12551
|
+
#
|
|
12552
|
+
# @!attribute [rw] language
|
|
12553
|
+
# The language of the WhatsApp template.
|
|
12554
|
+
# @return [String]
|
|
12555
|
+
#
|
|
12556
|
+
# @!attribute [rw] components
|
|
12557
|
+
# The list of component mapping from WhatsApp template parameters to
|
|
12558
|
+
# Message Template attributes.
|
|
12559
|
+
# @return [Array<String>]
|
|
12560
|
+
#
|
|
12561
|
+
# @!attribute [rw] status
|
|
12562
|
+
# The status of the message template.
|
|
12563
|
+
# @return [String]
|
|
12564
|
+
#
|
|
12565
|
+
# @!attribute [rw] status_reason
|
|
12566
|
+
# The status reason of the message template.
|
|
12567
|
+
# @return [String]
|
|
12568
|
+
#
|
|
12569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/WhatsAppMessageTemplateSourceConfigurationSummary AWS API Documentation
|
|
12570
|
+
#
|
|
12571
|
+
class WhatsAppMessageTemplateSourceConfigurationSummary < Struct.new(
|
|
12572
|
+
:business_account_id,
|
|
12573
|
+
:template_id,
|
|
12574
|
+
:name,
|
|
12575
|
+
:language,
|
|
12576
|
+
:components,
|
|
12577
|
+
:status,
|
|
12578
|
+
:status_reason)
|
|
12579
|
+
SENSITIVE = [:status_reason]
|
|
12580
|
+
include Aws::Structure
|
|
12581
|
+
end
|
|
12582
|
+
|
|
10551
12583
|
end
|
|
10552
12584
|
end
|
|
10553
12585
|
|