aws-sdk-lexmodelsv2 1.10.0 → 1.11.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-lexmodelsv2/client.rb +189 -1
- data/lib/aws-sdk-lexmodelsv2/client_api.rb +106 -0
- data/lib/aws-sdk-lexmodelsv2/types.rb +436 -0
- data/lib/aws-sdk-lexmodelsv2.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 125ac009347a40f55d65a46299a33312afbd25fb6a6b8494dedb6ad2f5f6d9fa
|
4
|
+
data.tar.gz: 61e17dc74a1972ca161c24f38c834c298401925ab0311259f7607c3ae6d93744
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 11814b7000590a29be3e00e030dfa618102a57758e0496559044c229213cc07f61daa315608b42634ba86976f72c01bc0f86ddece00eec0d7ebbc0e0f304a14f
|
7
|
+
data.tar.gz: d7a23ff7be3d3b04daaf4c61748177e34a3bd49bc2c6d770fa39c13e8f3f5b765ae7cb5c8c7095a6a4e9fb639d297acedacce128b3fff1395b5ec9318b6e2d35
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.11.0 (2021-09-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for utterances statistics for bots built using Lex V2 console and APIs. For details, see: https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-utterances.html
|
8
|
+
|
4
9
|
1.10.0 (2021-09-01)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.11.0
|
@@ -2512,6 +2512,54 @@ module Aws::LexModelsV2
|
|
2512
2512
|
req.send_request(options)
|
2513
2513
|
end
|
2514
2514
|
|
2515
|
+
# Deletes stored utterances.
|
2516
|
+
#
|
2517
|
+
# Amazon Lex stores the utterances that users send to your bot.
|
2518
|
+
# Utterances are stored for 15 days for use with the operation, and then
|
2519
|
+
# stored indefinitely for use in improving the ability of your bot to
|
2520
|
+
# respond to user input..
|
2521
|
+
#
|
2522
|
+
# Use the `DeleteUtterances` operation to manually delete utterances for
|
2523
|
+
# a specific session. When you use the `DeleteUtterances` operation,
|
2524
|
+
# utterances stored for improving your bot's ability to respond to user
|
2525
|
+
# input are deleted immediately. Utterances stored for use with the
|
2526
|
+
# `ListAggregatedUtterances` operation are deleted after 15 days.
|
2527
|
+
#
|
2528
|
+
# @option params [required, String] :bot_id
|
2529
|
+
# The unique identifier of the bot that contains the utterances.
|
2530
|
+
#
|
2531
|
+
# @option params [String] :locale_id
|
2532
|
+
# The identifier of the language and locale where the utterances were
|
2533
|
+
# collected. The string must match one of the supported locales. For
|
2534
|
+
# more information, see [Supported languages][1].
|
2535
|
+
#
|
2536
|
+
#
|
2537
|
+
#
|
2538
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
2539
|
+
#
|
2540
|
+
# @option params [String] :session_id
|
2541
|
+
# The unique identifier of the session with the user. The ID is returned
|
2542
|
+
# in the response from the and operations.
|
2543
|
+
#
|
2544
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2545
|
+
#
|
2546
|
+
# @example Request syntax with placeholder values
|
2547
|
+
#
|
2548
|
+
# resp = client.delete_utterances({
|
2549
|
+
# bot_id: "Id", # required
|
2550
|
+
# locale_id: "LocaleId",
|
2551
|
+
# session_id: "SessionId",
|
2552
|
+
# })
|
2553
|
+
#
|
2554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteUtterances AWS API Documentation
|
2555
|
+
#
|
2556
|
+
# @overload delete_utterances(params = {})
|
2557
|
+
# @param [Hash] params ({})
|
2558
|
+
def delete_utterances(params = {}, options = {})
|
2559
|
+
req = build_request(:delete_utterances, params)
|
2560
|
+
req.send_request(options)
|
2561
|
+
end
|
2562
|
+
|
2515
2563
|
# Provides metadata information about a bot.
|
2516
2564
|
#
|
2517
2565
|
# @option params [required, String] :bot_id
|
@@ -3307,6 +3355,146 @@ module Aws::LexModelsV2
|
|
3307
3355
|
req.send_request(options)
|
3308
3356
|
end
|
3309
3357
|
|
3358
|
+
# Provides a list of utterances that users have sent to the bot.
|
3359
|
+
#
|
3360
|
+
# Utterances are aggregated by the text of the utterance. For example,
|
3361
|
+
# all instances where customers used the phrase "I want to order
|
3362
|
+
# pizza" are aggregated into the same line in the response.
|
3363
|
+
#
|
3364
|
+
# You can see both detected utterances and missed utterances. A detected
|
3365
|
+
# utterance is where the bot properly recognized the utterance and
|
3366
|
+
# activated the associated intent. A missed utterance was not recognized
|
3367
|
+
# by the bot and didn't activate an intent.
|
3368
|
+
#
|
3369
|
+
# Utterances can be aggregated for a bot alias or for a bot version, but
|
3370
|
+
# not both at the same time.
|
3371
|
+
#
|
3372
|
+
# Utterances statistics are not generated under the following
|
3373
|
+
# conditions:
|
3374
|
+
#
|
3375
|
+
# * The `childDirected` field was set to true when the bot was created.
|
3376
|
+
#
|
3377
|
+
# * You are using slot obfuscation with one or more slots.
|
3378
|
+
#
|
3379
|
+
# * You opted out of participating in improving Amazon Lex.
|
3380
|
+
#
|
3381
|
+
# @option params [required, String] :bot_id
|
3382
|
+
# The unique identifier of the bot associated with this request.
|
3383
|
+
#
|
3384
|
+
# @option params [String] :bot_alias_id
|
3385
|
+
# The identifier of the bot alias associated with this request. If you
|
3386
|
+
# specify the bot alias, you can't specify the bot version.
|
3387
|
+
#
|
3388
|
+
# @option params [String] :bot_version
|
3389
|
+
# The identifier of the bot version associated with this request. If you
|
3390
|
+
# specify the bot version, you can't specify the bot alias.
|
3391
|
+
#
|
3392
|
+
# @option params [required, String] :locale_id
|
3393
|
+
# The identifier of the language and locale where the utterances were
|
3394
|
+
# collected. For more information, see [Supported languages][1].
|
3395
|
+
#
|
3396
|
+
#
|
3397
|
+
#
|
3398
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
3399
|
+
#
|
3400
|
+
# @option params [required, Types::UtteranceAggregationDuration] :aggregation_duration
|
3401
|
+
# The time window for aggregating the utterance information. You can
|
3402
|
+
# specify a time between one hour and two weeks.
|
3403
|
+
#
|
3404
|
+
# @option params [Types::AggregatedUtterancesSortBy] :sort_by
|
3405
|
+
# Specifies sorting parameters for the list of utterances. You can sort
|
3406
|
+
# by the hit count, the missed count, or the number of distinct sessions
|
3407
|
+
# the utterance appeared in.
|
3408
|
+
#
|
3409
|
+
# @option params [Array<Types::AggregatedUtterancesFilter>] :filters
|
3410
|
+
# Provides the specification of a filter used to limit the utterances in
|
3411
|
+
# the response to only those that match the filter specification. You
|
3412
|
+
# can only specify one filter and one string to filter on.
|
3413
|
+
#
|
3414
|
+
# @option params [Integer] :max_results
|
3415
|
+
# The maximum number of utterances to return in each page of results. If
|
3416
|
+
# there are fewer results than the maximum page size, only the actual
|
3417
|
+
# number of results are returned. If you don't specify the `maxResults`
|
3418
|
+
# parameter, 1,000 results are returned.
|
3419
|
+
#
|
3420
|
+
# @option params [String] :next_token
|
3421
|
+
# If the response from the `ListAggregatedUtterances` operation contains
|
3422
|
+
# more results that specified in the `maxResults` parameter, a token is
|
3423
|
+
# returned in the response. Use that token in the `nextToken` parameter
|
3424
|
+
# to return the next page of results.
|
3425
|
+
#
|
3426
|
+
# @return [Types::ListAggregatedUtterancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3427
|
+
#
|
3428
|
+
# * {Types::ListAggregatedUtterancesResponse#bot_id #bot_id} => String
|
3429
|
+
# * {Types::ListAggregatedUtterancesResponse#bot_alias_id #bot_alias_id} => String
|
3430
|
+
# * {Types::ListAggregatedUtterancesResponse#bot_version #bot_version} => String
|
3431
|
+
# * {Types::ListAggregatedUtterancesResponse#locale_id #locale_id} => String
|
3432
|
+
# * {Types::ListAggregatedUtterancesResponse#aggregation_duration #aggregation_duration} => Types::UtteranceAggregationDuration
|
3433
|
+
# * {Types::ListAggregatedUtterancesResponse#aggregation_window_start_time #aggregation_window_start_time} => Time
|
3434
|
+
# * {Types::ListAggregatedUtterancesResponse#aggregation_window_end_time #aggregation_window_end_time} => Time
|
3435
|
+
# * {Types::ListAggregatedUtterancesResponse#aggregation_last_refreshed_date_time #aggregation_last_refreshed_date_time} => Time
|
3436
|
+
# * {Types::ListAggregatedUtterancesResponse#aggregated_utterances_summaries #aggregated_utterances_summaries} => Array<Types::AggregatedUtterancesSummary>
|
3437
|
+
# * {Types::ListAggregatedUtterancesResponse#next_token #next_token} => String
|
3438
|
+
#
|
3439
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3440
|
+
#
|
3441
|
+
# @example Request syntax with placeholder values
|
3442
|
+
#
|
3443
|
+
# resp = client.list_aggregated_utterances({
|
3444
|
+
# bot_id: "Id", # required
|
3445
|
+
# bot_alias_id: "BotAliasId",
|
3446
|
+
# bot_version: "BotVersion",
|
3447
|
+
# locale_id: "LocaleId", # required
|
3448
|
+
# aggregation_duration: { # required
|
3449
|
+
# relative_aggregation_duration: { # required
|
3450
|
+
# time_dimension: "Hours", # required, accepts Hours, Days, Weeks
|
3451
|
+
# time_value: 1, # required
|
3452
|
+
# },
|
3453
|
+
# },
|
3454
|
+
# sort_by: {
|
3455
|
+
# attribute: "HitCount", # required, accepts HitCount, MissedCount
|
3456
|
+
# order: "Ascending", # required, accepts Ascending, Descending
|
3457
|
+
# },
|
3458
|
+
# filters: [
|
3459
|
+
# {
|
3460
|
+
# name: "Utterance", # required, accepts Utterance
|
3461
|
+
# values: ["FilterValue"], # required
|
3462
|
+
# operator: "CO", # required, accepts CO, EQ
|
3463
|
+
# },
|
3464
|
+
# ],
|
3465
|
+
# max_results: 1,
|
3466
|
+
# next_token: "NextToken",
|
3467
|
+
# })
|
3468
|
+
#
|
3469
|
+
# @example Response structure
|
3470
|
+
#
|
3471
|
+
# resp.bot_id #=> String
|
3472
|
+
# resp.bot_alias_id #=> String
|
3473
|
+
# resp.bot_version #=> String
|
3474
|
+
# resp.locale_id #=> String
|
3475
|
+
# resp.aggregation_duration.relative_aggregation_duration.time_dimension #=> String, one of "Hours", "Days", "Weeks"
|
3476
|
+
# resp.aggregation_duration.relative_aggregation_duration.time_value #=> Integer
|
3477
|
+
# resp.aggregation_window_start_time #=> Time
|
3478
|
+
# resp.aggregation_window_end_time #=> Time
|
3479
|
+
# resp.aggregation_last_refreshed_date_time #=> Time
|
3480
|
+
# resp.aggregated_utterances_summaries #=> Array
|
3481
|
+
# resp.aggregated_utterances_summaries[0].utterance #=> String
|
3482
|
+
# resp.aggregated_utterances_summaries[0].hit_count #=> Integer
|
3483
|
+
# resp.aggregated_utterances_summaries[0].missed_count #=> Integer
|
3484
|
+
# resp.aggregated_utterances_summaries[0].utterance_first_recorded_in_aggregation_duration #=> Time
|
3485
|
+
# resp.aggregated_utterances_summaries[0].utterance_last_recorded_in_aggregation_duration #=> Time
|
3486
|
+
# resp.aggregated_utterances_summaries[0].contains_data_from_deleted_resources #=> Boolean
|
3487
|
+
# resp.next_token #=> String
|
3488
|
+
#
|
3489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListAggregatedUtterances AWS API Documentation
|
3490
|
+
#
|
3491
|
+
# @overload list_aggregated_utterances(params = {})
|
3492
|
+
# @param [Hash] params ({})
|
3493
|
+
def list_aggregated_utterances(params = {}, options = {})
|
3494
|
+
req = build_request(:list_aggregated_utterances, params)
|
3495
|
+
req.send_request(options)
|
3496
|
+
end
|
3497
|
+
|
3310
3498
|
# Gets a list of aliases for the specified bot.
|
3311
3499
|
#
|
3312
3500
|
# @option params [required, String] :bot_id
|
@@ -5713,7 +5901,7 @@ module Aws::LexModelsV2
|
|
5713
5901
|
params: params,
|
5714
5902
|
config: config)
|
5715
5903
|
context[:gem_name] = 'aws-sdk-lexmodelsv2'
|
5716
|
-
context[:gem_version] = '1.
|
5904
|
+
context[:gem_version] = '1.11.0'
|
5717
5905
|
Seahorse::Client::Request.new(handlers, context)
|
5718
5906
|
end
|
5719
5907
|
|
@@ -13,6 +13,14 @@ module Aws::LexModelsV2
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
AggregatedUtterancesFilter = Shapes::StructureShape.new(name: 'AggregatedUtterancesFilter')
|
17
|
+
AggregatedUtterancesFilterName = Shapes::StringShape.new(name: 'AggregatedUtterancesFilterName')
|
18
|
+
AggregatedUtterancesFilterOperator = Shapes::StringShape.new(name: 'AggregatedUtterancesFilterOperator')
|
19
|
+
AggregatedUtterancesFilters = Shapes::ListShape.new(name: 'AggregatedUtterancesFilters')
|
20
|
+
AggregatedUtterancesSortAttribute = Shapes::StringShape.new(name: 'AggregatedUtterancesSortAttribute')
|
21
|
+
AggregatedUtterancesSortBy = Shapes::StructureShape.new(name: 'AggregatedUtterancesSortBy')
|
22
|
+
AggregatedUtterancesSummary = Shapes::StructureShape.new(name: 'AggregatedUtterancesSummary')
|
23
|
+
AggregatedUtterancesSummaryList = Shapes::ListShape.new(name: 'AggregatedUtterancesSummaryList')
|
16
24
|
AmazonResourceName = Shapes::StringShape.new(name: 'AmazonResourceName')
|
17
25
|
AttachmentTitle = Shapes::StringShape.new(name: 'AttachmentTitle')
|
18
26
|
AttachmentUrl = Shapes::StringShape.new(name: 'AttachmentUrl')
|
@@ -136,6 +144,8 @@ module Aws::LexModelsV2
|
|
136
144
|
DeleteResourcePolicyStatementResponse = Shapes::StructureShape.new(name: 'DeleteResourcePolicyStatementResponse')
|
137
145
|
DeleteSlotRequest = Shapes::StructureShape.new(name: 'DeleteSlotRequest')
|
138
146
|
DeleteSlotTypeRequest = Shapes::StructureShape.new(name: 'DeleteSlotTypeRequest')
|
147
|
+
DeleteUtterancesRequest = Shapes::StructureShape.new(name: 'DeleteUtterancesRequest')
|
148
|
+
DeleteUtterancesResponse = Shapes::StructureShape.new(name: 'DeleteUtterancesResponse')
|
139
149
|
DescribeBotAliasRequest = Shapes::StructureShape.new(name: 'DescribeBotAliasRequest')
|
140
150
|
DescribeBotAliasResponse = Shapes::StructureShape.new(name: 'DescribeBotAliasResponse')
|
141
151
|
DescribeBotLocaleRequest = Shapes::StructureShape.new(name: 'DescribeBotLocaleRequest')
|
@@ -176,6 +186,7 @@ module Aws::LexModelsV2
|
|
176
186
|
FilterValue = Shapes::StringShape.new(name: 'FilterValue')
|
177
187
|
FilterValues = Shapes::ListShape.new(name: 'FilterValues')
|
178
188
|
FulfillmentCodeHookSettings = Shapes::StructureShape.new(name: 'FulfillmentCodeHookSettings')
|
189
|
+
HitCount = Shapes::IntegerShape.new(name: 'HitCount')
|
179
190
|
Id = Shapes::StringShape.new(name: 'Id')
|
180
191
|
ImageResponseCard = Shapes::StructureShape.new(name: 'ImageResponseCard')
|
181
192
|
ImportExportFileFormat = Shapes::StringShape.new(name: 'ImportExportFileFormat')
|
@@ -210,6 +221,8 @@ module Aws::LexModelsV2
|
|
210
221
|
KmsKeyArn = Shapes::StringShape.new(name: 'KmsKeyArn')
|
211
222
|
LambdaARN = Shapes::StringShape.new(name: 'LambdaARN')
|
212
223
|
LambdaCodeHook = Shapes::StructureShape.new(name: 'LambdaCodeHook')
|
224
|
+
ListAggregatedUtterancesRequest = Shapes::StructureShape.new(name: 'ListAggregatedUtterancesRequest')
|
225
|
+
ListAggregatedUtterancesResponse = Shapes::StructureShape.new(name: 'ListAggregatedUtterancesResponse')
|
213
226
|
ListBotAliasesRequest = Shapes::StructureShape.new(name: 'ListBotAliasesRequest')
|
214
227
|
ListBotAliasesResponse = Shapes::StructureShape.new(name: 'ListBotAliasesResponse')
|
215
228
|
ListBotLocalesRequest = Shapes::StructureShape.new(name: 'ListBotLocalesRequest')
|
@@ -243,6 +256,7 @@ module Aws::LexModelsV2
|
|
243
256
|
MessageGroup = Shapes::StructureShape.new(name: 'MessageGroup')
|
244
257
|
MessageGroupsList = Shapes::ListShape.new(name: 'MessageGroupsList')
|
245
258
|
MessageVariationsList = Shapes::ListShape.new(name: 'MessageVariationsList')
|
259
|
+
MissedCount = Shapes::IntegerShape.new(name: 'MissedCount')
|
246
260
|
MultipleValuesSetting = Shapes::StructureShape.new(name: 'MultipleValuesSetting')
|
247
261
|
Name = Shapes::StringShape.new(name: 'Name')
|
248
262
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
@@ -266,6 +280,7 @@ module Aws::LexModelsV2
|
|
266
280
|
PromptSpecification = Shapes::StructureShape.new(name: 'PromptSpecification')
|
267
281
|
QueryFilterString = Shapes::StringShape.new(name: 'QueryFilterString')
|
268
282
|
RegexPattern = Shapes::StringShape.new(name: 'RegexPattern')
|
283
|
+
RelativeAggregationDuration = Shapes::StructureShape.new(name: 'RelativeAggregationDuration')
|
269
284
|
ResourceCount = Shapes::IntegerShape.new(name: 'ResourceCount')
|
270
285
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
271
286
|
ResponseSpecification = Shapes::StructureShape.new(name: 'ResponseSpecification')
|
@@ -282,6 +297,7 @@ module Aws::LexModelsV2
|
|
282
297
|
SentimentAnalysisSettings = Shapes::StructureShape.new(name: 'SentimentAnalysisSettings')
|
283
298
|
ServicePrincipal = Shapes::StringShape.new(name: 'ServicePrincipal')
|
284
299
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
300
|
+
SessionId = Shapes::StringShape.new(name: 'SessionId')
|
285
301
|
SessionTTL = Shapes::IntegerShape.new(name: 'SessionTTL')
|
286
302
|
SkipResourceInUseCheck = Shapes::BooleanShape.new(name: 'SkipResourceInUseCheck')
|
287
303
|
SlotConstraint = Shapes::StringShape.new(name: 'SlotConstraint')
|
@@ -331,6 +347,8 @@ module Aws::LexModelsV2
|
|
331
347
|
TextLogSetting = Shapes::StructureShape.new(name: 'TextLogSetting')
|
332
348
|
TextLogSettingsList = Shapes::ListShape.new(name: 'TextLogSettingsList')
|
333
349
|
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
350
|
+
TimeDimension = Shapes::StringShape.new(name: 'TimeDimension')
|
351
|
+
TimeValue = Shapes::IntegerShape.new(name: 'TimeValue')
|
334
352
|
Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
|
335
353
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
336
354
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
@@ -351,12 +369,34 @@ module Aws::LexModelsV2
|
|
351
369
|
UpdateSlotTypeRequest = Shapes::StructureShape.new(name: 'UpdateSlotTypeRequest')
|
352
370
|
UpdateSlotTypeResponse = Shapes::StructureShape.new(name: 'UpdateSlotTypeResponse')
|
353
371
|
Utterance = Shapes::StringShape.new(name: 'Utterance')
|
372
|
+
UtteranceAggregationDuration = Shapes::StructureShape.new(name: 'UtteranceAggregationDuration')
|
354
373
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
355
374
|
Value = Shapes::StringShape.new(name: 'Value')
|
356
375
|
VoiceId = Shapes::StringShape.new(name: 'VoiceId')
|
357
376
|
VoiceSettings = Shapes::StructureShape.new(name: 'VoiceSettings')
|
358
377
|
WaitAndContinueSpecification = Shapes::StructureShape.new(name: 'WaitAndContinueSpecification')
|
359
378
|
|
379
|
+
AggregatedUtterancesFilter.add_member(:name, Shapes::ShapeRef.new(shape: AggregatedUtterancesFilterName, required: true, location_name: "name"))
|
380
|
+
AggregatedUtterancesFilter.add_member(:values, Shapes::ShapeRef.new(shape: FilterValues, required: true, location_name: "values"))
|
381
|
+
AggregatedUtterancesFilter.add_member(:operator, Shapes::ShapeRef.new(shape: AggregatedUtterancesFilterOperator, required: true, location_name: "operator"))
|
382
|
+
AggregatedUtterancesFilter.struct_class = Types::AggregatedUtterancesFilter
|
383
|
+
|
384
|
+
AggregatedUtterancesFilters.member = Shapes::ShapeRef.new(shape: AggregatedUtterancesFilter)
|
385
|
+
|
386
|
+
AggregatedUtterancesSortBy.add_member(:attribute, Shapes::ShapeRef.new(shape: AggregatedUtterancesSortAttribute, required: true, location_name: "attribute"))
|
387
|
+
AggregatedUtterancesSortBy.add_member(:order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "order"))
|
388
|
+
AggregatedUtterancesSortBy.struct_class = Types::AggregatedUtterancesSortBy
|
389
|
+
|
390
|
+
AggregatedUtterancesSummary.add_member(:utterance, Shapes::ShapeRef.new(shape: Utterance, location_name: "utterance"))
|
391
|
+
AggregatedUtterancesSummary.add_member(:hit_count, Shapes::ShapeRef.new(shape: HitCount, location_name: "hitCount"))
|
392
|
+
AggregatedUtterancesSummary.add_member(:missed_count, Shapes::ShapeRef.new(shape: MissedCount, location_name: "missedCount"))
|
393
|
+
AggregatedUtterancesSummary.add_member(:utterance_first_recorded_in_aggregation_duration, Shapes::ShapeRef.new(shape: Timestamp, location_name: "utteranceFirstRecordedInAggregationDuration"))
|
394
|
+
AggregatedUtterancesSummary.add_member(:utterance_last_recorded_in_aggregation_duration, Shapes::ShapeRef.new(shape: Timestamp, location_name: "utteranceLastRecordedInAggregationDuration"))
|
395
|
+
AggregatedUtterancesSummary.add_member(:contains_data_from_deleted_resources, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "containsDataFromDeletedResources"))
|
396
|
+
AggregatedUtterancesSummary.struct_class = Types::AggregatedUtterancesSummary
|
397
|
+
|
398
|
+
AggregatedUtterancesSummaryList.member = Shapes::ShapeRef.new(shape: AggregatedUtterancesSummary)
|
399
|
+
|
360
400
|
AudioLogDestination.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: S3BucketLogDestination, required: true, location_name: "s3Bucket"))
|
361
401
|
AudioLogDestination.struct_class = Types::AudioLogDestination
|
362
402
|
|
@@ -833,6 +873,13 @@ module Aws::LexModelsV2
|
|
833
873
|
DeleteSlotTypeRequest.add_member(:skip_resource_in_use_check, Shapes::ShapeRef.new(shape: SkipResourceInUseCheck, location: "querystring", location_name: "skipResourceInUseCheck"))
|
834
874
|
DeleteSlotTypeRequest.struct_class = Types::DeleteSlotTypeRequest
|
835
875
|
|
876
|
+
DeleteUtterancesRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId"))
|
877
|
+
DeleteUtterancesRequest.add_member(:locale_id, Shapes::ShapeRef.new(shape: LocaleId, location: "querystring", location_name: "localeId"))
|
878
|
+
DeleteUtterancesRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, location: "querystring", location_name: "sessionId"))
|
879
|
+
DeleteUtterancesRequest.struct_class = Types::DeleteUtterancesRequest
|
880
|
+
|
881
|
+
DeleteUtterancesResponse.struct_class = Types::DeleteUtterancesResponse
|
882
|
+
|
836
883
|
DescribeBotAliasRequest.add_member(:bot_alias_id, Shapes::ShapeRef.new(shape: BotAliasId, required: true, location: "uri", location_name: "botAliasId"))
|
837
884
|
DescribeBotAliasRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId"))
|
838
885
|
DescribeBotAliasRequest.struct_class = Types::DescribeBotAliasRequest
|
@@ -1120,6 +1167,29 @@ module Aws::LexModelsV2
|
|
1120
1167
|
LambdaCodeHook.add_member(:code_hook_interface_version, Shapes::ShapeRef.new(shape: CodeHookInterfaceVersion, required: true, location_name: "codeHookInterfaceVersion"))
|
1121
1168
|
LambdaCodeHook.struct_class = Types::LambdaCodeHook
|
1122
1169
|
|
1170
|
+
ListAggregatedUtterancesRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId"))
|
1171
|
+
ListAggregatedUtterancesRequest.add_member(:bot_alias_id, Shapes::ShapeRef.new(shape: BotAliasId, location_name: "botAliasId"))
|
1172
|
+
ListAggregatedUtterancesRequest.add_member(:bot_version, Shapes::ShapeRef.new(shape: BotVersion, location_name: "botVersion"))
|
1173
|
+
ListAggregatedUtterancesRequest.add_member(:locale_id, Shapes::ShapeRef.new(shape: LocaleId, required: true, location_name: "localeId"))
|
1174
|
+
ListAggregatedUtterancesRequest.add_member(:aggregation_duration, Shapes::ShapeRef.new(shape: UtteranceAggregationDuration, required: true, location_name: "aggregationDuration"))
|
1175
|
+
ListAggregatedUtterancesRequest.add_member(:sort_by, Shapes::ShapeRef.new(shape: AggregatedUtterancesSortBy, location_name: "sortBy"))
|
1176
|
+
ListAggregatedUtterancesRequest.add_member(:filters, Shapes::ShapeRef.new(shape: AggregatedUtterancesFilters, location_name: "filters"))
|
1177
|
+
ListAggregatedUtterancesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
|
1178
|
+
ListAggregatedUtterancesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1179
|
+
ListAggregatedUtterancesRequest.struct_class = Types::ListAggregatedUtterancesRequest
|
1180
|
+
|
1181
|
+
ListAggregatedUtterancesResponse.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, location_name: "botId"))
|
1182
|
+
ListAggregatedUtterancesResponse.add_member(:bot_alias_id, Shapes::ShapeRef.new(shape: BotAliasId, location_name: "botAliasId"))
|
1183
|
+
ListAggregatedUtterancesResponse.add_member(:bot_version, Shapes::ShapeRef.new(shape: BotVersion, location_name: "botVersion"))
|
1184
|
+
ListAggregatedUtterancesResponse.add_member(:locale_id, Shapes::ShapeRef.new(shape: LocaleId, location_name: "localeId"))
|
1185
|
+
ListAggregatedUtterancesResponse.add_member(:aggregation_duration, Shapes::ShapeRef.new(shape: UtteranceAggregationDuration, location_name: "aggregationDuration"))
|
1186
|
+
ListAggregatedUtterancesResponse.add_member(:aggregation_window_start_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "aggregationWindowStartTime"))
|
1187
|
+
ListAggregatedUtterancesResponse.add_member(:aggregation_window_end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "aggregationWindowEndTime"))
|
1188
|
+
ListAggregatedUtterancesResponse.add_member(:aggregation_last_refreshed_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "aggregationLastRefreshedDateTime"))
|
1189
|
+
ListAggregatedUtterancesResponse.add_member(:aggregated_utterances_summaries, Shapes::ShapeRef.new(shape: AggregatedUtterancesSummaryList, location_name: "aggregatedUtterancesSummaries"))
|
1190
|
+
ListAggregatedUtterancesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1191
|
+
ListAggregatedUtterancesResponse.struct_class = Types::ListAggregatedUtterancesResponse
|
1192
|
+
|
1123
1193
|
ListBotAliasesRequest.add_member(:bot_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "botId"))
|
1124
1194
|
ListBotAliasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "maxResults"))
|
1125
1195
|
ListBotAliasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
@@ -1317,6 +1387,10 @@ module Aws::LexModelsV2
|
|
1317
1387
|
PromptSpecification.add_member(:allow_interrupt, Shapes::ShapeRef.new(shape: BoxedBoolean, location_name: "allowInterrupt"))
|
1318
1388
|
PromptSpecification.struct_class = Types::PromptSpecification
|
1319
1389
|
|
1390
|
+
RelativeAggregationDuration.add_member(:time_dimension, Shapes::ShapeRef.new(shape: TimeDimension, required: true, location_name: "timeDimension"))
|
1391
|
+
RelativeAggregationDuration.add_member(:time_value, Shapes::ShapeRef.new(shape: TimeValue, required: true, location_name: "timeValue"))
|
1392
|
+
RelativeAggregationDuration.struct_class = Types::RelativeAggregationDuration
|
1393
|
+
|
1320
1394
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
1321
1395
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
1322
1396
|
|
@@ -1647,6 +1721,9 @@ module Aws::LexModelsV2
|
|
1647
1721
|
UpdateSlotTypeResponse.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdatedDateTime"))
|
1648
1722
|
UpdateSlotTypeResponse.struct_class = Types::UpdateSlotTypeResponse
|
1649
1723
|
|
1724
|
+
UtteranceAggregationDuration.add_member(:relative_aggregation_duration, Shapes::ShapeRef.new(shape: RelativeAggregationDuration, required: true, location_name: "relativeAggregationDuration"))
|
1725
|
+
UtteranceAggregationDuration.struct_class = Types::UtteranceAggregationDuration
|
1726
|
+
|
1650
1727
|
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
|
1651
1728
|
ValidationException.struct_class = Types::ValidationException
|
1652
1729
|
|
@@ -1994,6 +2071,17 @@ module Aws::LexModelsV2
|
|
1994
2071
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1995
2072
|
end)
|
1996
2073
|
|
2074
|
+
api.add_operation(:delete_utterances, Seahorse::Model::Operation.new.tap do |o|
|
2075
|
+
o.name = "DeleteUtterances"
|
2076
|
+
o.http_method = "DELETE"
|
2077
|
+
o.http_request_uri = "/bots/{botId}/utterances/"
|
2078
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteUtterancesRequest)
|
2079
|
+
o.output = Shapes::ShapeRef.new(shape: DeleteUtterancesResponse)
|
2080
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
2081
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2082
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2083
|
+
end)
|
2084
|
+
|
1997
2085
|
api.add_operation(:describe_bot, Seahorse::Model::Operation.new.tap do |o|
|
1998
2086
|
o.name = "DescribeBot"
|
1999
2087
|
o.http_method = "GET"
|
@@ -2120,6 +2208,24 @@ module Aws::LexModelsV2
|
|
2120
2208
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2121
2209
|
end)
|
2122
2210
|
|
2211
|
+
api.add_operation(:list_aggregated_utterances, Seahorse::Model::Operation.new.tap do |o|
|
2212
|
+
o.name = "ListAggregatedUtterances"
|
2213
|
+
o.http_method = "POST"
|
2214
|
+
o.http_request_uri = "/bots/{botId}/aggregatedutterances/"
|
2215
|
+
o.input = Shapes::ShapeRef.new(shape: ListAggregatedUtterancesRequest)
|
2216
|
+
o.output = Shapes::ShapeRef.new(shape: ListAggregatedUtterancesResponse)
|
2217
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
2218
|
+
o.errors << Shapes::ShapeRef.new(shape: PreconditionFailedException)
|
2219
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2220
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
2221
|
+
o[:pager] = Aws::Pager.new(
|
2222
|
+
limit_key: "max_results",
|
2223
|
+
tokens: {
|
2224
|
+
"next_token" => "next_token"
|
2225
|
+
}
|
2226
|
+
)
|
2227
|
+
end)
|
2228
|
+
|
2123
2229
|
api.add_operation(:list_bot_aliases, Seahorse::Model::Operation.new.tap do |o|
|
2124
2230
|
o.name = "ListBotAliases"
|
2125
2231
|
o.http_method = "POST"
|
@@ -10,6 +10,125 @@
|
|
10
10
|
module Aws::LexModelsV2
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Filters responses returned by the `ListAggregatedUtterances`
|
14
|
+
# operation.
|
15
|
+
#
|
16
|
+
# @note When making an API call, you may pass AggregatedUtterancesFilter
|
17
|
+
# data as a hash:
|
18
|
+
#
|
19
|
+
# {
|
20
|
+
# name: "Utterance", # required, accepts Utterance
|
21
|
+
# values: ["FilterValue"], # required
|
22
|
+
# operator: "CO", # required, accepts CO, EQ
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# The name of the field to filter the utterance list.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] values
|
30
|
+
# The value to use for filtering the list of bots.
|
31
|
+
# @return [Array<String>]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] operator
|
34
|
+
# The operator to use for the filter. Specify `EQ` when the
|
35
|
+
# `ListAggregatedUtterances` operation should return only utterances
|
36
|
+
# that equal the specified value. Specify `CO` when the
|
37
|
+
# `ListAggregatedUtterances` operation should return utterances that
|
38
|
+
# contain the specified value.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesFilter AWS API Documentation
|
42
|
+
#
|
43
|
+
class AggregatedUtterancesFilter < Struct.new(
|
44
|
+
:name,
|
45
|
+
:values,
|
46
|
+
:operator)
|
47
|
+
SENSITIVE = []
|
48
|
+
include Aws::Structure
|
49
|
+
end
|
50
|
+
|
51
|
+
# Specifies attributes for sorting a list of utterances.
|
52
|
+
#
|
53
|
+
# @note When making an API call, you may pass AggregatedUtterancesSortBy
|
54
|
+
# data as a hash:
|
55
|
+
#
|
56
|
+
# {
|
57
|
+
# attribute: "HitCount", # required, accepts HitCount, MissedCount
|
58
|
+
# order: "Ascending", # required, accepts Ascending, Descending
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# @!attribute [rw] attribute
|
62
|
+
# The utterance attribute to sort by.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @!attribute [rw] order
|
66
|
+
# Specifies whether to sort the aggregated utterances in ascending or
|
67
|
+
# descending order.
|
68
|
+
# @return [String]
|
69
|
+
#
|
70
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesSortBy AWS API Documentation
|
71
|
+
#
|
72
|
+
class AggregatedUtterancesSortBy < Struct.new(
|
73
|
+
:attribute,
|
74
|
+
:order)
|
75
|
+
SENSITIVE = []
|
76
|
+
include Aws::Structure
|
77
|
+
end
|
78
|
+
|
79
|
+
# Provides summary information for aggregated utterances. The
|
80
|
+
# `ListAggregatedUtterances` operations combines all instances of the
|
81
|
+
# same utterance into a single aggregated summary.
|
82
|
+
#
|
83
|
+
# @!attribute [rw] utterance
|
84
|
+
# The text of the utterance. If the utterance was used with the
|
85
|
+
# `RecognizeUtterance` operation, the text is the transcription of the
|
86
|
+
# audio utterance.
|
87
|
+
# @return [String]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] hit_count
|
90
|
+
# The number of times that the utterance was detected by Amazon Lex
|
91
|
+
# during the time period. When an utterance is detected, it activates
|
92
|
+
# an intent or a slot.
|
93
|
+
# @return [Integer]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] missed_count
|
96
|
+
# The number of times that the utterance was missed by Amazon Lex An
|
97
|
+
# utterance is missed when it doesn't activate an intent or slot.
|
98
|
+
# @return [Integer]
|
99
|
+
#
|
100
|
+
# @!attribute [rw] utterance_first_recorded_in_aggregation_duration
|
101
|
+
# The date and time that the utterance was first recorded in the time
|
102
|
+
# window for aggregation. An utterance may have been sent to Amazon
|
103
|
+
# Lex before that time, but only utterances within the time window are
|
104
|
+
# counted.
|
105
|
+
# @return [Time]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] utterance_last_recorded_in_aggregation_duration
|
108
|
+
# The last date and time that an utterance was recorded in the time
|
109
|
+
# window for aggregation. An utterance may be sent to Amazon Lex after
|
110
|
+
# that time, but only utterances within the time window are counted.
|
111
|
+
# @return [Time]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] contains_data_from_deleted_resources
|
114
|
+
# Aggregated utterance data may contain utterances from versions of
|
115
|
+
# your bot that have since been deleted. When the aggregated contains
|
116
|
+
# this kind of data, this field is set to true.
|
117
|
+
# @return [Boolean]
|
118
|
+
#
|
119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesSummary AWS API Documentation
|
120
|
+
#
|
121
|
+
class AggregatedUtterancesSummary < Struct.new(
|
122
|
+
:utterance,
|
123
|
+
:hit_count,
|
124
|
+
:missed_count,
|
125
|
+
:utterance_first_recorded_in_aggregation_duration,
|
126
|
+
:utterance_last_recorded_in_aggregation_duration,
|
127
|
+
:contains_data_from_deleted_resources)
|
128
|
+
SENSITIVE = []
|
129
|
+
include Aws::Structure
|
130
|
+
end
|
131
|
+
|
13
132
|
# The location of audio log files collected when conversation logging is
|
14
133
|
# enabled for a bot.
|
15
134
|
#
|
@@ -968,6 +1087,10 @@ module Aws::LexModelsV2
|
|
968
1087
|
include Aws::Structure
|
969
1088
|
end
|
970
1089
|
|
1090
|
+
# The action that you tried to perform couldn't be completed because
|
1091
|
+
# the resource is in a conflicting state. For example, deleting a bot
|
1092
|
+
# that is in the CREATING state. Try your request again.
|
1093
|
+
#
|
971
1094
|
# @!attribute [rw] message
|
972
1095
|
# @return [String]
|
973
1096
|
#
|
@@ -3480,6 +3603,48 @@ module Aws::LexModelsV2
|
|
3480
3603
|
include Aws::Structure
|
3481
3604
|
end
|
3482
3605
|
|
3606
|
+
# @note When making an API call, you may pass DeleteUtterancesRequest
|
3607
|
+
# data as a hash:
|
3608
|
+
#
|
3609
|
+
# {
|
3610
|
+
# bot_id: "Id", # required
|
3611
|
+
# locale_id: "LocaleId",
|
3612
|
+
# session_id: "SessionId",
|
3613
|
+
# }
|
3614
|
+
#
|
3615
|
+
# @!attribute [rw] bot_id
|
3616
|
+
# The unique identifier of the bot that contains the utterances.
|
3617
|
+
# @return [String]
|
3618
|
+
#
|
3619
|
+
# @!attribute [rw] locale_id
|
3620
|
+
# The identifier of the language and locale where the utterances were
|
3621
|
+
# collected. The string must match one of the supported locales. For
|
3622
|
+
# more information, see [Supported languages][1].
|
3623
|
+
#
|
3624
|
+
#
|
3625
|
+
#
|
3626
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
3627
|
+
# @return [String]
|
3628
|
+
#
|
3629
|
+
# @!attribute [rw] session_id
|
3630
|
+
# The unique identifier of the session with the user. The ID is
|
3631
|
+
# returned in the response from the and operations.
|
3632
|
+
# @return [String]
|
3633
|
+
#
|
3634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteUtterancesRequest AWS API Documentation
|
3635
|
+
#
|
3636
|
+
class DeleteUtterancesRequest < Struct.new(
|
3637
|
+
:bot_id,
|
3638
|
+
:locale_id,
|
3639
|
+
:session_id)
|
3640
|
+
SENSITIVE = []
|
3641
|
+
include Aws::Structure
|
3642
|
+
end
|
3643
|
+
|
3644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteUtterancesResponse AWS API Documentation
|
3645
|
+
#
|
3646
|
+
class DeleteUtterancesResponse < Aws::EmptyStructure; end
|
3647
|
+
|
3483
3648
|
# @note When making an API call, you may pass DescribeBotAliasRequest
|
3484
3649
|
# data as a hash:
|
3485
3650
|
#
|
@@ -5216,6 +5381,9 @@ module Aws::LexModelsV2
|
|
5216
5381
|
include Aws::Structure
|
5217
5382
|
end
|
5218
5383
|
|
5384
|
+
# The service encountered an unexpected condition. Try your request
|
5385
|
+
# again.
|
5386
|
+
#
|
5219
5387
|
# @!attribute [rw] message
|
5220
5388
|
# @return [String]
|
5221
5389
|
#
|
@@ -5301,6 +5469,184 @@ module Aws::LexModelsV2
|
|
5301
5469
|
include Aws::Structure
|
5302
5470
|
end
|
5303
5471
|
|
5472
|
+
# @note When making an API call, you may pass ListAggregatedUtterancesRequest
|
5473
|
+
# data as a hash:
|
5474
|
+
#
|
5475
|
+
# {
|
5476
|
+
# bot_id: "Id", # required
|
5477
|
+
# bot_alias_id: "BotAliasId",
|
5478
|
+
# bot_version: "BotVersion",
|
5479
|
+
# locale_id: "LocaleId", # required
|
5480
|
+
# aggregation_duration: { # required
|
5481
|
+
# relative_aggregation_duration: { # required
|
5482
|
+
# time_dimension: "Hours", # required, accepts Hours, Days, Weeks
|
5483
|
+
# time_value: 1, # required
|
5484
|
+
# },
|
5485
|
+
# },
|
5486
|
+
# sort_by: {
|
5487
|
+
# attribute: "HitCount", # required, accepts HitCount, MissedCount
|
5488
|
+
# order: "Ascending", # required, accepts Ascending, Descending
|
5489
|
+
# },
|
5490
|
+
# filters: [
|
5491
|
+
# {
|
5492
|
+
# name: "Utterance", # required, accepts Utterance
|
5493
|
+
# values: ["FilterValue"], # required
|
5494
|
+
# operator: "CO", # required, accepts CO, EQ
|
5495
|
+
# },
|
5496
|
+
# ],
|
5497
|
+
# max_results: 1,
|
5498
|
+
# next_token: "NextToken",
|
5499
|
+
# }
|
5500
|
+
#
|
5501
|
+
# @!attribute [rw] bot_id
|
5502
|
+
# The unique identifier of the bot associated with this request.
|
5503
|
+
# @return [String]
|
5504
|
+
#
|
5505
|
+
# @!attribute [rw] bot_alias_id
|
5506
|
+
# The identifier of the bot alias associated with this request. If you
|
5507
|
+
# specify the bot alias, you can't specify the bot version.
|
5508
|
+
# @return [String]
|
5509
|
+
#
|
5510
|
+
# @!attribute [rw] bot_version
|
5511
|
+
# The identifier of the bot version associated with this request. If
|
5512
|
+
# you specify the bot version, you can't specify the bot alias.
|
5513
|
+
# @return [String]
|
5514
|
+
#
|
5515
|
+
# @!attribute [rw] locale_id
|
5516
|
+
# The identifier of the language and locale where the utterances were
|
5517
|
+
# collected. For more information, see [Supported languages][1].
|
5518
|
+
#
|
5519
|
+
#
|
5520
|
+
#
|
5521
|
+
# [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
|
5522
|
+
# @return [String]
|
5523
|
+
#
|
5524
|
+
# @!attribute [rw] aggregation_duration
|
5525
|
+
# The time window for aggregating the utterance information. You can
|
5526
|
+
# specify a time between one hour and two weeks.
|
5527
|
+
# @return [Types::UtteranceAggregationDuration]
|
5528
|
+
#
|
5529
|
+
# @!attribute [rw] sort_by
|
5530
|
+
# Specifies sorting parameters for the list of utterances. You can
|
5531
|
+
# sort by the hit count, the missed count, or the number of distinct
|
5532
|
+
# sessions the utterance appeared in.
|
5533
|
+
# @return [Types::AggregatedUtterancesSortBy]
|
5534
|
+
#
|
5535
|
+
# @!attribute [rw] filters
|
5536
|
+
# Provides the specification of a filter used to limit the utterances
|
5537
|
+
# in the response to only those that match the filter specification.
|
5538
|
+
# You can only specify one filter and one string to filter on.
|
5539
|
+
# @return [Array<Types::AggregatedUtterancesFilter>]
|
5540
|
+
#
|
5541
|
+
# @!attribute [rw] max_results
|
5542
|
+
# The maximum number of utterances to return in each page of results.
|
5543
|
+
# If there are fewer results than the maximum page size, only the
|
5544
|
+
# actual number of results are returned. If you don't specify the
|
5545
|
+
# `maxResults` parameter, 1,000 results are returned.
|
5546
|
+
# @return [Integer]
|
5547
|
+
#
|
5548
|
+
# @!attribute [rw] next_token
|
5549
|
+
# If the response from the `ListAggregatedUtterances` operation
|
5550
|
+
# contains more results that specified in the `maxResults` parameter,
|
5551
|
+
# a token is returned in the response. Use that token in the
|
5552
|
+
# `nextToken` parameter to return the next page of results.
|
5553
|
+
# @return [String]
|
5554
|
+
#
|
5555
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListAggregatedUtterancesRequest AWS API Documentation
|
5556
|
+
#
|
5557
|
+
class ListAggregatedUtterancesRequest < Struct.new(
|
5558
|
+
:bot_id,
|
5559
|
+
:bot_alias_id,
|
5560
|
+
:bot_version,
|
5561
|
+
:locale_id,
|
5562
|
+
:aggregation_duration,
|
5563
|
+
:sort_by,
|
5564
|
+
:filters,
|
5565
|
+
:max_results,
|
5566
|
+
:next_token)
|
5567
|
+
SENSITIVE = []
|
5568
|
+
include Aws::Structure
|
5569
|
+
end
|
5570
|
+
|
5571
|
+
# @!attribute [rw] bot_id
|
5572
|
+
# The identifier of the bot that contains the utterances.
|
5573
|
+
# @return [String]
|
5574
|
+
#
|
5575
|
+
# @!attribute [rw] bot_alias_id
|
5576
|
+
# The identifier of the bot alias that contains the utterances. If you
|
5577
|
+
# specified the bot version, the bot alias ID isn't returned.
|
5578
|
+
# @return [String]
|
5579
|
+
#
|
5580
|
+
# @!attribute [rw] bot_version
|
5581
|
+
# The identifier of the bot version that contains the utterances. If
|
5582
|
+
# you specified the bot alias, the bot version isn't returned.
|
5583
|
+
# @return [String]
|
5584
|
+
#
|
5585
|
+
# @!attribute [rw] locale_id
|
5586
|
+
# The identifier of the language and locale that the utterances are
|
5587
|
+
# in.
|
5588
|
+
# @return [String]
|
5589
|
+
#
|
5590
|
+
# @!attribute [rw] aggregation_duration
|
5591
|
+
# The time period used to aggregate the utterance data.
|
5592
|
+
# @return [Types::UtteranceAggregationDuration]
|
5593
|
+
#
|
5594
|
+
# @!attribute [rw] aggregation_window_start_time
|
5595
|
+
# The date and time that the aggregation window begins. Only data
|
5596
|
+
# collected after this time is returned in the results.
|
5597
|
+
# @return [Time]
|
5598
|
+
#
|
5599
|
+
# @!attribute [rw] aggregation_window_end_time
|
5600
|
+
# The date and time that the aggregation window ends. Only data
|
5601
|
+
# collected between the start time and the end time are returned in
|
5602
|
+
# the results.
|
5603
|
+
# @return [Time]
|
5604
|
+
#
|
5605
|
+
# @!attribute [rw] aggregation_last_refreshed_date_time
|
5606
|
+
# The last date and time that the aggregated data was collected. The
|
5607
|
+
# time period depends on the length of the aggregation window.
|
5608
|
+
#
|
5609
|
+
# * **Hours** - for 1 hour time window, every half hour; otherwise
|
5610
|
+
# every hour.
|
5611
|
+
#
|
5612
|
+
# * **Days** - every 6 hours
|
5613
|
+
#
|
5614
|
+
# * **Weeks** - for a one week time window, every 12 hours; otherwise,
|
5615
|
+
# every day
|
5616
|
+
# @return [Time]
|
5617
|
+
#
|
5618
|
+
# @!attribute [rw] aggregated_utterances_summaries
|
5619
|
+
# Summaries of the aggregated utterance data. Each response contains
|
5620
|
+
# information about the number of times that the utterance was seen
|
5621
|
+
# during the time period, whether it was detected or missed, and when
|
5622
|
+
# it was seen during the time period.
|
5623
|
+
# @return [Array<Types::AggregatedUtterancesSummary>]
|
5624
|
+
#
|
5625
|
+
# @!attribute [rw] next_token
|
5626
|
+
# A token that indicates whether there are more results to return in a
|
5627
|
+
# response to the `ListAggregatedUtterances` operation. If the
|
5628
|
+
# `nextToken` field is present, you send the contents as the
|
5629
|
+
# `nextToken` parameter of a `ListAggregatedUtterances` operation
|
5630
|
+
# request to get the next page of results.
|
5631
|
+
# @return [String]
|
5632
|
+
#
|
5633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListAggregatedUtterancesResponse AWS API Documentation
|
5634
|
+
#
|
5635
|
+
class ListAggregatedUtterancesResponse < Struct.new(
|
5636
|
+
:bot_id,
|
5637
|
+
:bot_alias_id,
|
5638
|
+
:bot_version,
|
5639
|
+
:locale_id,
|
5640
|
+
:aggregation_duration,
|
5641
|
+
:aggregation_window_start_time,
|
5642
|
+
:aggregation_window_end_time,
|
5643
|
+
:aggregation_last_refreshed_date_time,
|
5644
|
+
:aggregated_utterances_summaries,
|
5645
|
+
:next_token)
|
5646
|
+
SENSITIVE = []
|
5647
|
+
include Aws::Structure
|
5648
|
+
end
|
5649
|
+
|
5304
5650
|
# @note When making an API call, you may pass ListBotAliasesRequest
|
5305
5651
|
# data as a hash:
|
5306
5652
|
#
|
@@ -6626,6 +6972,9 @@ module Aws::LexModelsV2
|
|
6626
6972
|
include Aws::Structure
|
6627
6973
|
end
|
6628
6974
|
|
6975
|
+
# Your request couldn't be completed because one or more request fields
|
6976
|
+
# aren't valid. Check the fields in your request and try again.
|
6977
|
+
#
|
6629
6978
|
# @!attribute [rw] message
|
6630
6979
|
# @return [String]
|
6631
6980
|
#
|
@@ -6758,6 +7107,61 @@ module Aws::LexModelsV2
|
|
6758
7107
|
include Aws::Structure
|
6759
7108
|
end
|
6760
7109
|
|
7110
|
+
# Specifies the time window that utterance statistics are returned for.
|
7111
|
+
# The time window is always relative to the last time that the that
|
7112
|
+
# utterances were aggregated. For example, if the
|
7113
|
+
# `ListAggregatedUtterances` operation is called at 1600, the time
|
7114
|
+
# window is set to 1 hour, and the last refresh time was 1530, only
|
7115
|
+
# utterances made between 1430 and 1530 are returned.
|
7116
|
+
#
|
7117
|
+
# You can choose the time window that statistics should be returned for.
|
7118
|
+
#
|
7119
|
+
# * **Hours** - You can request utterance statistics for 1, 3, 6, 12, or
|
7120
|
+
# 24 hour time windows. Statistics are refreshed every half hour for 1
|
7121
|
+
# hour time windows, and hourly for the other time windows.
|
7122
|
+
#
|
7123
|
+
# * **Days** - You can request utterance statistics for 3 days.
|
7124
|
+
# Statistics are refreshed every 6 hours.
|
7125
|
+
#
|
7126
|
+
# * **Weeks** - You can see statistics for one or two weeks. Statistics
|
7127
|
+
# are refreshed every 12 hours for one week time windows, and once per
|
7128
|
+
# day for two week time windows.
|
7129
|
+
#
|
7130
|
+
# @note When making an API call, you may pass RelativeAggregationDuration
|
7131
|
+
# data as a hash:
|
7132
|
+
#
|
7133
|
+
# {
|
7134
|
+
# time_dimension: "Hours", # required, accepts Hours, Days, Weeks
|
7135
|
+
# time_value: 1, # required
|
7136
|
+
# }
|
7137
|
+
#
|
7138
|
+
# @!attribute [rw] time_dimension
|
7139
|
+
# The type of time period that the `timeValue` field represents.
|
7140
|
+
# @return [String]
|
7141
|
+
#
|
7142
|
+
# @!attribute [rw] time_value
|
7143
|
+
# The period of the time window to gather statistics for. The valid
|
7144
|
+
# value depends on the setting of the `timeDimension` field.
|
7145
|
+
#
|
7146
|
+
# * `Hours` - 1/3/6/12/24
|
7147
|
+
#
|
7148
|
+
# * `Days` - 3
|
7149
|
+
#
|
7150
|
+
# * `Weeks` - 1/2
|
7151
|
+
# @return [Integer]
|
7152
|
+
#
|
7153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RelativeAggregationDuration AWS API Documentation
|
7154
|
+
#
|
7155
|
+
class RelativeAggregationDuration < Struct.new(
|
7156
|
+
:time_dimension,
|
7157
|
+
:time_value)
|
7158
|
+
SENSITIVE = []
|
7159
|
+
include Aws::Structure
|
7160
|
+
end
|
7161
|
+
|
7162
|
+
# You asked to describe a resource that doesn't exist. Check the
|
7163
|
+
# resource that you are requesting and try again.
|
7164
|
+
#
|
6761
7165
|
# @!attribute [rw] message
|
6762
7166
|
# @return [String]
|
6763
7167
|
#
|
@@ -6971,6 +7375,8 @@ module Aws::LexModelsV2
|
|
6971
7375
|
include Aws::Structure
|
6972
7376
|
end
|
6973
7377
|
|
7378
|
+
# You have reached a quota for your bot.
|
7379
|
+
#
|
6974
7380
|
# @!attribute [rw] message
|
6975
7381
|
# @return [String]
|
6976
7382
|
#
|
@@ -7950,6 +8356,8 @@ module Aws::LexModelsV2
|
|
7950
8356
|
include Aws::Structure
|
7951
8357
|
end
|
7952
8358
|
|
8359
|
+
# Your request rate is too high. Reduce the frequency of requests.
|
8360
|
+
#
|
7953
8361
|
# @!attribute [rw] retry_after_seconds
|
7954
8362
|
# @return [Integer]
|
7955
8363
|
#
|
@@ -9525,6 +9933,34 @@ module Aws::LexModelsV2
|
|
9525
9933
|
include Aws::Structure
|
9526
9934
|
end
|
9527
9935
|
|
9936
|
+
# Provides parameters for setting the time window and duration for
|
9937
|
+
# aggregating utterance data.
|
9938
|
+
#
|
9939
|
+
# @note When making an API call, you may pass UtteranceAggregationDuration
|
9940
|
+
# data as a hash:
|
9941
|
+
#
|
9942
|
+
# {
|
9943
|
+
# relative_aggregation_duration: { # required
|
9944
|
+
# time_dimension: "Hours", # required, accepts Hours, Days, Weeks
|
9945
|
+
# time_value: 1, # required
|
9946
|
+
# },
|
9947
|
+
# }
|
9948
|
+
#
|
9949
|
+
# @!attribute [rw] relative_aggregation_duration
|
9950
|
+
# The desired time window for aggregating utterances.
|
9951
|
+
# @return [Types::RelativeAggregationDuration]
|
9952
|
+
#
|
9953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceAggregationDuration AWS API Documentation
|
9954
|
+
#
|
9955
|
+
class UtteranceAggregationDuration < Struct.new(
|
9956
|
+
:relative_aggregation_duration)
|
9957
|
+
SENSITIVE = []
|
9958
|
+
include Aws::Structure
|
9959
|
+
end
|
9960
|
+
|
9961
|
+
# One of the input parameters in your request isn't valid. Check the
|
9962
|
+
# parameters and try your request again.
|
9963
|
+
#
|
9528
9964
|
# @!attribute [rw] message
|
9529
9965
|
# @return [String]
|
9530
9966
|
#
|
data/lib/aws-sdk-lexmodelsv2.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-lexmodelsv2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-09-
|
11
|
+
date: 2021-09-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|