aws-sdk-lexmodelsv2 1.16.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lexmodelsv2/client.rb +498 -11
- data/lib/aws-sdk-lexmodelsv2/client_api.rb +311 -0
- data/lib/aws-sdk-lexmodelsv2/types.rb +1151 -3
- data/lib/aws-sdk-lexmodelsv2.rb +1 -1
- metadata +2 -2
@@ -129,6 +129,55 @@ module Aws::LexModelsV2
|
|
129
129
|
include Aws::Structure
|
130
130
|
end
|
131
131
|
|
132
|
+
# The object containing information that associates the recommended
|
133
|
+
# intent/slot type with a conversation.
|
134
|
+
#
|
135
|
+
# @!attribute [rw] transcript
|
136
|
+
# The content of the transcript that meets the search filter criteria.
|
137
|
+
# For the JSON format of the transcript, see [Output transcript
|
138
|
+
# format][1].
|
139
|
+
#
|
140
|
+
#
|
141
|
+
#
|
142
|
+
# [1]: https://docs.aws.amazon.com/lex/latest/dg/designing-output-format.html
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AssociatedTranscript AWS API Documentation
|
146
|
+
#
|
147
|
+
class AssociatedTranscript < Struct.new(
|
148
|
+
:transcript)
|
149
|
+
SENSITIVE = []
|
150
|
+
include Aws::Structure
|
151
|
+
end
|
152
|
+
|
153
|
+
# Filters to search for the associated transcript.
|
154
|
+
#
|
155
|
+
# @note When making an API call, you may pass AssociatedTranscriptFilter
|
156
|
+
# data as a hash:
|
157
|
+
#
|
158
|
+
# {
|
159
|
+
# name: "IntentId", # required, accepts IntentId, SlotTypeId
|
160
|
+
# values: ["FilterValue"], # required
|
161
|
+
# }
|
162
|
+
#
|
163
|
+
# @!attribute [rw] name
|
164
|
+
# The name of the field to use for filtering. The allowed names are
|
165
|
+
# IntentId and SlotTypeId.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] values
|
169
|
+
# The values to use to filter the transcript.
|
170
|
+
# @return [Array<String>]
|
171
|
+
#
|
172
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AssociatedTranscriptFilter AWS API Documentation
|
173
|
+
#
|
174
|
+
class AssociatedTranscriptFilter < Struct.new(
|
175
|
+
:name,
|
176
|
+
:values)
|
177
|
+
SENSITIVE = []
|
178
|
+
include Aws::Structure
|
179
|
+
end
|
180
|
+
|
132
181
|
# The location of audio log files collected when conversation logging is
|
133
182
|
# enabled for a bot.
|
134
183
|
#
|
@@ -690,6 +739,87 @@ module Aws::LexModelsV2
|
|
690
739
|
include Aws::Structure
|
691
740
|
end
|
692
741
|
|
742
|
+
# A statistical summary of the bot recommendation results.
|
743
|
+
#
|
744
|
+
# @!attribute [rw] intents
|
745
|
+
# Statistical information about about the intents associated with the
|
746
|
+
# bot recommendation results.
|
747
|
+
# @return [Types::IntentStatistics]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] slot_types
|
750
|
+
# Statistical information about the slot types associated with the bot
|
751
|
+
# recommendation results.
|
752
|
+
# @return [Types::SlotTypeStatistics]
|
753
|
+
#
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationResultStatistics AWS API Documentation
|
755
|
+
#
|
756
|
+
class BotRecommendationResultStatistics < Struct.new(
|
757
|
+
:intents,
|
758
|
+
:slot_types)
|
759
|
+
SENSITIVE = []
|
760
|
+
include Aws::Structure
|
761
|
+
end
|
762
|
+
|
763
|
+
# The object representing the URL of the bot definition, the URL of the
|
764
|
+
# associated transcript and a statistical summary of the bot
|
765
|
+
# recommendation results.
|
766
|
+
#
|
767
|
+
# @!attribute [rw] bot_locale_export_url
|
768
|
+
# The presigned URL link of the recommended bot definition.
|
769
|
+
# @return [String]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] associated_transcripts_url
|
772
|
+
# The presigned url link of the associated transcript.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] statistics
|
776
|
+
# The statistical summary of the bot recommendation results.
|
777
|
+
# @return [Types::BotRecommendationResultStatistics]
|
778
|
+
#
|
779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationResults AWS API Documentation
|
780
|
+
#
|
781
|
+
class BotRecommendationResults < Struct.new(
|
782
|
+
:bot_locale_export_url,
|
783
|
+
:associated_transcripts_url,
|
784
|
+
:statistics)
|
785
|
+
SENSITIVE = []
|
786
|
+
include Aws::Structure
|
787
|
+
end
|
788
|
+
|
789
|
+
# A summary of the bot recommendation.
|
790
|
+
#
|
791
|
+
# @!attribute [rw] bot_recommendation_status
|
792
|
+
# The status of the bot recommendation.
|
793
|
+
#
|
794
|
+
# If the status is Failed, then the reasons for the failure are listed
|
795
|
+
# in the failureReasons field.
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @!attribute [rw] bot_recommendation_id
|
799
|
+
# The unique identifier of the bot recommendation to be updated.
|
800
|
+
# @return [String]
|
801
|
+
#
|
802
|
+
# @!attribute [rw] creation_date_time
|
803
|
+
# A timestamp of the date and time that the bot recommendation was
|
804
|
+
# created.
|
805
|
+
# @return [Time]
|
806
|
+
#
|
807
|
+
# @!attribute [rw] last_updated_date_time
|
808
|
+
# A timestamp of the date and time that the bot recommendation was
|
809
|
+
# last updated.
|
810
|
+
# @return [Time]
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationSummary AWS API Documentation
|
813
|
+
#
|
814
|
+
class BotRecommendationSummary < Struct.new(
|
815
|
+
:bot_recommendation_status,
|
816
|
+
:bot_recommendation_id,
|
817
|
+
:creation_date_time,
|
818
|
+
:last_updated_date_time)
|
819
|
+
SENSITIVE = []
|
820
|
+
include Aws::Structure
|
821
|
+
end
|
822
|
+
|
693
823
|
# Specifies attributes for sorting a list of bots.
|
694
824
|
#
|
695
825
|
# @note When making an API call, you may pass BotSortBy
|
@@ -3379,6 +3509,34 @@ module Aws::LexModelsV2
|
|
3379
3509
|
include Aws::Structure
|
3380
3510
|
end
|
3381
3511
|
|
3512
|
+
# The object used for specifying the data range that the customer wants
|
3513
|
+
# Amazon Lex to read through in the input transcripts.
|
3514
|
+
#
|
3515
|
+
# @note When making an API call, you may pass DateRangeFilter
|
3516
|
+
# data as a hash:
|
3517
|
+
#
|
3518
|
+
# {
|
3519
|
+
# start_date_time: Time.now, # required
|
3520
|
+
# end_date_time: Time.now, # required
|
3521
|
+
# }
|
3522
|
+
#
|
3523
|
+
# @!attribute [rw] start_date_time
|
3524
|
+
# A timestamp indicating the start date for the date range filter.
|
3525
|
+
# @return [Time]
|
3526
|
+
#
|
3527
|
+
# @!attribute [rw] end_date_time
|
3528
|
+
# A timestamp indicating the end date for the date range filter.
|
3529
|
+
# @return [Time]
|
3530
|
+
#
|
3531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DateRangeFilter AWS API Documentation
|
3532
|
+
#
|
3533
|
+
class DateRangeFilter < Struct.new(
|
3534
|
+
:start_date_time,
|
3535
|
+
:end_date_time)
|
3536
|
+
SENSITIVE = []
|
3537
|
+
include Aws::Structure
|
3538
|
+
end
|
3539
|
+
|
3382
3540
|
# @note When making an API call, you may pass DeleteBotAliasRequest
|
3383
3541
|
# data as a hash:
|
3384
3542
|
#
|
@@ -4214,6 +4372,119 @@ module Aws::LexModelsV2
|
|
4214
4372
|
include Aws::Structure
|
4215
4373
|
end
|
4216
4374
|
|
4375
|
+
# @note When making an API call, you may pass DescribeBotRecommendationRequest
|
4376
|
+
# data as a hash:
|
4377
|
+
#
|
4378
|
+
# {
|
4379
|
+
# bot_id: "Id", # required
|
4380
|
+
# bot_version: "DraftBotVersion", # required
|
4381
|
+
# locale_id: "LocaleId", # required
|
4382
|
+
# bot_recommendation_id: "Id", # required
|
4383
|
+
# }
|
4384
|
+
#
|
4385
|
+
# @!attribute [rw] bot_id
|
4386
|
+
# The unique identifier of the bot associated with the bot
|
4387
|
+
# recommendation.
|
4388
|
+
# @return [String]
|
4389
|
+
#
|
4390
|
+
# @!attribute [rw] bot_version
|
4391
|
+
# The version of the bot associated with the bot recommendation.
|
4392
|
+
# @return [String]
|
4393
|
+
#
|
4394
|
+
# @!attribute [rw] locale_id
|
4395
|
+
# The identifier of the language and locale of the bot recommendation
|
4396
|
+
# to describe. The string must match one of the supported locales. For
|
4397
|
+
# more information, see [Supported languages][1].
|
4398
|
+
#
|
4399
|
+
#
|
4400
|
+
#
|
4401
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
4402
|
+
# @return [String]
|
4403
|
+
#
|
4404
|
+
# @!attribute [rw] bot_recommendation_id
|
4405
|
+
# The identifier of the bot recommendation to describe.
|
4406
|
+
# @return [String]
|
4407
|
+
#
|
4408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotRecommendationRequest AWS API Documentation
|
4409
|
+
#
|
4410
|
+
class DescribeBotRecommendationRequest < Struct.new(
|
4411
|
+
:bot_id,
|
4412
|
+
:bot_version,
|
4413
|
+
:locale_id,
|
4414
|
+
:bot_recommendation_id)
|
4415
|
+
SENSITIVE = []
|
4416
|
+
include Aws::Structure
|
4417
|
+
end
|
4418
|
+
|
4419
|
+
# @!attribute [rw] bot_id
|
4420
|
+
# The identifier of the bot associated with the bot recommendation.
|
4421
|
+
# @return [String]
|
4422
|
+
#
|
4423
|
+
# @!attribute [rw] bot_version
|
4424
|
+
# The version of the bot associated with the bot recommendation.
|
4425
|
+
# @return [String]
|
4426
|
+
#
|
4427
|
+
# @!attribute [rw] locale_id
|
4428
|
+
# The identifier of the language and locale of the bot recommendation
|
4429
|
+
# to describe.
|
4430
|
+
# @return [String]
|
4431
|
+
#
|
4432
|
+
# @!attribute [rw] bot_recommendation_status
|
4433
|
+
# The status of the bot recommendation. If the status is Failed, then
|
4434
|
+
# the reasons for the failure are listed in the failureReasons field.
|
4435
|
+
# @return [String]
|
4436
|
+
#
|
4437
|
+
# @!attribute [rw] bot_recommendation_id
|
4438
|
+
# The identifier of the bot recommendation being described.
|
4439
|
+
# @return [String]
|
4440
|
+
#
|
4441
|
+
# @!attribute [rw] failure_reasons
|
4442
|
+
# If botRecommendationStatus is Failed, Amazon Lex explains why.
|
4443
|
+
# @return [Array<String>]
|
4444
|
+
#
|
4445
|
+
# @!attribute [rw] creation_date_time
|
4446
|
+
# The date and time that the bot recommendation was created.
|
4447
|
+
# @return [Time]
|
4448
|
+
#
|
4449
|
+
# @!attribute [rw] last_updated_date_time
|
4450
|
+
# The date and time that the bot recommendation was last updated.
|
4451
|
+
# @return [Time]
|
4452
|
+
#
|
4453
|
+
# @!attribute [rw] transcript_source_setting
|
4454
|
+
# The object representing the Amazon S3 bucket containing the
|
4455
|
+
# transcript, as well as the associated metadata.
|
4456
|
+
# @return [Types::TranscriptSourceSetting]
|
4457
|
+
#
|
4458
|
+
# @!attribute [rw] encryption_setting
|
4459
|
+
# The object representing the passwords that were used to encrypt the
|
4460
|
+
# data related to the bot recommendation results, as well as the KMS
|
4461
|
+
# key ARN used to encrypt the associated metadata.
|
4462
|
+
# @return [Types::EncryptionSetting]
|
4463
|
+
#
|
4464
|
+
# @!attribute [rw] bot_recommendation_results
|
4465
|
+
# The object representing the URL of the bot definition, the URL of
|
4466
|
+
# the associated transcript and a statistical summary of the bot
|
4467
|
+
# recommendation results.
|
4468
|
+
# @return [Types::BotRecommendationResults]
|
4469
|
+
#
|
4470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotRecommendationResponse AWS API Documentation
|
4471
|
+
#
|
4472
|
+
class DescribeBotRecommendationResponse < Struct.new(
|
4473
|
+
:bot_id,
|
4474
|
+
:bot_version,
|
4475
|
+
:locale_id,
|
4476
|
+
:bot_recommendation_status,
|
4477
|
+
:bot_recommendation_id,
|
4478
|
+
:failure_reasons,
|
4479
|
+
:creation_date_time,
|
4480
|
+
:last_updated_date_time,
|
4481
|
+
:transcript_source_setting,
|
4482
|
+
:encryption_setting,
|
4483
|
+
:bot_recommendation_results)
|
4484
|
+
SENSITIVE = []
|
4485
|
+
include Aws::Structure
|
4486
|
+
end
|
4487
|
+
|
4217
4488
|
# @note When making an API call, you may pass DescribeBotRequest
|
4218
4489
|
# data as a hash:
|
4219
4490
|
#
|
@@ -4981,6 +5252,43 @@ module Aws::LexModelsV2
|
|
4981
5252
|
include Aws::Structure
|
4982
5253
|
end
|
4983
5254
|
|
5255
|
+
# The object representing the passwords that were used to encrypt the
|
5256
|
+
# data related to the bot recommendation, as well as the KMS key ARN
|
5257
|
+
# used to encrypt the associated metadata.
|
5258
|
+
#
|
5259
|
+
# @note When making an API call, you may pass EncryptionSetting
|
5260
|
+
# data as a hash:
|
5261
|
+
#
|
5262
|
+
# {
|
5263
|
+
# kms_key_arn: "KmsKeyArn",
|
5264
|
+
# bot_locale_export_password: "FilePassword",
|
5265
|
+
# associated_transcripts_password: "FilePassword",
|
5266
|
+
# }
|
5267
|
+
#
|
5268
|
+
# @!attribute [rw] kms_key_arn
|
5269
|
+
# The KMS key ARN used to encrypt the metadata associated with the bot
|
5270
|
+
# recommendation.
|
5271
|
+
# @return [String]
|
5272
|
+
#
|
5273
|
+
# @!attribute [rw] bot_locale_export_password
|
5274
|
+
# The password used to encrypt the recommended bot recommendation
|
5275
|
+
# file.
|
5276
|
+
# @return [String]
|
5277
|
+
#
|
5278
|
+
# @!attribute [rw] associated_transcripts_password
|
5279
|
+
# The password used to encrypt the associated transcript file.
|
5280
|
+
# @return [String]
|
5281
|
+
#
|
5282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/EncryptionSetting AWS API Documentation
|
5283
|
+
#
|
5284
|
+
class EncryptionSetting < Struct.new(
|
5285
|
+
:kms_key_arn,
|
5286
|
+
:bot_locale_export_password,
|
5287
|
+
:associated_transcripts_password)
|
5288
|
+
SENSITIVE = [:bot_locale_export_password, :associated_transcripts_password]
|
5289
|
+
include Aws::Structure
|
5290
|
+
end
|
5291
|
+
|
4984
5292
|
# Filters the response form the [ListExports][1] operation
|
4985
5293
|
#
|
4986
5294
|
#
|
@@ -6301,6 +6609,22 @@ module Aws::LexModelsV2
|
|
6301
6609
|
include Aws::Structure
|
6302
6610
|
end
|
6303
6611
|
|
6612
|
+
# The object that contains the statistical summary of recommended
|
6613
|
+
# intents associated with the bot recommendation.
|
6614
|
+
#
|
6615
|
+
# @!attribute [rw] discovered_intent_count
|
6616
|
+
# The number of recommended intents associated with the bot
|
6617
|
+
# recommendation.
|
6618
|
+
# @return [Integer]
|
6619
|
+
#
|
6620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentStatistics AWS API Documentation
|
6621
|
+
#
|
6622
|
+
class IntentStatistics < Struct.new(
|
6623
|
+
:discovered_intent_count)
|
6624
|
+
SENSITIVE = []
|
6625
|
+
include Aws::Structure
|
6626
|
+
end
|
6627
|
+
|
6304
6628
|
# Summary information about an intent returned by the `ListIntents`
|
6305
6629
|
# operation.
|
6306
6630
|
#
|
@@ -6439,6 +6763,33 @@ module Aws::LexModelsV2
|
|
6439
6763
|
include Aws::Structure
|
6440
6764
|
end
|
6441
6765
|
|
6766
|
+
# The object that contains transcript filter details that are associated
|
6767
|
+
# with a bot recommendation.
|
6768
|
+
#
|
6769
|
+
# @note When making an API call, you may pass LexTranscriptFilter
|
6770
|
+
# data as a hash:
|
6771
|
+
#
|
6772
|
+
# {
|
6773
|
+
# date_range_filter: {
|
6774
|
+
# start_date_time: Time.now, # required
|
6775
|
+
# end_date_time: Time.now, # required
|
6776
|
+
# },
|
6777
|
+
# }
|
6778
|
+
#
|
6779
|
+
# @!attribute [rw] date_range_filter
|
6780
|
+
# The object that contains a date range filter that will be applied to
|
6781
|
+
# the transcript. Specify this object if you want Amazon Lex to only
|
6782
|
+
# read the files that are within the date range.
|
6783
|
+
# @return [Types::DateRangeFilter]
|
6784
|
+
#
|
6785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/LexTranscriptFilter AWS API Documentation
|
6786
|
+
#
|
6787
|
+
class LexTranscriptFilter < Struct.new(
|
6788
|
+
:date_range_filter)
|
6789
|
+
SENSITIVE = []
|
6790
|
+
include Aws::Structure
|
6791
|
+
end
|
6792
|
+
|
6442
6793
|
# @note When making an API call, you may pass ListAggregatedUtterancesRequest
|
6443
6794
|
# data as a hash:
|
6444
6795
|
#
|
@@ -6782,6 +7133,98 @@ module Aws::LexModelsV2
|
|
6782
7133
|
include Aws::Structure
|
6783
7134
|
end
|
6784
7135
|
|
7136
|
+
# @note When making an API call, you may pass ListBotRecommendationsRequest
|
7137
|
+
# data as a hash:
|
7138
|
+
#
|
7139
|
+
# {
|
7140
|
+
# bot_id: "Id", # required
|
7141
|
+
# bot_version: "DraftBotVersion", # required
|
7142
|
+
# locale_id: "LocaleId", # required
|
7143
|
+
# max_results: 1,
|
7144
|
+
# next_token: "NextToken",
|
7145
|
+
# }
|
7146
|
+
#
|
7147
|
+
# @!attribute [rw] bot_id
|
7148
|
+
# The unique identifier of the bot that contains the bot
|
7149
|
+
# recommendation list.
|
7150
|
+
# @return [String]
|
7151
|
+
#
|
7152
|
+
# @!attribute [rw] bot_version
|
7153
|
+
# The version of the bot that contains the bot recommendation list.
|
7154
|
+
# @return [String]
|
7155
|
+
#
|
7156
|
+
# @!attribute [rw] locale_id
|
7157
|
+
# The identifier of the language and locale of the bot recommendation
|
7158
|
+
# list.
|
7159
|
+
# @return [String]
|
7160
|
+
#
|
7161
|
+
# @!attribute [rw] max_results
|
7162
|
+
# The maximum number of bot recommendations to return in each page of
|
7163
|
+
# results. If there are fewer results than the max page size, only the
|
7164
|
+
# actual number of results are returned.
|
7165
|
+
# @return [Integer]
|
7166
|
+
#
|
7167
|
+
# @!attribute [rw] next_token
|
7168
|
+
# If the response from the ListBotRecommendation operation contains
|
7169
|
+
# more results than specified in the maxResults parameter, a token is
|
7170
|
+
# returned in the response. Use that token in the nextToken parameter
|
7171
|
+
# to return the next page of results.
|
7172
|
+
# @return [String]
|
7173
|
+
#
|
7174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotRecommendationsRequest AWS API Documentation
|
7175
|
+
#
|
7176
|
+
class ListBotRecommendationsRequest < Struct.new(
|
7177
|
+
:bot_id,
|
7178
|
+
:bot_version,
|
7179
|
+
:locale_id,
|
7180
|
+
:max_results,
|
7181
|
+
:next_token)
|
7182
|
+
SENSITIVE = []
|
7183
|
+
include Aws::Structure
|
7184
|
+
end
|
7185
|
+
|
7186
|
+
# @!attribute [rw] bot_id
|
7187
|
+
# The unique identifier of the bot that contains the bot
|
7188
|
+
# recommendation list.
|
7189
|
+
# @return [String]
|
7190
|
+
#
|
7191
|
+
# @!attribute [rw] bot_version
|
7192
|
+
# The version of the bot that contains the bot recommendation list.
|
7193
|
+
# @return [String]
|
7194
|
+
#
|
7195
|
+
# @!attribute [rw] locale_id
|
7196
|
+
# The identifier of the language and locale of the bot recommendation
|
7197
|
+
# list.
|
7198
|
+
# @return [String]
|
7199
|
+
#
|
7200
|
+
# @!attribute [rw] bot_recommendation_summaries
|
7201
|
+
# Summary information for the bot recommendations that meet the filter
|
7202
|
+
# specified in this request. The length of the list is specified in
|
7203
|
+
# the maxResults parameter of the request. If there are more bot
|
7204
|
+
# recommendations available, the nextToken field contains a token to
|
7205
|
+
# get the next page of results.
|
7206
|
+
# @return [Array<Types::BotRecommendationSummary>]
|
7207
|
+
#
|
7208
|
+
# @!attribute [rw] next_token
|
7209
|
+
# A token that indicates whether there are more results to return in a
|
7210
|
+
# response to the ListBotRecommendations operation. If the nextToken
|
7211
|
+
# field is present, you send the contents as the nextToken parameter
|
7212
|
+
# of a ListBotRecommendations operation request to get the next page
|
7213
|
+
# of results.
|
7214
|
+
# @return [String]
|
7215
|
+
#
|
7216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotRecommendationsResponse AWS API Documentation
|
7217
|
+
#
|
7218
|
+
class ListBotRecommendationsResponse < Struct.new(
|
7219
|
+
:bot_id,
|
7220
|
+
:bot_version,
|
7221
|
+
:locale_id,
|
7222
|
+
:bot_recommendation_summaries,
|
7223
|
+
:next_token)
|
7224
|
+
SENSITIVE = []
|
7225
|
+
include Aws::Structure
|
7226
|
+
end
|
7227
|
+
|
6785
7228
|
# @note When making an API call, you may pass ListBotVersionsRequest
|
6786
7229
|
# data as a hash:
|
6787
7230
|
#
|
@@ -7422,12 +7865,122 @@ module Aws::LexModelsV2
|
|
7422
7865
|
include Aws::Structure
|
7423
7866
|
end
|
7424
7867
|
|
7425
|
-
# @note When making an API call, you may pass
|
7868
|
+
# @note When making an API call, you may pass ListRecommendedIntentsRequest
|
7426
7869
|
# data as a hash:
|
7427
7870
|
#
|
7428
7871
|
# {
|
7429
7872
|
# bot_id: "Id", # required
|
7430
|
-
# bot_version: "
|
7873
|
+
# bot_version: "DraftBotVersion", # required
|
7874
|
+
# locale_id: "LocaleId", # required
|
7875
|
+
# bot_recommendation_id: "Id", # required
|
7876
|
+
# next_token: "NextToken",
|
7877
|
+
# max_results: 1,
|
7878
|
+
# }
|
7879
|
+
#
|
7880
|
+
# @!attribute [rw] bot_id
|
7881
|
+
# The unique identifier of the bot associated with the recommended
|
7882
|
+
# intents.
|
7883
|
+
# @return [String]
|
7884
|
+
#
|
7885
|
+
# @!attribute [rw] bot_version
|
7886
|
+
# The version of the bot that contains the recommended intents.
|
7887
|
+
# @return [String]
|
7888
|
+
#
|
7889
|
+
# @!attribute [rw] locale_id
|
7890
|
+
# The identifier of the language and locale of the recommended
|
7891
|
+
# intents.
|
7892
|
+
# @return [String]
|
7893
|
+
#
|
7894
|
+
# @!attribute [rw] bot_recommendation_id
|
7895
|
+
# The identifier of the bot recommendation that contains the
|
7896
|
+
# recommended intents.
|
7897
|
+
# @return [String]
|
7898
|
+
#
|
7899
|
+
# @!attribute [rw] next_token
|
7900
|
+
# If the response from the ListRecommendedIntents operation contains
|
7901
|
+
# more results than specified in the maxResults parameter, a token is
|
7902
|
+
# returned in the response. Use that token in the nextToken parameter
|
7903
|
+
# to return the next page of results.
|
7904
|
+
# @return [String]
|
7905
|
+
#
|
7906
|
+
# @!attribute [rw] max_results
|
7907
|
+
# The maximum number of bot recommendations to return in each page of
|
7908
|
+
# results. If there are fewer results than the max page size, only the
|
7909
|
+
# actual number of results are returned.
|
7910
|
+
# @return [Integer]
|
7911
|
+
#
|
7912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntentsRequest AWS API Documentation
|
7913
|
+
#
|
7914
|
+
class ListRecommendedIntentsRequest < Struct.new(
|
7915
|
+
:bot_id,
|
7916
|
+
:bot_version,
|
7917
|
+
:locale_id,
|
7918
|
+
:bot_recommendation_id,
|
7919
|
+
:next_token,
|
7920
|
+
:max_results)
|
7921
|
+
SENSITIVE = []
|
7922
|
+
include Aws::Structure
|
7923
|
+
end
|
7924
|
+
|
7925
|
+
# @!attribute [rw] bot_id
|
7926
|
+
# The unique identifier of the bot associated with the recommended
|
7927
|
+
# intent.
|
7928
|
+
# @return [String]
|
7929
|
+
#
|
7930
|
+
# @!attribute [rw] bot_version
|
7931
|
+
# The version of the bot that contains the intent.
|
7932
|
+
# @return [String]
|
7933
|
+
#
|
7934
|
+
# @!attribute [rw] locale_id
|
7935
|
+
# The identifier of the language and locale of the intents to list.
|
7936
|
+
# The string must match one of the supported locales. For more
|
7937
|
+
# information, see [Supported languages][1].
|
7938
|
+
#
|
7939
|
+
#
|
7940
|
+
#
|
7941
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
7942
|
+
# @return [String]
|
7943
|
+
#
|
7944
|
+
# @!attribute [rw] bot_recommendation_id
|
7945
|
+
# The identifier of the bot recommendation that contains the
|
7946
|
+
# recommended intent.
|
7947
|
+
# @return [String]
|
7948
|
+
#
|
7949
|
+
# @!attribute [rw] summary_list
|
7950
|
+
# Summary information for the intents that meet the filter criteria
|
7951
|
+
# specified in the request. The length of the list is specified in the
|
7952
|
+
# maxResults parameter of the request. If there are more intents
|
7953
|
+
# available, the nextToken field contains a token to get the next page
|
7954
|
+
# of results.
|
7955
|
+
# @return [Array<Types::RecommendedIntentSummary>]
|
7956
|
+
#
|
7957
|
+
# @!attribute [rw] next_token
|
7958
|
+
# A token that indicates whether there are more results to return in a
|
7959
|
+
# response to the ListRecommendedIntents operation. If the nextToken
|
7960
|
+
# field is present, you send the contents as the nextToken parameter
|
7961
|
+
# of a ListRecommendedIntents operation request to get the next page
|
7962
|
+
# of results.
|
7963
|
+
# @return [String]
|
7964
|
+
#
|
7965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntentsResponse AWS API Documentation
|
7966
|
+
#
|
7967
|
+
class ListRecommendedIntentsResponse < Struct.new(
|
7968
|
+
:bot_id,
|
7969
|
+
:bot_version,
|
7970
|
+
:locale_id,
|
7971
|
+
:bot_recommendation_id,
|
7972
|
+
:summary_list,
|
7973
|
+
:next_token)
|
7974
|
+
SENSITIVE = []
|
7975
|
+
include Aws::Structure
|
7976
|
+
end
|
7977
|
+
|
7978
|
+
# @note When making an API call, you may pass ListSlotTypesRequest
|
7979
|
+
# data as a hash:
|
7980
|
+
#
|
7981
|
+
# {
|
7982
|
+
# bot_id: "Id", # required
|
7983
|
+
# bot_version: "BotVersion", # required
|
7431
7984
|
# locale_id: "LocaleId", # required
|
7432
7985
|
# sort_by: {
|
7433
7986
|
# attribute: "SlotTypeName", # required, accepts SlotTypeName, LastUpdatedDateTime
|
@@ -7921,6 +8474,32 @@ module Aws::LexModelsV2
|
|
7921
8474
|
include Aws::Structure
|
7922
8475
|
end
|
7923
8476
|
|
8477
|
+
# The object that contains a path format that will be applied when
|
8478
|
+
# Amazon Lex reads the transcript file in the bucket you provide.
|
8479
|
+
# Specify this object if you only want Lex to read a subset of files in
|
8480
|
+
# your Amazon S3 bucket.
|
8481
|
+
#
|
8482
|
+
# @note When making an API call, you may pass PathFormat
|
8483
|
+
# data as a hash:
|
8484
|
+
#
|
8485
|
+
# {
|
8486
|
+
# object_prefixes: ["ObjectPrefix"],
|
8487
|
+
# }
|
8488
|
+
#
|
8489
|
+
# @!attribute [rw] object_prefixes
|
8490
|
+
# A list of Amazon S3 prefixes that points to sub-folders in the
|
8491
|
+
# Amazon S3 bucket. Specify this list if you only want Lex to read the
|
8492
|
+
# files under this set of sub-folders.
|
8493
|
+
# @return [Array<String>]
|
8494
|
+
#
|
8495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PathFormat AWS API Documentation
|
8496
|
+
#
|
8497
|
+
class PathFormat < Struct.new(
|
8498
|
+
:object_prefixes)
|
8499
|
+
SENSITIVE = []
|
8500
|
+
include Aws::Structure
|
8501
|
+
end
|
8502
|
+
|
7924
8503
|
# Defines an ASCII text message to send to the user.
|
7925
8504
|
#
|
7926
8505
|
# @note When making an API call, you may pass PlainTextMessage
|
@@ -8275,6 +8854,33 @@ module Aws::LexModelsV2
|
|
8275
8854
|
include Aws::Structure
|
8276
8855
|
end
|
8277
8856
|
|
8857
|
+
# An object that contains a summary of a recommended intent.
|
8858
|
+
#
|
8859
|
+
# @!attribute [rw] intent_id
|
8860
|
+
# The unique identifier of a recommended intent associated with the
|
8861
|
+
# bot recommendation.
|
8862
|
+
# @return [String]
|
8863
|
+
#
|
8864
|
+
# @!attribute [rw] intent_name
|
8865
|
+
# The name of a recommended intent associated with the bot
|
8866
|
+
# recommendation.
|
8867
|
+
# @return [String]
|
8868
|
+
#
|
8869
|
+
# @!attribute [rw] sample_utterances_count
|
8870
|
+
# The count of sample utterances of a recommended intent that is
|
8871
|
+
# associated with a bot recommendation.
|
8872
|
+
# @return [Integer]
|
8873
|
+
#
|
8874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RecommendedIntentSummary AWS API Documentation
|
8875
|
+
#
|
8876
|
+
class RecommendedIntentSummary < Struct.new(
|
8877
|
+
:intent_id,
|
8878
|
+
:intent_name,
|
8879
|
+
:sample_utterances_count)
|
8880
|
+
SENSITIVE = []
|
8881
|
+
include Aws::Structure
|
8882
|
+
end
|
8883
|
+
|
8278
8884
|
# Specifies the time window that utterance statistics are returned for.
|
8279
8885
|
# The time window is always relative to the last time that the that
|
8280
8886
|
# utterances were aggregated. For example, if the
|
@@ -8455,6 +9061,71 @@ module Aws::LexModelsV2
|
|
8455
9061
|
include Aws::Structure
|
8456
9062
|
end
|
8457
9063
|
|
9064
|
+
# The object representing the Amazon S3 bucket containing the
|
9065
|
+
# transcript, as well as the associated metadata.
|
9066
|
+
#
|
9067
|
+
# @note When making an API call, you may pass S3BucketTranscriptSource
|
9068
|
+
# data as a hash:
|
9069
|
+
#
|
9070
|
+
# {
|
9071
|
+
# s3_bucket_name: "S3BucketName", # required
|
9072
|
+
# path_format: {
|
9073
|
+
# object_prefixes: ["ObjectPrefix"],
|
9074
|
+
# },
|
9075
|
+
# transcript_format: "Lex", # required, accepts Lex
|
9076
|
+
# transcript_filter: {
|
9077
|
+
# lex_transcript_filter: {
|
9078
|
+
# date_range_filter: {
|
9079
|
+
# start_date_time: Time.now, # required
|
9080
|
+
# end_date_time: Time.now, # required
|
9081
|
+
# },
|
9082
|
+
# },
|
9083
|
+
# },
|
9084
|
+
# kms_key_arn: "KmsKeyArn",
|
9085
|
+
# }
|
9086
|
+
#
|
9087
|
+
# @!attribute [rw] s3_bucket_name
|
9088
|
+
# The name of the bucket containing the transcript and the associated
|
9089
|
+
# metadata.
|
9090
|
+
# @return [String]
|
9091
|
+
#
|
9092
|
+
# @!attribute [rw] path_format
|
9093
|
+
# The object that contains a path format that will be applied when
|
9094
|
+
# Amazon Lex reads the transcript file in the bucket you provide.
|
9095
|
+
# Specify this object if you only want Lex to read a subset of files
|
9096
|
+
# in your Amazon S3 bucket.
|
9097
|
+
# @return [Types::PathFormat]
|
9098
|
+
#
|
9099
|
+
# @!attribute [rw] transcript_format
|
9100
|
+
# The format of the transcript content. Currently, Genie only supports
|
9101
|
+
# the Amazon Lex transcript format.
|
9102
|
+
# @return [String]
|
9103
|
+
#
|
9104
|
+
# @!attribute [rw] transcript_filter
|
9105
|
+
# The object that contains the filter which will be applied when
|
9106
|
+
# Amazon Lex reads through the Amazon S3 bucket. Specify this object
|
9107
|
+
# if you want Amazon Lex to read only a subset of the Amazon S3 bucket
|
9108
|
+
# based on the filter you provide.
|
9109
|
+
# @return [Types::TranscriptFilter]
|
9110
|
+
#
|
9111
|
+
# @!attribute [rw] kms_key_arn
|
9112
|
+
# The ARN of the KMS key that customer use to encrypt their Amazon S3
|
9113
|
+
# bucket. Only use this field if your bucket is encrypted using a
|
9114
|
+
# customer managed KMS key.
|
9115
|
+
# @return [String]
|
9116
|
+
#
|
9117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/S3BucketTranscriptSource AWS API Documentation
|
9118
|
+
#
|
9119
|
+
class S3BucketTranscriptSource < Struct.new(
|
9120
|
+
:s3_bucket_name,
|
9121
|
+
:path_format,
|
9122
|
+
:transcript_format,
|
9123
|
+
:transcript_filter,
|
9124
|
+
:kms_key_arn)
|
9125
|
+
SENSITIVE = []
|
9126
|
+
include Aws::Structure
|
9127
|
+
end
|
9128
|
+
|
8458
9129
|
# Defines a Speech Synthesis Markup Language (SSML) prompt.
|
8459
9130
|
#
|
8460
9131
|
# @note When making an API call, you may pass SSMLMessage
|
@@ -8520,6 +9191,143 @@ module Aws::LexModelsV2
|
|
8520
9191
|
include Aws::Structure
|
8521
9192
|
end
|
8522
9193
|
|
9194
|
+
# @note When making an API call, you may pass SearchAssociatedTranscriptsRequest
|
9195
|
+
# data as a hash:
|
9196
|
+
#
|
9197
|
+
# {
|
9198
|
+
# bot_id: "Id", # required
|
9199
|
+
# bot_version: "BotVersion", # required
|
9200
|
+
# locale_id: "LocaleId", # required
|
9201
|
+
# bot_recommendation_id: "Id", # required
|
9202
|
+
# search_order: "Ascending", # accepts Ascending, Descending
|
9203
|
+
# filters: [ # required
|
9204
|
+
# {
|
9205
|
+
# name: "IntentId", # required, accepts IntentId, SlotTypeId
|
9206
|
+
# values: ["FilterValue"], # required
|
9207
|
+
# },
|
9208
|
+
# ],
|
9209
|
+
# max_results: 1,
|
9210
|
+
# next_index: 1,
|
9211
|
+
# }
|
9212
|
+
#
|
9213
|
+
# @!attribute [rw] bot_id
|
9214
|
+
# The unique identifier of the bot associated with the transcripts
|
9215
|
+
# that you are searching.
|
9216
|
+
# @return [String]
|
9217
|
+
#
|
9218
|
+
# @!attribute [rw] bot_version
|
9219
|
+
# The version of the bot containing the transcripts that you are
|
9220
|
+
# searching.
|
9221
|
+
# @return [String]
|
9222
|
+
#
|
9223
|
+
# @!attribute [rw] locale_id
|
9224
|
+
# The identifier of the language and locale of the transcripts to
|
9225
|
+
# search. The string must match one of the supported locales. For more
|
9226
|
+
# information, see [Supported languages][1]
|
9227
|
+
#
|
9228
|
+
#
|
9229
|
+
#
|
9230
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
9231
|
+
# @return [String]
|
9232
|
+
#
|
9233
|
+
# @!attribute [rw] bot_recommendation_id
|
9234
|
+
# The unique identifier of the bot recommendation associated with the
|
9235
|
+
# transcripts to search.
|
9236
|
+
# @return [String]
|
9237
|
+
#
|
9238
|
+
# @!attribute [rw] search_order
|
9239
|
+
# How SearchResults are ordered. Valid values are Ascending or
|
9240
|
+
# Descending. The default is Descending.
|
9241
|
+
# @return [String]
|
9242
|
+
#
|
9243
|
+
# @!attribute [rw] filters
|
9244
|
+
# A list of filter objects.
|
9245
|
+
# @return [Array<Types::AssociatedTranscriptFilter>]
|
9246
|
+
#
|
9247
|
+
# @!attribute [rw] max_results
|
9248
|
+
# The maximum number of bot recommendations to return in each page of
|
9249
|
+
# results. If there are fewer results than the max page size, only the
|
9250
|
+
# actual number of results are returned.
|
9251
|
+
# @return [Integer]
|
9252
|
+
#
|
9253
|
+
# @!attribute [rw] next_index
|
9254
|
+
# If the response from the SearchAssociatedTranscriptsRequest
|
9255
|
+
# operation contains more results than specified in the maxResults
|
9256
|
+
# parameter, an index is returned in the response. Use that index in
|
9257
|
+
# the nextIndex parameter to return the next page of results.
|
9258
|
+
# @return [Integer]
|
9259
|
+
#
|
9260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SearchAssociatedTranscriptsRequest AWS API Documentation
|
9261
|
+
#
|
9262
|
+
class SearchAssociatedTranscriptsRequest < Struct.new(
|
9263
|
+
:bot_id,
|
9264
|
+
:bot_version,
|
9265
|
+
:locale_id,
|
9266
|
+
:bot_recommendation_id,
|
9267
|
+
:search_order,
|
9268
|
+
:filters,
|
9269
|
+
:max_results,
|
9270
|
+
:next_index)
|
9271
|
+
SENSITIVE = []
|
9272
|
+
include Aws::Structure
|
9273
|
+
end
|
9274
|
+
|
9275
|
+
# @!attribute [rw] bot_id
|
9276
|
+
# The unique identifier of the bot associated with the transcripts
|
9277
|
+
# that you are searching.
|
9278
|
+
# @return [String]
|
9279
|
+
#
|
9280
|
+
# @!attribute [rw] bot_version
|
9281
|
+
# The version of the bot containing the transcripts that you are
|
9282
|
+
# searching.
|
9283
|
+
# @return [String]
|
9284
|
+
#
|
9285
|
+
# @!attribute [rw] locale_id
|
9286
|
+
# The identifier of the language and locale of the transcripts to
|
9287
|
+
# search. The string must match one of the supported locales. For more
|
9288
|
+
# information, see [Supported languages][1]
|
9289
|
+
#
|
9290
|
+
#
|
9291
|
+
#
|
9292
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
9293
|
+
# @return [String]
|
9294
|
+
#
|
9295
|
+
# @!attribute [rw] bot_recommendation_id
|
9296
|
+
# The unique identifier of the bot recommendation associated with the
|
9297
|
+
# transcripts to search.
|
9298
|
+
# @return [String]
|
9299
|
+
#
|
9300
|
+
# @!attribute [rw] next_index
|
9301
|
+
# A index that indicates whether there are more results to return in a
|
9302
|
+
# response to the SearchAssociatedTranscripts operation. If the
|
9303
|
+
# nextIndex field is present, you send the contents as the nextIndex
|
9304
|
+
# parameter of a SearchAssociatedTranscriptsRequest operation to get
|
9305
|
+
# the next page of results.
|
9306
|
+
# @return [Integer]
|
9307
|
+
#
|
9308
|
+
# @!attribute [rw] associated_transcripts
|
9309
|
+
# The object that contains the associated transcript that meet the
|
9310
|
+
# criteria you specified.
|
9311
|
+
# @return [Array<Types::AssociatedTranscript>]
|
9312
|
+
#
|
9313
|
+
# @!attribute [rw] total_results
|
9314
|
+
# The total number of transcripts returned by the search.
|
9315
|
+
# @return [Integer]
|
9316
|
+
#
|
9317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SearchAssociatedTranscriptsResponse AWS API Documentation
|
9318
|
+
#
|
9319
|
+
class SearchAssociatedTranscriptsResponse < Struct.new(
|
9320
|
+
:bot_id,
|
9321
|
+
:bot_version,
|
9322
|
+
:locale_id,
|
9323
|
+
:bot_recommendation_id,
|
9324
|
+
:next_index,
|
9325
|
+
:associated_transcripts,
|
9326
|
+
:total_results)
|
9327
|
+
SENSITIVE = []
|
9328
|
+
include Aws::Structure
|
9329
|
+
end
|
9330
|
+
|
8523
9331
|
# Determines whether Amazon Lex will use Amazon Comprehend to detect the
|
8524
9332
|
# sentiment of user utterances.
|
8525
9333
|
#
|
@@ -8807,6 +9615,22 @@ module Aws::LexModelsV2
|
|
8807
9615
|
include Aws::Structure
|
8808
9616
|
end
|
8809
9617
|
|
9618
|
+
# The object that contains the statistical summary of the recommended
|
9619
|
+
# slot type associated with the bot recommendation.
|
9620
|
+
#
|
9621
|
+
# @!attribute [rw] discovered_slot_type_count
|
9622
|
+
# The number of recommended slot types associated with the bot
|
9623
|
+
# recommendation.
|
9624
|
+
# @return [Integer]
|
9625
|
+
#
|
9626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeStatistics AWS API Documentation
|
9627
|
+
#
|
9628
|
+
class SlotTypeStatistics < Struct.new(
|
9629
|
+
:discovered_slot_type_count)
|
9630
|
+
SENSITIVE = []
|
9631
|
+
include Aws::Structure
|
9632
|
+
end
|
9633
|
+
|
8810
9634
|
# Provides summary information about a slot type.
|
8811
9635
|
#
|
8812
9636
|
# @!attribute [rw] slot_type_id
|
@@ -9236,6 +10060,139 @@ module Aws::LexModelsV2
|
|
9236
10060
|
include Aws::Structure
|
9237
10061
|
end
|
9238
10062
|
|
10063
|
+
# @note When making an API call, you may pass StartBotRecommendationRequest
|
10064
|
+
# data as a hash:
|
10065
|
+
#
|
10066
|
+
# {
|
10067
|
+
# bot_id: "Id", # required
|
10068
|
+
# bot_version: "DraftBotVersion", # required
|
10069
|
+
# locale_id: "LocaleId", # required
|
10070
|
+
# transcript_source_setting: { # required
|
10071
|
+
# s3_bucket_transcript_source: {
|
10072
|
+
# s3_bucket_name: "S3BucketName", # required
|
10073
|
+
# path_format: {
|
10074
|
+
# object_prefixes: ["ObjectPrefix"],
|
10075
|
+
# },
|
10076
|
+
# transcript_format: "Lex", # required, accepts Lex
|
10077
|
+
# transcript_filter: {
|
10078
|
+
# lex_transcript_filter: {
|
10079
|
+
# date_range_filter: {
|
10080
|
+
# start_date_time: Time.now, # required
|
10081
|
+
# end_date_time: Time.now, # required
|
10082
|
+
# },
|
10083
|
+
# },
|
10084
|
+
# },
|
10085
|
+
# kms_key_arn: "KmsKeyArn",
|
10086
|
+
# },
|
10087
|
+
# },
|
10088
|
+
# encryption_setting: {
|
10089
|
+
# kms_key_arn: "KmsKeyArn",
|
10090
|
+
# bot_locale_export_password: "FilePassword",
|
10091
|
+
# associated_transcripts_password: "FilePassword",
|
10092
|
+
# },
|
10093
|
+
# }
|
10094
|
+
#
|
10095
|
+
# @!attribute [rw] bot_id
|
10096
|
+
# The unique identifier of the bot containing the bot recommendation.
|
10097
|
+
# @return [String]
|
10098
|
+
#
|
10099
|
+
# @!attribute [rw] bot_version
|
10100
|
+
# The version of the bot containing the bot recommendation.
|
10101
|
+
# @return [String]
|
10102
|
+
#
|
10103
|
+
# @!attribute [rw] locale_id
|
10104
|
+
# The identifier of the language and locale of the bot recommendation
|
10105
|
+
# to start. The string must match one of the supported locales. For
|
10106
|
+
# more information, see [Supported languages][1]
|
10107
|
+
#
|
10108
|
+
#
|
10109
|
+
#
|
10110
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
10111
|
+
# @return [String]
|
10112
|
+
#
|
10113
|
+
# @!attribute [rw] transcript_source_setting
|
10114
|
+
# The object representing the Amazon S3 bucket containing the
|
10115
|
+
# transcript, as well as the associated metadata.
|
10116
|
+
# @return [Types::TranscriptSourceSetting]
|
10117
|
+
#
|
10118
|
+
# @!attribute [rw] encryption_setting
|
10119
|
+
# The object representing the passwords that will be used to encrypt
|
10120
|
+
# the data related to the bot recommendation results, as well as the
|
10121
|
+
# KMS key ARN used to encrypt the associated metadata.
|
10122
|
+
# @return [Types::EncryptionSetting]
|
10123
|
+
#
|
10124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationRequest AWS API Documentation
|
10125
|
+
#
|
10126
|
+
class StartBotRecommendationRequest < Struct.new(
|
10127
|
+
:bot_id,
|
10128
|
+
:bot_version,
|
10129
|
+
:locale_id,
|
10130
|
+
:transcript_source_setting,
|
10131
|
+
:encryption_setting)
|
10132
|
+
SENSITIVE = []
|
10133
|
+
include Aws::Structure
|
10134
|
+
end
|
10135
|
+
|
10136
|
+
# @!attribute [rw] bot_id
|
10137
|
+
# The unique identifier of the bot containing the bot recommendation.
|
10138
|
+
# @return [String]
|
10139
|
+
#
|
10140
|
+
# @!attribute [rw] bot_version
|
10141
|
+
# The version of the bot containing the bot recommendation.
|
10142
|
+
# @return [String]
|
10143
|
+
#
|
10144
|
+
# @!attribute [rw] locale_id
|
10145
|
+
# The identifier of the language and locale of the bot recommendation
|
10146
|
+
# to start. The string must match one of the supported locales. For
|
10147
|
+
# more information, see [Supported languages][1]
|
10148
|
+
#
|
10149
|
+
#
|
10150
|
+
#
|
10151
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
10152
|
+
# @return [String]
|
10153
|
+
#
|
10154
|
+
# @!attribute [rw] bot_recommendation_status
|
10155
|
+
# The status of the bot recommendation.
|
10156
|
+
#
|
10157
|
+
# If the status is Failed, then the reasons for the failure are listed
|
10158
|
+
# in the failureReasons field.
|
10159
|
+
# @return [String]
|
10160
|
+
#
|
10161
|
+
# @!attribute [rw] bot_recommendation_id
|
10162
|
+
# The identifier of the bot recommendation that you have created.
|
10163
|
+
# @return [String]
|
10164
|
+
#
|
10165
|
+
# @!attribute [rw] creation_date_time
|
10166
|
+
# A timestamp of the date and time that the bot recommendation was
|
10167
|
+
# created.
|
10168
|
+
# @return [Time]
|
10169
|
+
#
|
10170
|
+
# @!attribute [rw] transcript_source_setting
|
10171
|
+
# The object representing the Amazon S3 bucket containing the
|
10172
|
+
# transcript, as well as the associated metadata.
|
10173
|
+
# @return [Types::TranscriptSourceSetting]
|
10174
|
+
#
|
10175
|
+
# @!attribute [rw] encryption_setting
|
10176
|
+
# The object representing the passwords that were used to encrypt the
|
10177
|
+
# data related to the bot recommendation results, as well as the KMS
|
10178
|
+
# key ARN used to encrypt the associated metadata.
|
10179
|
+
# @return [Types::EncryptionSetting]
|
10180
|
+
#
|
10181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationResponse AWS API Documentation
|
10182
|
+
#
|
10183
|
+
class StartBotRecommendationResponse < Struct.new(
|
10184
|
+
:bot_id,
|
10185
|
+
:bot_version,
|
10186
|
+
:locale_id,
|
10187
|
+
:bot_recommendation_status,
|
10188
|
+
:bot_recommendation_id,
|
10189
|
+
:creation_date_time,
|
10190
|
+
:transcript_source_setting,
|
10191
|
+
:encryption_setting)
|
10192
|
+
SENSITIVE = []
|
10193
|
+
include Aws::Structure
|
10194
|
+
end
|
10195
|
+
|
9239
10196
|
# @note When making an API call, you may pass StartImportRequest
|
9240
10197
|
# data as a hash:
|
9241
10198
|
#
|
@@ -9267,7 +10224,7 @@ module Aws::LexModelsV2
|
|
9267
10224
|
# },
|
9268
10225
|
# },
|
9269
10226
|
# },
|
9270
|
-
# merge_strategy: "Overwrite", # required, accepts Overwrite, FailOnConflict
|
10227
|
+
# merge_strategy: "Overwrite", # required, accepts Overwrite, FailOnConflict, Append
|
9271
10228
|
# file_password: "ImportExportFilePassword",
|
9272
10229
|
# }
|
9273
10230
|
#
|
@@ -9546,6 +10503,72 @@ module Aws::LexModelsV2
|
|
9546
10503
|
include Aws::Structure
|
9547
10504
|
end
|
9548
10505
|
|
10506
|
+
# The object representing the filter that Amazon Lex will use to select
|
10507
|
+
# the appropriate transcript.
|
10508
|
+
#
|
10509
|
+
# @note When making an API call, you may pass TranscriptFilter
|
10510
|
+
# data as a hash:
|
10511
|
+
#
|
10512
|
+
# {
|
10513
|
+
# lex_transcript_filter: {
|
10514
|
+
# date_range_filter: {
|
10515
|
+
# start_date_time: Time.now, # required
|
10516
|
+
# end_date_time: Time.now, # required
|
10517
|
+
# },
|
10518
|
+
# },
|
10519
|
+
# }
|
10520
|
+
#
|
10521
|
+
# @!attribute [rw] lex_transcript_filter
|
10522
|
+
# The object representing the filter that Amazon Lex will use to
|
10523
|
+
# select the appropriate transcript when the transcript format is the
|
10524
|
+
# Amazon Lex format.
|
10525
|
+
# @return [Types::LexTranscriptFilter]
|
10526
|
+
#
|
10527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TranscriptFilter AWS API Documentation
|
10528
|
+
#
|
10529
|
+
class TranscriptFilter < Struct.new(
|
10530
|
+
:lex_transcript_filter)
|
10531
|
+
SENSITIVE = []
|
10532
|
+
include Aws::Structure
|
10533
|
+
end
|
10534
|
+
|
10535
|
+
# Indicates the setting of the location where the transcript is stored.
|
10536
|
+
#
|
10537
|
+
# @note When making an API call, you may pass TranscriptSourceSetting
|
10538
|
+
# data as a hash:
|
10539
|
+
#
|
10540
|
+
# {
|
10541
|
+
# s3_bucket_transcript_source: {
|
10542
|
+
# s3_bucket_name: "S3BucketName", # required
|
10543
|
+
# path_format: {
|
10544
|
+
# object_prefixes: ["ObjectPrefix"],
|
10545
|
+
# },
|
10546
|
+
# transcript_format: "Lex", # required, accepts Lex
|
10547
|
+
# transcript_filter: {
|
10548
|
+
# lex_transcript_filter: {
|
10549
|
+
# date_range_filter: {
|
10550
|
+
# start_date_time: Time.now, # required
|
10551
|
+
# end_date_time: Time.now, # required
|
10552
|
+
# },
|
10553
|
+
# },
|
10554
|
+
# },
|
10555
|
+
# kms_key_arn: "KmsKeyArn",
|
10556
|
+
# },
|
10557
|
+
# }
|
10558
|
+
#
|
10559
|
+
# @!attribute [rw] s3_bucket_transcript_source
|
10560
|
+
# Indicates the setting of the Amazon S3 bucket where the transcript
|
10561
|
+
# is stored.
|
10562
|
+
# @return [Types::S3BucketTranscriptSource]
|
10563
|
+
#
|
10564
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TranscriptSourceSetting AWS API Documentation
|
10565
|
+
#
|
10566
|
+
class TranscriptSourceSetting < Struct.new(
|
10567
|
+
:s3_bucket_transcript_source)
|
10568
|
+
SENSITIVE = []
|
10569
|
+
include Aws::Structure
|
10570
|
+
end
|
10571
|
+
|
9549
10572
|
# @note When making an API call, you may pass UntagResourceRequest
|
9550
10573
|
# data as a hash:
|
9551
10574
|
#
|
@@ -9871,6 +10894,131 @@ module Aws::LexModelsV2
|
|
9871
10894
|
include Aws::Structure
|
9872
10895
|
end
|
9873
10896
|
|
10897
|
+
# @note When making an API call, you may pass UpdateBotRecommendationRequest
|
10898
|
+
# data as a hash:
|
10899
|
+
#
|
10900
|
+
# {
|
10901
|
+
# bot_id: "Id", # required
|
10902
|
+
# bot_version: "DraftBotVersion", # required
|
10903
|
+
# locale_id: "LocaleId", # required
|
10904
|
+
# bot_recommendation_id: "Id", # required
|
10905
|
+
# encryption_setting: { # required
|
10906
|
+
# kms_key_arn: "KmsKeyArn",
|
10907
|
+
# bot_locale_export_password: "FilePassword",
|
10908
|
+
# associated_transcripts_password: "FilePassword",
|
10909
|
+
# },
|
10910
|
+
# }
|
10911
|
+
#
|
10912
|
+
# @!attribute [rw] bot_id
|
10913
|
+
# The unique identifier of the bot containing the bot recommendation
|
10914
|
+
# to be updated.
|
10915
|
+
# @return [String]
|
10916
|
+
#
|
10917
|
+
# @!attribute [rw] bot_version
|
10918
|
+
# The version of the bot containing the bot recommendation to be
|
10919
|
+
# updated.
|
10920
|
+
# @return [String]
|
10921
|
+
#
|
10922
|
+
# @!attribute [rw] locale_id
|
10923
|
+
# The identifier of the language and locale of the bot recommendation
|
10924
|
+
# to update. The string must match one of the supported locales. For
|
10925
|
+
# more information, see [Supported languages][1]
|
10926
|
+
#
|
10927
|
+
#
|
10928
|
+
#
|
10929
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
10930
|
+
# @return [String]
|
10931
|
+
#
|
10932
|
+
# @!attribute [rw] bot_recommendation_id
|
10933
|
+
# The unique identifier of the bot recommendation to be updated.
|
10934
|
+
# @return [String]
|
10935
|
+
#
|
10936
|
+
# @!attribute [rw] encryption_setting
|
10937
|
+
# The object representing the passwords that will be used to encrypt
|
10938
|
+
# the data related to the bot recommendation results, as well as the
|
10939
|
+
# KMS key ARN used to encrypt the associated metadata.
|
10940
|
+
# @return [Types::EncryptionSetting]
|
10941
|
+
#
|
10942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendationRequest AWS API Documentation
|
10943
|
+
#
|
10944
|
+
class UpdateBotRecommendationRequest < Struct.new(
|
10945
|
+
:bot_id,
|
10946
|
+
:bot_version,
|
10947
|
+
:locale_id,
|
10948
|
+
:bot_recommendation_id,
|
10949
|
+
:encryption_setting)
|
10950
|
+
SENSITIVE = []
|
10951
|
+
include Aws::Structure
|
10952
|
+
end
|
10953
|
+
|
10954
|
+
# @!attribute [rw] bot_id
|
10955
|
+
# The unique identifier of the bot containing the bot recommendation
|
10956
|
+
# that has been updated.
|
10957
|
+
# @return [String]
|
10958
|
+
#
|
10959
|
+
# @!attribute [rw] bot_version
|
10960
|
+
# The version of the bot containing the bot recommendation that has
|
10961
|
+
# been updated.
|
10962
|
+
# @return [String]
|
10963
|
+
#
|
10964
|
+
# @!attribute [rw] locale_id
|
10965
|
+
# The identifier of the language and locale of the bot recommendation
|
10966
|
+
# to update. The string must match one of the supported locales. For
|
10967
|
+
# more information, see [Supported languages][1]
|
10968
|
+
#
|
10969
|
+
#
|
10970
|
+
#
|
10971
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
10972
|
+
# @return [String]
|
10973
|
+
#
|
10974
|
+
# @!attribute [rw] bot_recommendation_status
|
10975
|
+
# The status of the bot recommendation.
|
10976
|
+
#
|
10977
|
+
# If the status is Failed, then the reasons for the failure are listed
|
10978
|
+
# in the failureReasons field.
|
10979
|
+
# @return [String]
|
10980
|
+
#
|
10981
|
+
# @!attribute [rw] bot_recommendation_id
|
10982
|
+
# The unique identifier of the bot recommendation to be updated.
|
10983
|
+
# @return [String]
|
10984
|
+
#
|
10985
|
+
# @!attribute [rw] creation_date_time
|
10986
|
+
# A timestamp of the date and time that the bot recommendation was
|
10987
|
+
# created.
|
10988
|
+
# @return [Time]
|
10989
|
+
#
|
10990
|
+
# @!attribute [rw] last_updated_date_time
|
10991
|
+
# A timestamp of the date and time that the bot recommendation was
|
10992
|
+
# last updated.
|
10993
|
+
# @return [Time]
|
10994
|
+
#
|
10995
|
+
# @!attribute [rw] transcript_source_setting
|
10996
|
+
# The object representing the Amazon S3 bucket containing the
|
10997
|
+
# transcript, as well as the associated metadata.
|
10998
|
+
# @return [Types::TranscriptSourceSetting]
|
10999
|
+
#
|
11000
|
+
# @!attribute [rw] encryption_setting
|
11001
|
+
# The object representing the passwords that were used to encrypt the
|
11002
|
+
# data related to the bot recommendation results, as well as the KMS
|
11003
|
+
# key ARN used to encrypt the associated metadata.
|
11004
|
+
# @return [Types::EncryptionSetting]
|
11005
|
+
#
|
11006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendationResponse AWS API Documentation
|
11007
|
+
#
|
11008
|
+
class UpdateBotRecommendationResponse < Struct.new(
|
11009
|
+
:bot_id,
|
11010
|
+
:bot_version,
|
11011
|
+
:locale_id,
|
11012
|
+
:bot_recommendation_status,
|
11013
|
+
:bot_recommendation_id,
|
11014
|
+
:creation_date_time,
|
11015
|
+
:last_updated_date_time,
|
11016
|
+
:transcript_source_setting,
|
11017
|
+
:encryption_setting)
|
11018
|
+
SENSITIVE = []
|
11019
|
+
include Aws::Structure
|
11020
|
+
end
|
11021
|
+
|
9874
11022
|
# @note When making an API call, you may pass UpdateBotRequest
|
9875
11023
|
# data as a hash:
|
9876
11024
|
#
|