aws-sdk-qconnect 1.43.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qconnect/client.rb +794 -28
- data/lib/aws-sdk-qconnect/client_api.rb +473 -1
- data/lib/aws-sdk-qconnect/errors.rb +16 -0
- data/lib/aws-sdk-qconnect/types.rb +1509 -32
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +315 -22
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +475 -19
- metadata +1 -1
|
@@ -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
|
|
@@ -3113,6 +3326,15 @@ module Aws::QConnect
|
|
|
3113
3326
|
# context for AI-powered email assistance.
|
|
3114
3327
|
# @return [String]
|
|
3115
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
|
+
#
|
|
3116
3338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionRequest AWS API Documentation
|
|
3117
3339
|
#
|
|
3118
3340
|
class CreateSessionRequest < Struct.new(
|
|
@@ -3123,7 +3345,9 @@ module Aws::QConnect
|
|
|
3123
3345
|
:tags,
|
|
3124
3346
|
:tag_filter,
|
|
3125
3347
|
:ai_agent_configuration,
|
|
3126
|
-
:contact_arn
|
|
3348
|
+
:contact_arn,
|
|
3349
|
+
:orchestrator_configuration_list,
|
|
3350
|
+
:remove_orchestrator_configuration_list)
|
|
3127
3351
|
SENSITIVE = []
|
|
3128
3352
|
include Aws::Structure
|
|
3129
3353
|
end
|
|
@@ -3481,6 +3705,22 @@ module Aws::QConnect
|
|
|
3481
3705
|
# knowledge-based response content.
|
|
3482
3706
|
# @return [Types::EmailGenerativeAnswerChunkDataDetails]
|
|
3483
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
|
+
#
|
|
3484
3724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
|
|
3485
3725
|
#
|
|
3486
3726
|
class DataDetails < Struct.new(
|
|
@@ -3492,6 +3732,10 @@ module Aws::QConnect
|
|
|
3492
3732
|
:email_response_chunk_data,
|
|
3493
3733
|
:email_overview_chunk_data,
|
|
3494
3734
|
:email_generative_answer_chunk_data,
|
|
3735
|
+
:case_summarization_chunk_data,
|
|
3736
|
+
:suggested_message_data,
|
|
3737
|
+
:notes_data,
|
|
3738
|
+
:notes_chunk_data,
|
|
3495
3739
|
:unknown)
|
|
3496
3740
|
SENSITIVE = []
|
|
3497
3741
|
include Aws::Structure
|
|
@@ -3505,6 +3749,10 @@ module Aws::QConnect
|
|
|
3505
3749
|
class EmailResponseChunkData < DataDetails; end
|
|
3506
3750
|
class EmailOverviewChunkData < DataDetails; end
|
|
3507
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
|
|
3508
3756
|
class Unknown < DataDetails; end
|
|
3509
3757
|
end
|
|
3510
3758
|
|
|
@@ -3520,11 +3768,16 @@ module Aws::QConnect
|
|
|
3520
3768
|
# Reference information about the generative content.
|
|
3521
3769
|
# @return [Types::GenerativeReference]
|
|
3522
3770
|
#
|
|
3771
|
+
# @!attribute [rw] suggested_message_reference
|
|
3772
|
+
# Reference information for suggested messages.
|
|
3773
|
+
# @return [Types::SuggestedMessageReference]
|
|
3774
|
+
#
|
|
3523
3775
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataReference AWS API Documentation
|
|
3524
3776
|
#
|
|
3525
3777
|
class DataReference < Struct.new(
|
|
3526
3778
|
:content_reference,
|
|
3527
3779
|
:generative_reference,
|
|
3780
|
+
:suggested_message_reference,
|
|
3528
3781
|
:unknown)
|
|
3529
3782
|
SENSITIVE = []
|
|
3530
3783
|
include Aws::Structure
|
|
@@ -3532,6 +3785,7 @@ module Aws::QConnect
|
|
|
3532
3785
|
|
|
3533
3786
|
class ContentReference < DataReference; end
|
|
3534
3787
|
class GenerativeReference < DataReference; end
|
|
3788
|
+
class SuggestedMessageReference < DataReference; end
|
|
3535
3789
|
class Unknown < DataReference; end
|
|
3536
3790
|
end
|
|
3537
3791
|
|
|
@@ -3953,8 +4207,7 @@ module Aws::QConnect
|
|
|
3953
4207
|
#
|
|
3954
4208
|
class DeleteQuickResponseResponse < Aws::EmptyStructure; end
|
|
3955
4209
|
|
|
3956
|
-
#
|
|
3957
|
-
# `connect:DecribeContact` as part of `CreateSession` with a contactArn.
|
|
4210
|
+
# The request failed because it depends on another request that failed.
|
|
3958
4211
|
#
|
|
3959
4212
|
# @!attribute [rw] message
|
|
3960
4213
|
# @return [String]
|
|
@@ -4375,6 +4628,27 @@ module Aws::QConnect
|
|
|
4375
4628
|
include Aws::Structure
|
|
4376
4629
|
end
|
|
4377
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)
|
|
4648
|
+
SENSITIVE = []
|
|
4649
|
+
include Aws::Structure
|
|
4650
|
+
end
|
|
4651
|
+
|
|
4378
4652
|
# The configuration information of the external data source.
|
|
4379
4653
|
#
|
|
4380
4654
|
# @!attribute [rw] source
|
|
@@ -4419,6 +4693,25 @@ module Aws::QConnect
|
|
|
4419
4693
|
include Aws::Structure
|
|
4420
4694
|
end
|
|
4421
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
|
+
|
|
4422
4715
|
# Configurations for when you choose fixed-size chunking. If you set the
|
|
4423
4716
|
# `chunkingStrategy` as `NONE`, exclude this field.
|
|
4424
4717
|
#
|
|
@@ -4923,6 +5216,10 @@ module Aws::QConnect
|
|
|
4923
5216
|
# The conversation data stored on an Amazon Q in Connect Session.
|
|
4924
5217
|
# @return [Array<Types::RuntimeSessionData>]
|
|
4925
5218
|
#
|
|
5219
|
+
# @!attribute [rw] chunked_response_terminated
|
|
5220
|
+
# Indicates whether the chunked response has been terminated.
|
|
5221
|
+
# @return [Boolean]
|
|
5222
|
+
#
|
|
4926
5223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetNextMessageResponse AWS API Documentation
|
|
4927
5224
|
#
|
|
4928
5225
|
class GetNextMessageResponse < Struct.new(
|
|
@@ -4931,7 +5228,8 @@ module Aws::QConnect
|
|
|
4931
5228
|
:request_message_id,
|
|
4932
5229
|
:conversation_state,
|
|
4933
5230
|
:next_message_token,
|
|
4934
|
-
:conversation_session_data
|
|
5231
|
+
:conversation_session_data,
|
|
5232
|
+
:chunked_response_terminated)
|
|
4935
5233
|
SENSITIVE = []
|
|
4936
5234
|
include Aws::Structure
|
|
4937
5235
|
end
|
|
@@ -4994,6 +5292,10 @@ module Aws::QConnect
|
|
|
4994
5292
|
# chunks.
|
|
4995
5293
|
# @return [String]
|
|
4996
5294
|
#
|
|
5295
|
+
# @!attribute [rw] recommendation_type
|
|
5296
|
+
# The type of recommendation being requested.
|
|
5297
|
+
# @return [String]
|
|
5298
|
+
#
|
|
4997
5299
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/GetRecommendationsRequest AWS API Documentation
|
|
4998
5300
|
#
|
|
4999
5301
|
class GetRecommendationsRequest < Struct.new(
|
|
@@ -5001,7 +5303,8 @@ module Aws::QConnect
|
|
|
5001
5303
|
:session_id,
|
|
5002
5304
|
:max_results,
|
|
5003
5305
|
:wait_time_seconds,
|
|
5004
|
-
:next_chunk_token
|
|
5306
|
+
:next_chunk_token,
|
|
5307
|
+
:recommendation_type)
|
|
5005
5308
|
SENSITIVE = []
|
|
5006
5309
|
include Aws::Structure
|
|
5007
5310
|
end
|
|
@@ -5722,11 +6025,16 @@ module Aws::QConnect
|
|
|
5722
6025
|
# The identifier of the detected intent.
|
|
5723
6026
|
# @return [String]
|
|
5724
6027
|
#
|
|
6028
|
+
# @!attribute [rw] relevance_level
|
|
6029
|
+
# The relevance level of the detected intent.
|
|
6030
|
+
# @return [String]
|
|
6031
|
+
#
|
|
5725
6032
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/IntentDetectedDataDetails AWS API Documentation
|
|
5726
6033
|
#
|
|
5727
6034
|
class IntentDetectedDataDetails < Struct.new(
|
|
5728
6035
|
:intent,
|
|
5729
|
-
:intent_id
|
|
6036
|
+
:intent_id,
|
|
6037
|
+
:relevance_level)
|
|
5730
6038
|
SENSITIVE = [:intent]
|
|
5731
6039
|
include Aws::Structure
|
|
5732
6040
|
end
|
|
@@ -5966,6 +6274,28 @@ module Aws::QConnect
|
|
|
5966
6274
|
include Aws::Structure
|
|
5967
6275
|
end
|
|
5968
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
|
+
|
|
5969
6299
|
# @!attribute [rw] assistant_id
|
|
5970
6300
|
# The identifier of the Amazon Q in Connect assistant. Can be either
|
|
5971
6301
|
# the ID or the ARN. URLs cannot contain the ARN.
|
|
@@ -6638,13 +6968,18 @@ module Aws::QConnect
|
|
|
6638
6968
|
# The maximum number of results to return per page.
|
|
6639
6969
|
# @return [Integer]
|
|
6640
6970
|
#
|
|
6971
|
+
# @!attribute [rw] filter
|
|
6972
|
+
# The filter criteria for listing messages.
|
|
6973
|
+
# @return [String]
|
|
6974
|
+
#
|
|
6641
6975
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListMessagesRequest AWS API Documentation
|
|
6642
6976
|
#
|
|
6643
6977
|
class ListMessagesRequest < Struct.new(
|
|
6644
6978
|
:assistant_id,
|
|
6645
6979
|
:session_id,
|
|
6646
6980
|
:next_token,
|
|
6647
|
-
:max_results
|
|
6981
|
+
:max_results,
|
|
6982
|
+
:filter)
|
|
6648
6983
|
SENSITIVE = []
|
|
6649
6984
|
include Aws::Structure
|
|
6650
6985
|
end
|
|
@@ -6712,6 +7047,50 @@ module Aws::QConnect
|
|
|
6712
7047
|
include Aws::Structure
|
|
6713
7048
|
end
|
|
6714
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
|
+
|
|
6715
7094
|
# @!attribute [rw] resource_arn
|
|
6716
7095
|
# The Amazon Resource Name (ARN) of the resource.
|
|
6717
7096
|
# @return [String]
|
|
@@ -6813,10 +7192,15 @@ module Aws::QConnect
|
|
|
6813
7192
|
# Generates a filler response when tool selection is `QUESTION`.
|
|
6814
7193
|
# @return [Boolean]
|
|
6815
7194
|
#
|
|
7195
|
+
# @!attribute [rw] generate_chunked_message
|
|
7196
|
+
# Configuration for generating chunked messages.
|
|
7197
|
+
# @return [Boolean]
|
|
7198
|
+
#
|
|
6816
7199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageConfiguration AWS API Documentation
|
|
6817
7200
|
#
|
|
6818
7201
|
class MessageConfiguration < Struct.new(
|
|
6819
|
-
:generate_filler_message
|
|
7202
|
+
:generate_filler_message,
|
|
7203
|
+
:generate_chunked_message)
|
|
6820
7204
|
SENSITIVE = []
|
|
6821
7205
|
include Aws::Structure
|
|
6822
7206
|
end
|
|
@@ -6831,16 +7215,22 @@ module Aws::QConnect
|
|
|
6831
7215
|
# The message data in text type.
|
|
6832
7216
|
# @return [Types::TextMessage]
|
|
6833
7217
|
#
|
|
7218
|
+
# @!attribute [rw] tool_use_result
|
|
7219
|
+
# The result of tool usage in the message.
|
|
7220
|
+
# @return [Types::ToolUseResultData]
|
|
7221
|
+
#
|
|
6834
7222
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/MessageData AWS API Documentation
|
|
6835
7223
|
#
|
|
6836
7224
|
class MessageData < Struct.new(
|
|
6837
7225
|
:text,
|
|
7226
|
+
:tool_use_result,
|
|
6838
7227
|
:unknown)
|
|
6839
7228
|
SENSITIVE = []
|
|
6840
7229
|
include Aws::Structure
|
|
6841
7230
|
include Aws::Structure::Union
|
|
6842
7231
|
|
|
6843
7232
|
class Text < MessageData; end
|
|
7233
|
+
class ToolUseResult < MessageData; end
|
|
6844
7234
|
class Unknown < MessageData; end
|
|
6845
7235
|
end
|
|
6846
7236
|
|
|
@@ -7590,6 +7980,64 @@ module Aws::QConnect
|
|
|
7590
7980
|
include Aws::Structure
|
|
7591
7981
|
end
|
|
7592
7982
|
|
|
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
|
+
|
|
7593
8041
|
# An error occurred when creating a recommendation.
|
|
7594
8042
|
#
|
|
7595
8043
|
# @!attribute [rw] recommendation_id
|
|
@@ -7681,20 +8129,75 @@ module Aws::QConnect
|
|
|
7681
8129
|
class Unknown < OrCondition; end
|
|
7682
8130
|
end
|
|
7683
8131
|
|
|
7684
|
-
#
|
|
7685
|
-
# converts the contents of each document into text before splitting it
|
|
7686
|
-
# into chunks. To improve processing of PDF files with tables and
|
|
7687
|
-
# images, you can configure the data source to convert the pages of text
|
|
7688
|
-
# into images and use a model to describe the contents of each page.
|
|
8132
|
+
# The configuration for AI Agents of type `ORCHESTRATION`.
|
|
7689
8133
|
#
|
|
7690
|
-
# @!attribute [rw]
|
|
7691
|
-
# The
|
|
8134
|
+
# @!attribute [rw] orchestration_ai_prompt_id
|
|
8135
|
+
# The AI Prompt identifier used by the Orchestration AI Agent.
|
|
7692
8136
|
# @return [String]
|
|
7693
8137
|
#
|
|
7694
|
-
# @!attribute [rw]
|
|
7695
|
-
#
|
|
7696
|
-
#
|
|
7697
|
-
#
|
|
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
|
+
|
|
8187
|
+
# Settings for parsing document contents. By default, the service
|
|
8188
|
+
# converts the contents of each document into text before splitting it
|
|
8189
|
+
# into chunks. To improve processing of PDF files with tables and
|
|
8190
|
+
# images, you can configure the data source to convert the pages of text
|
|
8191
|
+
# into images and use a model to describe the contents of each page.
|
|
8192
|
+
#
|
|
8193
|
+
# @!attribute [rw] parsing_strategy
|
|
8194
|
+
# The parsing strategy for the data source.
|
|
8195
|
+
# @return [String]
|
|
8196
|
+
#
|
|
8197
|
+
# @!attribute [rw] bedrock_foundation_model_configuration
|
|
8198
|
+
# Settings for a foundation model used to parse documents for a data
|
|
8199
|
+
# source.
|
|
8200
|
+
# @return [Types::BedrockFoundationModelConfigurationForParsing]
|
|
7698
8201
|
#
|
|
7699
8202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ParsingConfiguration AWS API Documentation
|
|
7700
8203
|
#
|
|
@@ -8266,11 +8769,16 @@ module Aws::QConnect
|
|
|
8266
8769
|
# Input information for the intent.
|
|
8267
8770
|
# @return [Types::IntentInputData]
|
|
8268
8771
|
#
|
|
8772
|
+
# @!attribute [rw] case_summarization_input_data
|
|
8773
|
+
# Input data for case summarization queries.
|
|
8774
|
+
# @return [Types::CaseSummarizationInputData]
|
|
8775
|
+
#
|
|
8269
8776
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryInputData AWS API Documentation
|
|
8270
8777
|
#
|
|
8271
8778
|
class QueryInputData < Struct.new(
|
|
8272
8779
|
:query_text_input_data,
|
|
8273
8780
|
:intent_input_data,
|
|
8781
|
+
:case_summarization_input_data,
|
|
8274
8782
|
:unknown)
|
|
8275
8783
|
SENSITIVE = []
|
|
8276
8784
|
include Aws::Structure
|
|
@@ -8278,6 +8786,7 @@ module Aws::QConnect
|
|
|
8278
8786
|
|
|
8279
8787
|
class QueryTextInputData < QueryInputData; end
|
|
8280
8788
|
class IntentInputData < QueryInputData; end
|
|
8789
|
+
class CaseSummarizationInputData < QueryInputData; end
|
|
8281
8790
|
class Unknown < QueryInputData; end
|
|
8282
8791
|
end
|
|
8283
8792
|
|
|
@@ -9006,11 +9515,16 @@ module Aws::QConnect
|
|
|
9006
9515
|
# Amazon Q in Connect Assistant.
|
|
9007
9516
|
# @return [String]
|
|
9008
9517
|
#
|
|
9518
|
+
# @!attribute [rw] orchestrator_use_case
|
|
9519
|
+
# The orchestrator use case for the AI Agent being removed.
|
|
9520
|
+
# @return [String]
|
|
9521
|
+
#
|
|
9009
9522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/RemoveAssistantAIAgentRequest AWS API Documentation
|
|
9010
9523
|
#
|
|
9011
9524
|
class RemoveAssistantAIAgentRequest < Struct.new(
|
|
9012
9525
|
:assistant_id,
|
|
9013
|
-
:ai_agent_type
|
|
9526
|
+
:ai_agent_type,
|
|
9527
|
+
:orchestrator_use_case)
|
|
9014
9528
|
SENSITIVE = []
|
|
9015
9529
|
include Aws::Structure
|
|
9016
9530
|
end
|
|
@@ -9191,6 +9705,195 @@ module Aws::QConnect
|
|
|
9191
9705
|
include Aws::Structure
|
|
9192
9706
|
end
|
|
9193
9707
|
|
|
9708
|
+
# Configuration for content retrieval operations.
|
|
9709
|
+
#
|
|
9710
|
+
# @!attribute [rw] knowledge_source
|
|
9711
|
+
# The knowledge source configuration for content retrieval.
|
|
9712
|
+
# @return [Types::KnowledgeSource]
|
|
9713
|
+
#
|
|
9714
|
+
# @!attribute [rw] filter
|
|
9715
|
+
# The filter configuration for content retrieval.
|
|
9716
|
+
# @return [Types::RetrievalFilterConfiguration]
|
|
9717
|
+
#
|
|
9718
|
+
# @!attribute [rw] number_of_results
|
|
9719
|
+
# The number of results to retrieve.
|
|
9720
|
+
# @return [Integer]
|
|
9721
|
+
#
|
|
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 = []
|
|
9735
|
+
include Aws::Structure
|
|
9736
|
+
end
|
|
9737
|
+
|
|
9738
|
+
# Configuration for filtering content during retrieval operations.
|
|
9739
|
+
#
|
|
9740
|
+
# @note RetrievalFilterConfiguration is a union - when making an API calls you must set exactly one of the members.
|
|
9741
|
+
#
|
|
9742
|
+
# @!attribute [rw] and_all
|
|
9743
|
+
# Filter configuration that requires all conditions to be met.
|
|
9744
|
+
# @return [Array<Types::RetrievalFilterConfiguration>]
|
|
9745
|
+
#
|
|
9746
|
+
# @!attribute [rw] equals
|
|
9747
|
+
# Filter configuration for exact equality matching.
|
|
9748
|
+
# @return [Types::FilterAttribute]
|
|
9749
|
+
#
|
|
9750
|
+
# @!attribute [rw] greater_than
|
|
9751
|
+
# Filter configuration for greater than comparison.
|
|
9752
|
+
# @return [Types::FilterAttribute]
|
|
9753
|
+
#
|
|
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
|
+
|
|
9194
9897
|
# The list of key-value pairs that are stored on the session.
|
|
9195
9898
|
#
|
|
9196
9899
|
# @!attribute [rw] key
|
|
@@ -9542,12 +10245,17 @@ module Aws::QConnect
|
|
|
9542
10245
|
# The bot response of the conversation history data.
|
|
9543
10246
|
# @return [String]
|
|
9544
10247
|
#
|
|
10248
|
+
# @!attribute [rw] timestamp
|
|
10249
|
+
# The timestamp of the conversation history entry.
|
|
10250
|
+
# @return [Time]
|
|
10251
|
+
#
|
|
9545
10252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SelfServiceConversationHistory AWS API Documentation
|
|
9546
10253
|
#
|
|
9547
10254
|
class SelfServiceConversationHistory < Struct.new(
|
|
9548
10255
|
:turn_number,
|
|
9549
10256
|
:input_transcript,
|
|
9550
|
-
:bot_response
|
|
10257
|
+
:bot_response,
|
|
10258
|
+
:timestamp)
|
|
9551
10259
|
SENSITIVE = [:input_transcript, :bot_response]
|
|
9552
10260
|
include Aws::Structure
|
|
9553
10261
|
end
|
|
@@ -9595,6 +10303,10 @@ module Aws::QConnect
|
|
|
9595
10303
|
# The message data to submit to the Amazon Q in Connect session.
|
|
9596
10304
|
# @return [Types::MessageInput]
|
|
9597
10305
|
#
|
|
10306
|
+
# @!attribute [rw] ai_agent_id
|
|
10307
|
+
# The identifier of the AI Agent to use for processing the message.
|
|
10308
|
+
# @return [String]
|
|
10309
|
+
#
|
|
9598
10310
|
# @!attribute [rw] conversation_context
|
|
9599
10311
|
# The conversation context before the Amazon Q in Connect session.
|
|
9600
10312
|
# @return [Types::ConversationContext]
|
|
@@ -9617,6 +10329,14 @@ module Aws::QConnect
|
|
|
9617
10329
|
# not need to pass this option.
|
|
9618
10330
|
# @return [String]
|
|
9619
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
|
+
#
|
|
9620
10340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SendMessageRequest AWS API Documentation
|
|
9621
10341
|
#
|
|
9622
10342
|
class SendMessageRequest < Struct.new(
|
|
@@ -9624,9 +10344,12 @@ module Aws::QConnect
|
|
|
9624
10344
|
:session_id,
|
|
9625
10345
|
:type,
|
|
9626
10346
|
:message,
|
|
10347
|
+
:ai_agent_id,
|
|
9627
10348
|
:conversation_context,
|
|
9628
10349
|
:configuration,
|
|
9629
|
-
:client_token
|
|
10350
|
+
:client_token,
|
|
10351
|
+
:orchestrator_use_case,
|
|
10352
|
+
:metadata)
|
|
9630
10353
|
SENSITIVE = []
|
|
9631
10354
|
include Aws::Structure
|
|
9632
10355
|
end
|
|
@@ -9742,6 +10465,10 @@ module Aws::QConnect
|
|
|
9742
10465
|
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_CreateSession.html
|
|
9743
10466
|
# @return [String]
|
|
9744
10467
|
#
|
|
10468
|
+
# @!attribute [rw] orchestrator_configuration_list
|
|
10469
|
+
# The list of orchestrator configurations for the session.
|
|
10470
|
+
# @return [Array<Types::OrchestratorConfigurationEntry>]
|
|
10471
|
+
#
|
|
9745
10472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SessionData AWS API Documentation
|
|
9746
10473
|
#
|
|
9747
10474
|
class SessionData < Struct.new(
|
|
@@ -9753,7 +10480,8 @@ module Aws::QConnect
|
|
|
9753
10480
|
:integration_configuration,
|
|
9754
10481
|
:tag_filter,
|
|
9755
10482
|
:ai_agent_configuration,
|
|
9756
|
-
:origin
|
|
10483
|
+
:origin,
|
|
10484
|
+
:orchestrator_configuration_list)
|
|
9757
10485
|
SENSITIVE = []
|
|
9758
10486
|
include Aws::Structure
|
|
9759
10487
|
end
|
|
@@ -9867,6 +10595,416 @@ module Aws::QConnect
|
|
|
9867
10595
|
include Aws::Structure
|
|
9868
10596
|
end
|
|
9869
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
|
|
10982
|
+
end
|
|
10983
|
+
|
|
10984
|
+
# Tool invocation message content
|
|
10985
|
+
#
|
|
10986
|
+
# @!attribute [rw] tool_use_id
|
|
10987
|
+
# Unique ID for this tool invocation
|
|
10988
|
+
# @return [String]
|
|
10989
|
+
#
|
|
10990
|
+
# @!attribute [rw] name
|
|
10991
|
+
# The tool name
|
|
10992
|
+
# @return [String]
|
|
10993
|
+
#
|
|
10994
|
+
# @!attribute [rw] arguments
|
|
10995
|
+
# The tool input arguments
|
|
10996
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
10997
|
+
#
|
|
10998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/SpanToolUseValue AWS API Documentation
|
|
10999
|
+
#
|
|
11000
|
+
class SpanToolUseValue < Struct.new(
|
|
11001
|
+
:tool_use_id,
|
|
11002
|
+
:name,
|
|
11003
|
+
:arguments)
|
|
11004
|
+
SENSITIVE = []
|
|
11005
|
+
include Aws::Structure
|
|
11006
|
+
end
|
|
11007
|
+
|
|
9870
11008
|
# @!attribute [rw] knowledge_base_id
|
|
9871
11009
|
# The identifier of the knowledge base. Can be either the ID or the
|
|
9872
11010
|
# ARN. URLs cannot contain the ARN.
|
|
@@ -9988,6 +11126,40 @@ module Aws::QConnect
|
|
|
9988
11126
|
include Aws::Structure
|
|
9989
11127
|
end
|
|
9990
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
|
+
|
|
9991
11163
|
# The system attributes that are used with the message template.
|
|
9992
11164
|
#
|
|
9993
11165
|
# @!attribute [rw] name
|
|
@@ -10107,6 +11279,36 @@ module Aws::QConnect
|
|
|
10107
11279
|
#
|
|
10108
11280
|
class TagResourceResponse < Aws::EmptyStructure; end
|
|
10109
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
|
+
|
|
10110
11312
|
# Details about the source content text data.
|
|
10111
11313
|
#
|
|
10112
11314
|
# @!attribute [rw] title
|
|
@@ -10147,10 +11349,20 @@ module Aws::QConnect
|
|
|
10147
11349
|
# The value of the message data in text type.
|
|
10148
11350
|
# @return [String]
|
|
10149
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
|
+
#
|
|
10150
11360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/TextMessage AWS API Documentation
|
|
10151
11361
|
#
|
|
10152
11362
|
class TextMessage < Struct.new(
|
|
10153
|
-
:value
|
|
11363
|
+
:value,
|
|
11364
|
+
:citations,
|
|
11365
|
+
:ai_guardrail_assessment)
|
|
10154
11366
|
SENSITIVE = [:value]
|
|
10155
11367
|
include Aws::Structure
|
|
10156
11368
|
end
|
|
@@ -10187,6 +11399,223 @@ module Aws::QConnect
|
|
|
10187
11399
|
include Aws::Structure
|
|
10188
11400
|
end
|
|
10189
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
|
+
|
|
10190
11619
|
# You do not have permission to perform this action.
|
|
10191
11620
|
#
|
|
10192
11621
|
# @!attribute [rw] message
|
|
@@ -10200,6 +11629,19 @@ module Aws::QConnect
|
|
|
10200
11629
|
include Aws::Structure
|
|
10201
11630
|
end
|
|
10202
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
|
+
|
|
10203
11645
|
# @!attribute [rw] resource_arn
|
|
10204
11646
|
# The Amazon Resource Name (ARN) of the resource.
|
|
10205
11647
|
# @return [String]
|
|
@@ -10421,6 +11863,10 @@ module Aws::QConnect
|
|
|
10421
11863
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt
|
|
10422
11864
|
# @return [String]
|
|
10423
11865
|
#
|
|
11866
|
+
# @!attribute [rw] inference_configuration
|
|
11867
|
+
# The updated inference configuration for the AI Prompt.
|
|
11868
|
+
# @return [Types::AIPromptInferenceConfiguration]
|
|
11869
|
+
#
|
|
10424
11870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAIPromptRequest AWS API Documentation
|
|
10425
11871
|
#
|
|
10426
11872
|
class UpdateAIPromptRequest < Struct.new(
|
|
@@ -10430,7 +11876,8 @@ module Aws::QConnect
|
|
|
10430
11876
|
:visibility_status,
|
|
10431
11877
|
:template_configuration,
|
|
10432
11878
|
:description,
|
|
10433
|
-
:model_id
|
|
11879
|
+
:model_id,
|
|
11880
|
+
:inference_configuration)
|
|
10434
11881
|
SENSITIVE = []
|
|
10435
11882
|
include Aws::Structure
|
|
10436
11883
|
end
|
|
@@ -10462,12 +11909,18 @@ module Aws::QConnect
|
|
|
10462
11909
|
# on the Amazon Q in Connect Assistant.
|
|
10463
11910
|
# @return [Types::AIAgentConfigurationData]
|
|
10464
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
|
+
#
|
|
10465
11917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateAssistantAIAgentRequest AWS API Documentation
|
|
10466
11918
|
#
|
|
10467
11919
|
class UpdateAssistantAIAgentRequest < Struct.new(
|
|
10468
11920
|
:assistant_id,
|
|
10469
11921
|
:ai_agent_type,
|
|
10470
|
-
:configuration
|
|
11922
|
+
:configuration,
|
|
11923
|
+
:orchestrator_configuration_list)
|
|
10471
11924
|
SENSITIVE = []
|
|
10472
11925
|
include Aws::Structure
|
|
10473
11926
|
end
|
|
@@ -10882,6 +12335,14 @@ module Aws::QConnect
|
|
|
10882
12335
|
# Session.
|
|
10883
12336
|
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
|
10884
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
|
+
#
|
|
10885
12346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/UpdateSessionRequest AWS API Documentation
|
|
10886
12347
|
#
|
|
10887
12348
|
class UpdateSessionRequest < Struct.new(
|
|
@@ -10889,7 +12350,9 @@ module Aws::QConnect
|
|
|
10889
12350
|
:session_id,
|
|
10890
12351
|
:description,
|
|
10891
12352
|
:tag_filter,
|
|
10892
|
-
:ai_agent_configuration
|
|
12353
|
+
:ai_agent_configuration,
|
|
12354
|
+
:orchestrator_configuration_list,
|
|
12355
|
+
:remove_orchestrator_configuration_list)
|
|
10893
12356
|
SENSITIVE = []
|
|
10894
12357
|
include Aws::Structure
|
|
10895
12358
|
end
|
|
@@ -10921,6 +12384,20 @@ module Aws::QConnect
|
|
|
10921
12384
|
include Aws::Structure
|
|
10922
12385
|
end
|
|
10923
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
|
+
|
|
10924
12401
|
# The input fails to satisfy the constraints specified by a service.
|
|
10925
12402
|
#
|
|
10926
12403
|
# @!attribute [rw] message
|