aws-sdk-qconnect 1.40.0 → 1.41.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 +472 -30
- data/lib/aws-sdk-qconnect/client_api.rb +53 -0
- data/lib/aws-sdk-qconnect/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-qconnect/errors.rb +16 -0
- data/lib/aws-sdk-qconnect/types.rb +239 -3
- data/lib/aws-sdk-qconnect.rb +1 -1
- data/sig/client.rbs +188 -7
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +80 -15
- metadata +1 -1
@@ -182,15 +182,22 @@ module Aws::QConnect
|
|
182
182
|
DeleteMessageTemplateResponse = Shapes::StructureShape.new(name: 'DeleteMessageTemplateResponse')
|
183
183
|
DeleteQuickResponseRequest = Shapes::StructureShape.new(name: 'DeleteQuickResponseRequest')
|
184
184
|
DeleteQuickResponseResponse = Shapes::StructureShape.new(name: 'DeleteQuickResponseResponse')
|
185
|
+
DependencyFailedException = Shapes::StructureShape.new(name: 'DependencyFailedException')
|
185
186
|
Description = Shapes::StringShape.new(name: 'Description')
|
186
187
|
Document = Shapes::StructureShape.new(name: 'Document')
|
187
188
|
DocumentText = Shapes::StructureShape.new(name: 'DocumentText')
|
189
|
+
EmailGenerativeAnswerAIAgentConfiguration = Shapes::StructureShape.new(name: 'EmailGenerativeAnswerAIAgentConfiguration')
|
190
|
+
EmailGenerativeAnswerChunkDataDetails = Shapes::StructureShape.new(name: 'EmailGenerativeAnswerChunkDataDetails')
|
188
191
|
EmailHeader = Shapes::StructureShape.new(name: 'EmailHeader')
|
189
192
|
EmailHeaderKey = Shapes::StringShape.new(name: 'EmailHeaderKey')
|
190
193
|
EmailHeaderValue = Shapes::StringShape.new(name: 'EmailHeaderValue')
|
191
194
|
EmailHeaders = Shapes::ListShape.new(name: 'EmailHeaders')
|
192
195
|
EmailMessageTemplateContent = Shapes::StructureShape.new(name: 'EmailMessageTemplateContent')
|
193
196
|
EmailMessageTemplateContentBody = Shapes::StructureShape.new(name: 'EmailMessageTemplateContentBody')
|
197
|
+
EmailOverviewAIAgentConfiguration = Shapes::StructureShape.new(name: 'EmailOverviewAIAgentConfiguration')
|
198
|
+
EmailOverviewChunkDataDetails = Shapes::StructureShape.new(name: 'EmailOverviewChunkDataDetails')
|
199
|
+
EmailResponseAIAgentConfiguration = Shapes::StructureShape.new(name: 'EmailResponseAIAgentConfiguration')
|
200
|
+
EmailResponseChunkDataDetails = Shapes::StructureShape.new(name: 'EmailResponseChunkDataDetails')
|
194
201
|
ExtendedMessageTemplateData = Shapes::StructureShape.new(name: 'ExtendedMessageTemplateData')
|
195
202
|
ExternalSource = Shapes::StringShape.new(name: 'ExternalSource')
|
196
203
|
ExternalSourceConfiguration = Shapes::StructureShape.new(name: 'ExternalSourceConfiguration')
|
@@ -573,10 +580,16 @@ module Aws::QConnect
|
|
573
580
|
AIAgentConfiguration.add_member(:manual_search_ai_agent_configuration, Shapes::ShapeRef.new(shape: ManualSearchAIAgentConfiguration, location_name: "manualSearchAIAgentConfiguration"))
|
574
581
|
AIAgentConfiguration.add_member(:answer_recommendation_ai_agent_configuration, Shapes::ShapeRef.new(shape: AnswerRecommendationAIAgentConfiguration, location_name: "answerRecommendationAIAgentConfiguration"))
|
575
582
|
AIAgentConfiguration.add_member(:self_service_ai_agent_configuration, Shapes::ShapeRef.new(shape: SelfServiceAIAgentConfiguration, location_name: "selfServiceAIAgentConfiguration"))
|
583
|
+
AIAgentConfiguration.add_member(:email_response_ai_agent_configuration, Shapes::ShapeRef.new(shape: EmailResponseAIAgentConfiguration, location_name: "emailResponseAIAgentConfiguration"))
|
584
|
+
AIAgentConfiguration.add_member(:email_overview_ai_agent_configuration, Shapes::ShapeRef.new(shape: EmailOverviewAIAgentConfiguration, location_name: "emailOverviewAIAgentConfiguration"))
|
585
|
+
AIAgentConfiguration.add_member(:email_generative_answer_ai_agent_configuration, Shapes::ShapeRef.new(shape: EmailGenerativeAnswerAIAgentConfiguration, location_name: "emailGenerativeAnswerAIAgentConfiguration"))
|
576
586
|
AIAgentConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
577
587
|
AIAgentConfiguration.add_member_subclass(:manual_search_ai_agent_configuration, Types::AIAgentConfiguration::ManualSearchAiAgentConfiguration)
|
578
588
|
AIAgentConfiguration.add_member_subclass(:answer_recommendation_ai_agent_configuration, Types::AIAgentConfiguration::AnswerRecommendationAiAgentConfiguration)
|
579
589
|
AIAgentConfiguration.add_member_subclass(:self_service_ai_agent_configuration, Types::AIAgentConfiguration::SelfServiceAiAgentConfiguration)
|
590
|
+
AIAgentConfiguration.add_member_subclass(:email_response_ai_agent_configuration, Types::AIAgentConfiguration::EmailResponseAiAgentConfiguration)
|
591
|
+
AIAgentConfiguration.add_member_subclass(:email_overview_ai_agent_configuration, Types::AIAgentConfiguration::EmailOverviewAiAgentConfiguration)
|
592
|
+
AIAgentConfiguration.add_member_subclass(:email_generative_answer_ai_agent_configuration, Types::AIAgentConfiguration::EmailGenerativeAnswerAiAgentConfiguration)
|
580
593
|
AIAgentConfiguration.add_member_subclass(:unknown, Types::AIAgentConfiguration::Unknown)
|
581
594
|
AIAgentConfiguration.struct_class = Types::AIAgentConfiguration
|
582
595
|
|
@@ -1158,6 +1171,7 @@ module Aws::QConnect
|
|
1158
1171
|
CreateSessionRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
|
1159
1172
|
CreateSessionRequest.add_member(:tag_filter, Shapes::ShapeRef.new(shape: TagFilter, location_name: "tagFilter"))
|
1160
1173
|
CreateSessionRequest.add_member(:ai_agent_configuration, Shapes::ShapeRef.new(shape: AIAgentConfigurationMap, location_name: "aiAgentConfiguration"))
|
1174
|
+
CreateSessionRequest.add_member(:contact_arn, Shapes::ShapeRef.new(shape: GenericArn, location_name: "contactArn"))
|
1161
1175
|
CreateSessionRequest.struct_class = Types::CreateSessionRequest
|
1162
1176
|
|
1163
1177
|
CreateSessionResponse.add_member(:session, Shapes::ShapeRef.new(shape: SessionData, location_name: "session"))
|
@@ -1231,12 +1245,18 @@ module Aws::QConnect
|
|
1231
1245
|
DataDetails.add_member(:intent_detected_data, Shapes::ShapeRef.new(shape: IntentDetectedDataDetails, location_name: "intentDetectedData"))
|
1232
1246
|
DataDetails.add_member(:source_content_data, Shapes::ShapeRef.new(shape: SourceContentDataDetails, location_name: "sourceContentData"))
|
1233
1247
|
DataDetails.add_member(:generative_chunk_data, Shapes::ShapeRef.new(shape: GenerativeChunkDataDetails, location_name: "generativeChunkData"))
|
1248
|
+
DataDetails.add_member(:email_response_chunk_data, Shapes::ShapeRef.new(shape: EmailResponseChunkDataDetails, location_name: "emailResponseChunkData"))
|
1249
|
+
DataDetails.add_member(:email_overview_chunk_data, Shapes::ShapeRef.new(shape: EmailOverviewChunkDataDetails, location_name: "emailOverviewChunkData"))
|
1250
|
+
DataDetails.add_member(:email_generative_answer_chunk_data, Shapes::ShapeRef.new(shape: EmailGenerativeAnswerChunkDataDetails, location_name: "emailGenerativeAnswerChunkData"))
|
1234
1251
|
DataDetails.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
1235
1252
|
DataDetails.add_member_subclass(:content_data, Types::DataDetails::ContentData)
|
1236
1253
|
DataDetails.add_member_subclass(:generative_data, Types::DataDetails::GenerativeData)
|
1237
1254
|
DataDetails.add_member_subclass(:intent_detected_data, Types::DataDetails::IntentDetectedData)
|
1238
1255
|
DataDetails.add_member_subclass(:source_content_data, Types::DataDetails::SourceContentData)
|
1239
1256
|
DataDetails.add_member_subclass(:generative_chunk_data, Types::DataDetails::GenerativeChunkData)
|
1257
|
+
DataDetails.add_member_subclass(:email_response_chunk_data, Types::DataDetails::EmailResponseChunkData)
|
1258
|
+
DataDetails.add_member_subclass(:email_overview_chunk_data, Types::DataDetails::EmailOverviewChunkData)
|
1259
|
+
DataDetails.add_member_subclass(:email_generative_answer_chunk_data, Types::DataDetails::EmailGenerativeAnswerChunkData)
|
1240
1260
|
DataDetails.add_member_subclass(:unknown, Types::DataDetails::Unknown)
|
1241
1261
|
DataDetails.struct_class = Types::DataDetails
|
1242
1262
|
|
@@ -1357,6 +1377,9 @@ module Aws::QConnect
|
|
1357
1377
|
|
1358
1378
|
DeleteQuickResponseResponse.struct_class = Types::DeleteQuickResponseResponse
|
1359
1379
|
|
1380
|
+
DependencyFailedException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "message"))
|
1381
|
+
DependencyFailedException.struct_class = Types::DependencyFailedException
|
1382
|
+
|
1360
1383
|
Document.add_member(:content_reference, Shapes::ShapeRef.new(shape: ContentReference, required: true, location_name: "contentReference"))
|
1361
1384
|
Document.add_member(:title, Shapes::ShapeRef.new(shape: DocumentText, location_name: "title"))
|
1362
1385
|
Document.add_member(:excerpt, Shapes::ShapeRef.new(shape: DocumentText, location_name: "excerpt"))
|
@@ -1366,6 +1389,17 @@ module Aws::QConnect
|
|
1366
1389
|
DocumentText.add_member(:highlights, Shapes::ShapeRef.new(shape: Highlights, location_name: "highlights"))
|
1367
1390
|
DocumentText.struct_class = Types::DocumentText
|
1368
1391
|
|
1392
|
+
EmailGenerativeAnswerAIAgentConfiguration.add_member(:email_generative_answer_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "emailGenerativeAnswerAIPromptId"))
|
1393
|
+
EmailGenerativeAnswerAIAgentConfiguration.add_member(:email_query_reformulation_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "emailQueryReformulationAIPromptId"))
|
1394
|
+
EmailGenerativeAnswerAIAgentConfiguration.add_member(:locale, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "locale"))
|
1395
|
+
EmailGenerativeAnswerAIAgentConfiguration.add_member(:association_configurations, Shapes::ShapeRef.new(shape: AssociationConfigurationList, location_name: "associationConfigurations"))
|
1396
|
+
EmailGenerativeAnswerAIAgentConfiguration.struct_class = Types::EmailGenerativeAnswerAIAgentConfiguration
|
1397
|
+
|
1398
|
+
EmailGenerativeAnswerChunkDataDetails.add_member(:completion, Shapes::ShapeRef.new(shape: NonEmptySensitiveString, location_name: "completion"))
|
1399
|
+
EmailGenerativeAnswerChunkDataDetails.add_member(:references, Shapes::ShapeRef.new(shape: DataSummaryList, location_name: "references"))
|
1400
|
+
EmailGenerativeAnswerChunkDataDetails.add_member(:next_chunk_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextChunkToken"))
|
1401
|
+
EmailGenerativeAnswerChunkDataDetails.struct_class = Types::EmailGenerativeAnswerChunkDataDetails
|
1402
|
+
|
1369
1403
|
EmailHeader.add_member(:name, Shapes::ShapeRef.new(shape: EmailHeaderKey, location_name: "name"))
|
1370
1404
|
EmailHeader.add_member(:value, Shapes::ShapeRef.new(shape: EmailHeaderValue, location_name: "value"))
|
1371
1405
|
EmailHeader.struct_class = Types::EmailHeader
|
@@ -1381,6 +1415,24 @@ module Aws::QConnect
|
|
1381
1415
|
EmailMessageTemplateContentBody.add_member(:html, Shapes::ShapeRef.new(shape: MessageTemplateBodyContentProvider, location_name: "html"))
|
1382
1416
|
EmailMessageTemplateContentBody.struct_class = Types::EmailMessageTemplateContentBody
|
1383
1417
|
|
1418
|
+
EmailOverviewAIAgentConfiguration.add_member(:email_overview_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "emailOverviewAIPromptId"))
|
1419
|
+
EmailOverviewAIAgentConfiguration.add_member(:locale, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "locale"))
|
1420
|
+
EmailOverviewAIAgentConfiguration.struct_class = Types::EmailOverviewAIAgentConfiguration
|
1421
|
+
|
1422
|
+
EmailOverviewChunkDataDetails.add_member(:completion, Shapes::ShapeRef.new(shape: NonEmptySensitiveString, location_name: "completion"))
|
1423
|
+
EmailOverviewChunkDataDetails.add_member(:next_chunk_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextChunkToken"))
|
1424
|
+
EmailOverviewChunkDataDetails.struct_class = Types::EmailOverviewChunkDataDetails
|
1425
|
+
|
1426
|
+
EmailResponseAIAgentConfiguration.add_member(:email_response_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "emailResponseAIPromptId"))
|
1427
|
+
EmailResponseAIAgentConfiguration.add_member(:email_query_reformulation_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "emailQueryReformulationAIPromptId"))
|
1428
|
+
EmailResponseAIAgentConfiguration.add_member(:locale, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "locale"))
|
1429
|
+
EmailResponseAIAgentConfiguration.add_member(:association_configurations, Shapes::ShapeRef.new(shape: AssociationConfigurationList, location_name: "associationConfigurations"))
|
1430
|
+
EmailResponseAIAgentConfiguration.struct_class = Types::EmailResponseAIAgentConfiguration
|
1431
|
+
|
1432
|
+
EmailResponseChunkDataDetails.add_member(:completion, Shapes::ShapeRef.new(shape: NonEmptySensitiveString, location_name: "completion"))
|
1433
|
+
EmailResponseChunkDataDetails.add_member(:next_chunk_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextChunkToken"))
|
1434
|
+
EmailResponseChunkDataDetails.struct_class = Types::EmailResponseChunkDataDetails
|
1435
|
+
|
1384
1436
|
ExtendedMessageTemplateData.add_member(:message_template_arn, Shapes::ShapeRef.new(shape: ArnWithQualifier, required: true, location_name: "messageTemplateArn"))
|
1385
1437
|
ExtendedMessageTemplateData.add_member(:message_template_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "messageTemplateId"))
|
1386
1438
|
ExtendedMessageTemplateData.add_member(:knowledge_base_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "knowledgeBaseArn"))
|
@@ -2921,6 +2973,7 @@ module Aws::QConnect
|
|
2921
2973
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
2922
2974
|
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
2923
2975
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
2976
|
+
o.errors << Shapes::ShapeRef.new(shape: DependencyFailedException)
|
2924
2977
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
2925
2978
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2926
2979
|
end)
|
@@ -13,22 +13,22 @@ module Aws::QConnect
|
|
13
13
|
# @!attribute region
|
14
14
|
# The AWS region used to dispatch the request.
|
15
15
|
#
|
16
|
-
# @return [
|
16
|
+
# @return [string]
|
17
17
|
#
|
18
18
|
# @!attribute use_dual_stack
|
19
19
|
# When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
|
20
20
|
#
|
21
|
-
# @return [
|
21
|
+
# @return [boolean]
|
22
22
|
#
|
23
23
|
# @!attribute use_fips
|
24
24
|
# When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
|
25
25
|
#
|
26
|
-
# @return [
|
26
|
+
# @return [boolean]
|
27
27
|
#
|
28
28
|
# @!attribute endpoint
|
29
29
|
# Override the endpoint used to send this request
|
30
30
|
#
|
31
|
-
# @return [
|
31
|
+
# @return [string]
|
32
32
|
#
|
33
33
|
EndpointParameters = Struct.new(
|
34
34
|
:region,
|
@@ -29,6 +29,7 @@ module Aws::QConnect
|
|
29
29
|
# ## Error Classes
|
30
30
|
# * {AccessDeniedException}
|
31
31
|
# * {ConflictException}
|
32
|
+
# * {DependencyFailedException}
|
32
33
|
# * {PreconditionFailedException}
|
33
34
|
# * {RequestTimeoutException}
|
34
35
|
# * {ResourceNotFoundException}
|
@@ -74,6 +75,21 @@ module Aws::QConnect
|
|
74
75
|
end
|
75
76
|
end
|
76
77
|
|
78
|
+
class DependencyFailedException < ServiceError
|
79
|
+
|
80
|
+
# @param [Seahorse::Client::RequestContext] context
|
81
|
+
# @param [String] message
|
82
|
+
# @param [Aws::QConnect::Types::DependencyFailedException] data
|
83
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
84
|
+
super(context, message, data)
|
85
|
+
end
|
86
|
+
|
87
|
+
# @return [String]
|
88
|
+
def message
|
89
|
+
@message || @data[:message]
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
77
93
|
class PreconditionFailedException < ServiceError
|
78
94
|
|
79
95
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -29,12 +29,30 @@ module Aws::QConnect
|
|
29
29
|
# The configuration for AI Agents of type SELF\_SERVICE.
|
30
30
|
# @return [Types::SelfServiceAIAgentConfiguration]
|
31
31
|
#
|
32
|
+
# @!attribute [rw] email_response_ai_agent_configuration
|
33
|
+
# Configuration for the EMAIL\_RESPONSE AI agent that generates
|
34
|
+
# professional email responses using knowledge base content.
|
35
|
+
# @return [Types::EmailResponseAIAgentConfiguration]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] email_overview_ai_agent_configuration
|
38
|
+
# Configuration for the EMAIL\_OVERVIEW AI agent that generates
|
39
|
+
# structured overview of email conversations.
|
40
|
+
# @return [Types::EmailOverviewAIAgentConfiguration]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] email_generative_answer_ai_agent_configuration
|
43
|
+
# Configuration for the EMAIL\_GENERATIVE\_ANSWER AI agent that
|
44
|
+
# provides comprehensive knowledge-based answers for customer queries.
|
45
|
+
# @return [Types::EmailGenerativeAnswerAIAgentConfiguration]
|
46
|
+
#
|
32
47
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/AIAgentConfiguration AWS API Documentation
|
33
48
|
#
|
34
49
|
class AIAgentConfiguration < Struct.new(
|
35
50
|
:manual_search_ai_agent_configuration,
|
36
51
|
:answer_recommendation_ai_agent_configuration,
|
37
52
|
:self_service_ai_agent_configuration,
|
53
|
+
:email_response_ai_agent_configuration,
|
54
|
+
:email_overview_ai_agent_configuration,
|
55
|
+
:email_generative_answer_ai_agent_configuration,
|
38
56
|
:unknown)
|
39
57
|
SENSITIVE = []
|
40
58
|
include Aws::Structure
|
@@ -43,6 +61,9 @@ module Aws::QConnect
|
|
43
61
|
class ManualSearchAiAgentConfiguration < AIAgentConfiguration; end
|
44
62
|
class AnswerRecommendationAiAgentConfiguration < AIAgentConfiguration; end
|
45
63
|
class SelfServiceAiAgentConfiguration < AIAgentConfiguration; end
|
64
|
+
class EmailResponseAiAgentConfiguration < AIAgentConfiguration; end
|
65
|
+
class EmailOverviewAiAgentConfiguration < AIAgentConfiguration; end
|
66
|
+
class EmailGenerativeAnswerAiAgentConfiguration < AIAgentConfiguration; end
|
46
67
|
class Unknown < AIAgentConfiguration; end
|
47
68
|
end
|
48
69
|
|
@@ -2251,6 +2272,16 @@ module Aws::QConnect
|
|
2251
2272
|
#
|
2252
2273
|
# @!attribute [rw] model_id
|
2253
2274
|
# The identifier of the model used for this AI Prompt.
|
2275
|
+
#
|
2276
|
+
# <note markdown="1"> For information about which models are supported in each Amazon Web
|
2277
|
+
# Services Region, see [Supported models for system/custom
|
2278
|
+
# prompts][1].
|
2279
|
+
#
|
2280
|
+
# </note>
|
2281
|
+
#
|
2282
|
+
#
|
2283
|
+
#
|
2284
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt
|
2254
2285
|
# @return [String]
|
2255
2286
|
#
|
2256
2287
|
# @!attribute [rw] api_format
|
@@ -3070,6 +3101,12 @@ module Aws::QConnect
|
|
3070
3101
|
# Session.
|
3071
3102
|
# @return [Hash<String,Types::AIAgentConfigurationData>]
|
3072
3103
|
#
|
3104
|
+
# @!attribute [rw] contact_arn
|
3105
|
+
# The Amazon Resource Name (ARN) of the email contact in Amazon
|
3106
|
+
# Connect. Used to retrieve email content and establish session
|
3107
|
+
# context for AI-powered email assistance.
|
3108
|
+
# @return [String]
|
3109
|
+
#
|
3073
3110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/CreateSessionRequest AWS API Documentation
|
3074
3111
|
#
|
3075
3112
|
class CreateSessionRequest < Struct.new(
|
@@ -3079,7 +3116,8 @@ module Aws::QConnect
|
|
3079
3116
|
:description,
|
3080
3117
|
:tags,
|
3081
3118
|
:tag_filter,
|
3082
|
-
:ai_agent_configuration
|
3119
|
+
:ai_agent_configuration,
|
3120
|
+
:contact_arn)
|
3083
3121
|
SENSITIVE = []
|
3084
3122
|
include Aws::Structure
|
3085
3123
|
end
|
@@ -3422,6 +3460,21 @@ module Aws::QConnect
|
|
3422
3460
|
# Details about the generative chunk data.
|
3423
3461
|
# @return [Types::GenerativeChunkDataDetails]
|
3424
3462
|
#
|
3463
|
+
# @!attribute [rw] email_response_chunk_data
|
3464
|
+
# Streaming chunk data for email response generation containing
|
3465
|
+
# partial response content.
|
3466
|
+
# @return [Types::EmailResponseChunkDataDetails]
|
3467
|
+
#
|
3468
|
+
# @!attribute [rw] email_overview_chunk_data
|
3469
|
+
# Streaming chunk data for email overview containing partial overview
|
3470
|
+
# content.
|
3471
|
+
# @return [Types::EmailOverviewChunkDataDetails]
|
3472
|
+
#
|
3473
|
+
# @!attribute [rw] email_generative_answer_chunk_data
|
3474
|
+
# Streaming chunk data for email generative answers containing partial
|
3475
|
+
# knowledge-based response content.
|
3476
|
+
# @return [Types::EmailGenerativeAnswerChunkDataDetails]
|
3477
|
+
#
|
3425
3478
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DataDetails AWS API Documentation
|
3426
3479
|
#
|
3427
3480
|
class DataDetails < Struct.new(
|
@@ -3430,6 +3483,9 @@ module Aws::QConnect
|
|
3430
3483
|
:intent_detected_data,
|
3431
3484
|
:source_content_data,
|
3432
3485
|
:generative_chunk_data,
|
3486
|
+
:email_response_chunk_data,
|
3487
|
+
:email_overview_chunk_data,
|
3488
|
+
:email_generative_answer_chunk_data,
|
3433
3489
|
:unknown)
|
3434
3490
|
SENSITIVE = []
|
3435
3491
|
include Aws::Structure
|
@@ -3440,6 +3496,9 @@ module Aws::QConnect
|
|
3440
3496
|
class IntentDetectedData < DataDetails; end
|
3441
3497
|
class SourceContentData < DataDetails; end
|
3442
3498
|
class GenerativeChunkData < DataDetails; end
|
3499
|
+
class EmailResponseChunkData < DataDetails; end
|
3500
|
+
class EmailOverviewChunkData < DataDetails; end
|
3501
|
+
class EmailGenerativeAnswerChunkData < DataDetails; end
|
3443
3502
|
class Unknown < DataDetails; end
|
3444
3503
|
end
|
3445
3504
|
|
@@ -3888,6 +3947,20 @@ module Aws::QConnect
|
|
3888
3947
|
#
|
3889
3948
|
class DeleteQuickResponseResponse < Aws::EmptyStructure; end
|
3890
3949
|
|
3950
|
+
# An error occurred while calling a dependency. For example, calling
|
3951
|
+
# `connect:DecribeContact` as part of `CreateSession` with a contactArn.
|
3952
|
+
#
|
3953
|
+
# @!attribute [rw] message
|
3954
|
+
# @return [String]
|
3955
|
+
#
|
3956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/DependencyFailedException AWS API Documentation
|
3957
|
+
#
|
3958
|
+
class DependencyFailedException < Struct.new(
|
3959
|
+
:message)
|
3960
|
+
SENSITIVE = []
|
3961
|
+
include Aws::Structure
|
3962
|
+
end
|
3963
|
+
|
3891
3964
|
# The document.
|
3892
3965
|
#
|
3893
3966
|
# @!attribute [rw] content_reference
|
@@ -3931,6 +4004,68 @@ module Aws::QConnect
|
|
3931
4004
|
include Aws::Structure
|
3932
4005
|
end
|
3933
4006
|
|
4007
|
+
# Configuration settings for the EMAIL\_GENERATIVE\_ANSWER AI agent
|
4008
|
+
# including prompts, locale, and knowledge base associations.
|
4009
|
+
#
|
4010
|
+
# @!attribute [rw] email_generative_answer_ai_prompt_id
|
4011
|
+
# The ID of the System AI prompt used for generating comprehensive
|
4012
|
+
# knowledge-based answers from email queries.
|
4013
|
+
# @return [String]
|
4014
|
+
#
|
4015
|
+
# @!attribute [rw] email_query_reformulation_ai_prompt_id
|
4016
|
+
# The ID of the System AI prompt used for reformulating email queries
|
4017
|
+
# to optimize knowledge base search results.
|
4018
|
+
# @return [String]
|
4019
|
+
#
|
4020
|
+
# @!attribute [rw] locale
|
4021
|
+
# The locale setting for language-specific email processing and
|
4022
|
+
# response generation (for example, en\_US, es\_ES).
|
4023
|
+
# @return [String]
|
4024
|
+
#
|
4025
|
+
# @!attribute [rw] association_configurations
|
4026
|
+
# Configuration settings for knowledge base associations used by the
|
4027
|
+
# email generative answer agent.
|
4028
|
+
# @return [Array<Types::AssociationConfiguration>]
|
4029
|
+
#
|
4030
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailGenerativeAnswerAIAgentConfiguration AWS API Documentation
|
4031
|
+
#
|
4032
|
+
class EmailGenerativeAnswerAIAgentConfiguration < Struct.new(
|
4033
|
+
:email_generative_answer_ai_prompt_id,
|
4034
|
+
:email_query_reformulation_ai_prompt_id,
|
4035
|
+
:locale,
|
4036
|
+
:association_configurations)
|
4037
|
+
SENSITIVE = []
|
4038
|
+
include Aws::Structure
|
4039
|
+
end
|
4040
|
+
|
4041
|
+
# Details of streaming chunk data for email generative answers including
|
4042
|
+
# completion text and references.
|
4043
|
+
#
|
4044
|
+
# @!attribute [rw] completion
|
4045
|
+
# The partial or complete text content of the generative answer
|
4046
|
+
# response.
|
4047
|
+
# @return [String]
|
4048
|
+
#
|
4049
|
+
# @!attribute [rw] references
|
4050
|
+
# Source references and citations from knowledge base articles used to
|
4051
|
+
# generate the answer.
|
4052
|
+
# @return [Array<Types::DataSummary>]
|
4053
|
+
#
|
4054
|
+
# @!attribute [rw] next_chunk_token
|
4055
|
+
# Token for retrieving the next chunk of streaming response data, if
|
4056
|
+
# available.
|
4057
|
+
# @return [String]
|
4058
|
+
#
|
4059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailGenerativeAnswerChunkDataDetails AWS API Documentation
|
4060
|
+
#
|
4061
|
+
class EmailGenerativeAnswerChunkDataDetails < Struct.new(
|
4062
|
+
:completion,
|
4063
|
+
:references,
|
4064
|
+
:next_chunk_token)
|
4065
|
+
SENSITIVE = [:completion]
|
4066
|
+
include Aws::Structure
|
4067
|
+
end
|
4068
|
+
|
3934
4069
|
# The email header to include in email messages.
|
3935
4070
|
#
|
3936
4071
|
# @!attribute [rw] name
|
@@ -4001,6 +4136,106 @@ module Aws::QConnect
|
|
4001
4136
|
include Aws::Structure
|
4002
4137
|
end
|
4003
4138
|
|
4139
|
+
# Configuration settings for the EMAIL\_OVERVIEW AI agent including
|
4140
|
+
# prompt ID and locale settings.
|
4141
|
+
#
|
4142
|
+
# @!attribute [rw] email_overview_ai_prompt_id
|
4143
|
+
# The ID of the System AI prompt used for generating structured email
|
4144
|
+
# conversation summaries.
|
4145
|
+
# @return [String]
|
4146
|
+
#
|
4147
|
+
# @!attribute [rw] locale
|
4148
|
+
# The locale setting for language-specific email overview processing
|
4149
|
+
# (for example, en\_US, es\_ES).
|
4150
|
+
# @return [String]
|
4151
|
+
#
|
4152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailOverviewAIAgentConfiguration AWS API Documentation
|
4153
|
+
#
|
4154
|
+
class EmailOverviewAIAgentConfiguration < Struct.new(
|
4155
|
+
:email_overview_ai_prompt_id,
|
4156
|
+
:locale)
|
4157
|
+
SENSITIVE = []
|
4158
|
+
include Aws::Structure
|
4159
|
+
end
|
4160
|
+
|
4161
|
+
# Details of streaming chunk data for email overview including
|
4162
|
+
# completion text and pagination tokens.
|
4163
|
+
#
|
4164
|
+
# @!attribute [rw] completion
|
4165
|
+
# The partial or complete overview text content in structured HTML
|
4166
|
+
# format with customer issues, resolutions, and next steps.
|
4167
|
+
# @return [String]
|
4168
|
+
#
|
4169
|
+
# @!attribute [rw] next_chunk_token
|
4170
|
+
# Token for retrieving the next chunk of streaming overview data, if
|
4171
|
+
# available.
|
4172
|
+
# @return [String]
|
4173
|
+
#
|
4174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailOverviewChunkDataDetails AWS API Documentation
|
4175
|
+
#
|
4176
|
+
class EmailOverviewChunkDataDetails < Struct.new(
|
4177
|
+
:completion,
|
4178
|
+
:next_chunk_token)
|
4179
|
+
SENSITIVE = [:completion]
|
4180
|
+
include Aws::Structure
|
4181
|
+
end
|
4182
|
+
|
4183
|
+
# Configuration settings for the EMAIL\_RESPONSE AI agent including
|
4184
|
+
# prompts, locale, and knowledge base associations.
|
4185
|
+
#
|
4186
|
+
# @!attribute [rw] email_response_ai_prompt_id
|
4187
|
+
# The ID of the System AI prompt used for generating professional
|
4188
|
+
# email responses based on knowledge base content.
|
4189
|
+
# @return [String]
|
4190
|
+
#
|
4191
|
+
# @!attribute [rw] email_query_reformulation_ai_prompt_id
|
4192
|
+
# The ID of the System AI prompt used for reformulating email queries
|
4193
|
+
# to optimize knowledge base search for response generation.
|
4194
|
+
# @return [String]
|
4195
|
+
#
|
4196
|
+
# @!attribute [rw] locale
|
4197
|
+
# The locale setting for language-specific email response generation
|
4198
|
+
# (for example, en\_US, es\_ES).
|
4199
|
+
# @return [String]
|
4200
|
+
#
|
4201
|
+
# @!attribute [rw] association_configurations
|
4202
|
+
# Configuration settings for knowledge base associations used by the
|
4203
|
+
# email response agent.
|
4204
|
+
# @return [Array<Types::AssociationConfiguration>]
|
4205
|
+
#
|
4206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailResponseAIAgentConfiguration AWS API Documentation
|
4207
|
+
#
|
4208
|
+
class EmailResponseAIAgentConfiguration < Struct.new(
|
4209
|
+
:email_response_ai_prompt_id,
|
4210
|
+
:email_query_reformulation_ai_prompt_id,
|
4211
|
+
:locale,
|
4212
|
+
:association_configurations)
|
4213
|
+
SENSITIVE = []
|
4214
|
+
include Aws::Structure
|
4215
|
+
end
|
4216
|
+
|
4217
|
+
# Details of streaming chunk data for email responses including
|
4218
|
+
# completion text and pagination tokens.
|
4219
|
+
#
|
4220
|
+
# @!attribute [rw] completion
|
4221
|
+
# The partial or complete professional email response text with
|
4222
|
+
# appropriate greetings and closings.
|
4223
|
+
# @return [String]
|
4224
|
+
#
|
4225
|
+
# @!attribute [rw] next_chunk_token
|
4226
|
+
# Token for retrieving the next chunk of streaming response data, if
|
4227
|
+
# available.
|
4228
|
+
# @return [String]
|
4229
|
+
#
|
4230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/EmailResponseChunkDataDetails AWS API Documentation
|
4231
|
+
#
|
4232
|
+
class EmailResponseChunkDataDetails < Struct.new(
|
4233
|
+
:completion,
|
4234
|
+
:next_chunk_token)
|
4235
|
+
SENSITIVE = [:completion]
|
4236
|
+
include Aws::Structure
|
4237
|
+
end
|
4238
|
+
|
4004
4239
|
# The extended data of a message template.
|
4005
4240
|
#
|
4006
4241
|
# @!attribute [rw] message_template_arn
|
@@ -9713,8 +9948,9 @@ module Aws::QConnect
|
|
9713
9948
|
# @!attribute [rw] model_id
|
9714
9949
|
# The identifier of the model used for this AI Prompt.
|
9715
9950
|
#
|
9716
|
-
# <note markdown="1"> For
|
9717
|
-
#
|
9951
|
+
# <note markdown="1"> For information about which models are supported in each Amazon Web
|
9952
|
+
# Services Region, see [Supported models for system/custom
|
9953
|
+
# prompts][1].
|
9718
9954
|
#
|
9719
9955
|
# </note>
|
9720
9956
|
#
|