# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::LexModelsV2 module Types # The active context used in the test execution. # # @!attribute [rw] name # The name of active context. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ActiveContext AWS API Documentation # class ActiveContext < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Provides settings that enable advanced recognition settings for slot # values. # # @!attribute [rw] audio_recognition_strategy # Enables using the slot values as a custom vocabulary for recognizing # user utterances. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AdvancedRecognitionSetting AWS API Documentation # class AdvancedRecognitionSetting < Struct.new( :audio_recognition_strategy) SENSITIVE = [] include Aws::Structure end # The information about the agent turn in a test set execution. # # @!attribute [rw] expected_agent_prompt # The expected agent prompt for the agent turn in a test set # execution. # @return [String] # # @!attribute [rw] actual_agent_prompt # The actual agent prompt for the agent turn in a test set execution. # @return [String] # # @!attribute [rw] error_details # Details about an error in an execution of a test set. # @return [Types::ExecutionErrorDetails] # # @!attribute [rw] actual_elicited_slot # The actual elicited slot for the agent turn in a test set execution. # @return [String] # # @!attribute [rw] actual_intent # The actual intent for the agent turn in a test set execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AgentTurnResult AWS API Documentation # class AgentTurnResult < Struct.new( :expected_agent_prompt, :actual_agent_prompt, :error_details, :actual_elicited_slot, :actual_intent) SENSITIVE = [] include Aws::Structure end # The specification of an agent turn. # # @!attribute [rw] agent_prompt # The agent prompt for the agent turn in a test set. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AgentTurnSpecification AWS API Documentation # class AgentTurnSpecification < Struct.new( :agent_prompt) SENSITIVE = [] include Aws::Structure end # Filters responses returned by the `ListAggregatedUtterances` # operation. # # @!attribute [rw] name # The name of the field to filter the utterance list. # @return [String] # # @!attribute [rw] values # The value to use for filtering the list of bots. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the # `ListAggregatedUtterances` operation should return only utterances # that equal the specified value. Specify `CO` when the # `ListAggregatedUtterances` operation should return utterances that # contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesFilter AWS API Documentation # class AggregatedUtterancesFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of utterances. # # @!attribute [rw] attribute # The utterance attribute to sort by. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the aggregated utterances in ascending or # descending order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesSortBy AWS API Documentation # class AggregatedUtterancesSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Provides summary information for aggregated utterances. The # `ListAggregatedUtterances` operations combines all instances of the # same utterance into a single aggregated summary. # # @!attribute [rw] utterance # The text of the utterance. If the utterance was used with the # `RecognizeUtterance` operation, the text is the transcription of the # audio utterance. # @return [String] # # @!attribute [rw] hit_count # The number of times that the utterance was detected by Amazon Lex # during the time period. When an utterance is detected, it activates # an intent or a slot. # @return [Integer] # # @!attribute [rw] missed_count # The number of times that the utterance was missed by Amazon Lex An # utterance is missed when it doesn't activate an intent or slot. # @return [Integer] # # @!attribute [rw] utterance_first_recorded_in_aggregation_duration # The date and time that the utterance was first recorded in the time # window for aggregation. An utterance may have been sent to Amazon # Lex before that time, but only utterances within the time window are # counted. # @return [Time] # # @!attribute [rw] utterance_last_recorded_in_aggregation_duration # The last date and time that an utterance was recorded in the time # window for aggregation. An utterance may be sent to Amazon Lex after # that time, but only utterances within the time window are counted. # @return [Time] # # @!attribute [rw] contains_data_from_deleted_resources # Aggregated utterance data may contain utterances from versions of # your bot that have since been deleted. When the aggregated contains # this kind of data, this field is set to true. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AggregatedUtterancesSummary AWS API Documentation # class AggregatedUtterancesSummary < Struct.new( :utterance, :hit_count, :missed_count, :utterance_first_recorded_in_aggregation_duration, :utterance_last_recorded_in_aggregation_duration, :contains_data_from_deleted_resources) SENSITIVE = [] include Aws::Structure end # Specifies the allowed input types. # # @!attribute [rw] allow_audio_input # Indicates whether audio input is allowed. # @return [Boolean] # # @!attribute [rw] allow_dtmf_input # Indicates whether DTMF input is allowed. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AllowedInputTypes AWS API Documentation # class AllowedInputTypes < Struct.new( :allow_audio_input, :allow_dtmf_input) SENSITIVE = [] include Aws::Structure end # Contains the time metric, interval, and method by which to bin the # analytics data. # # @!attribute [rw] name # Specifies the time metric by which to bin the analytics data. # @return [String] # # @!attribute [rw] interval # Specifies the interval of time by which to bin the analytics data. # @return [String] # # @!attribute [rw] order # Specifies whether to bin the analytics data in ascending or # descending order. If this field is left blank, the default order is # by the key of the bin in descending order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsBinBySpecification AWS API Documentation # class AnalyticsBinBySpecification < Struct.new( :name, :interval, :order) SENSITIVE = [] include Aws::Structure end # An object containing the criterion by which to bin the results and the # value that defines that bin. # # @!attribute [rw] name # The criterion by which to bin the results. # @return [String] # # @!attribute [rw] value # The value of the criterion that defines the bin. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsBinKey AWS API Documentation # class AnalyticsBinKey < Struct.new( :name, :value) SENSITIVE = [] include Aws::Structure end # Contains fields describing a condition by which to filter the intents. # The expression may be understood as `name` `operator` `values`. For # example: # # * `IntentName CO Book` – The intent name contains the string "Book." # # * `BotVersion EQ 2` – The bot version is equal to two. # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentName` – `EQ`, `CO`. # # * `IntentEndState` – `EQ`, `CO`. # # @!attribute [rw] name # The category by which to filter the intents. The descriptions for # each option are as follows: # # * `BotAlias` – The name of the bot alias. # # * `BotVersion` – The version of the bot. # # * `LocaleId` – The locale of the bot. # # * `Modality` – The modality of the session with the bot (audio, # DTMF, or text). # # * `Channel` – The channel that the bot is integrated with. # # * `SessionId` – The identifier of the session with the bot. # # * `OriginatingRequestId` – The identifier of the first request in a # session. # # * `IntentName` – The name of the intent. # # * `IntentEndState` – The final state of the intent. # @return [String] # # @!attribute [rw] operator # The operation by which to filter the category. The following # operations are possible: # # * `CO` – Contains # # * `EQ` – Equals # # * `GT` – Greater than # # * `LT` – Less than # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentName` – `EQ`, `CO`. # # * `IntentEndState` – `EQ`, `CO`. # @return [String] # # @!attribute [rw] values # An array containing the values of the category by which to apply the # operator to filter the results. You can provide multiple values if # the operator is `EQ` or `CO`. If you provide multiple values, you # filter for results that equal/contain any of the values. For # example, if the `name`, `operator`, and `values` fields are # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for # results where the modality was either `Speech` or `Text`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentFilter AWS API Documentation # class AnalyticsIntentFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # Contains the category by which the intent analytics were grouped and a # member of that category. # # @!attribute [rw] name # A category by which the intent analytics were grouped. # @return [String] # # @!attribute [rw] value # A member of the category by which the intent analytics were grouped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentGroupByKey AWS API Documentation # class AnalyticsIntentGroupByKey < Struct.new( :name, :value) SENSITIVE = [] include Aws::Structure end # Contains the category by which to group the intents. # # @!attribute [rw] name # Specifies whether to group the intent stages by their name or their # end state. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentGroupBySpecification AWS API Documentation # class AnalyticsIntentGroupBySpecification < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Contains the metric and the summary statistic you want to calculate, # and the order in which to sort the results, for the intents in the # bot. # # @!attribute [rw] name # The metric for which you want to get intent summary statistics. # # * `Count` – The number of times the intent was invoked. # # * `Success` – The number of times the intent succeeded. # # * `Failure` – The number of times the intent failed. # # * `Switched` – The number of times there was a switch to a different # intent. # # * `Dropped` – The number of times the user dropped the intent. # @return [String] # # @!attribute [rw] statistic # The summary statistic to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of intents in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentMetric AWS API Documentation # class AnalyticsIntentMetric < Struct.new( :name, :statistic, :order) SENSITIVE = [] include Aws::Structure end # An object containing the results for the intent metric you requested. # # @!attribute [rw] name # The metric that you requested. See [Key definitions][1] for more # details about these metrics. # # * `Count` – The number of times the intent was invoked. # # * `Success` – The number of times the intent succeeded. # # * `Failure` – The number of times the intent failed. # # * `Switched` – The number of times there was a switch to a different # intent. # # * `Dropped` – The number of times the user dropped the intent. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html # @return [String] # # @!attribute [rw] statistic # The statistic that you requested to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of intents in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] value # The value of the summary statistic for the metric that you # requested. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentMetricResult AWS API Documentation # class AnalyticsIntentMetricResult < Struct.new( :name, :statistic, :value) SENSITIVE = [] include Aws::Structure end # An object containing information about the requested path. # # @!attribute [rw] intent_name # The name of the intent at the end of the requested path. # @return [String] # # @!attribute [rw] intent_path # The path. # @return [String] # # @!attribute [rw] intent_count # The total number of sessions that follow the given path to the given # intent. # @return [Integer] # # @!attribute [rw] intent_level # The number of intents up to and including the requested path. # @return [Integer] # # @!attribute [rw] node_type # Specifies whether the node is the end of a path (`Exit`) or not # (`Inner`). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentNodeSummary AWS API Documentation # class AnalyticsIntentNodeSummary < Struct.new( :intent_name, :intent_path, :intent_count, :intent_level, :node_type) SENSITIVE = [] include Aws::Structure end # An object containing the results for the intent metrics you requested # and the bin and/or group(s) they refer to, if applicable. # # @!attribute [rw] bin_keys # A list of objects containing the criteria you requested for binning # results and the values of the bins. # @return [Array] # # @!attribute [rw] group_by_keys # A list of objects containing the criteria you requested for grouping # results and the values of the groups. # @return [Array] # # @!attribute [rw] metrics_results # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentResult AWS API Documentation # class AnalyticsIntentResult < Struct.new( :bin_keys, :group_by_keys, :metrics_results) SENSITIVE = [] include Aws::Structure end # Contains fields describing a condition by which to filter the intent # stages. The expression may be understood as `name` `operator` # `values`. For example: # # * `IntentName CO Book` – The intent name contains the string "Book." # # * `BotVersion EQ 2` – The bot version is equal to two. # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentName` – `EQ`, `CO`. # # * `IntentStageName` – `EQ`, `CO`. # # @!attribute [rw] name # The category by which to filter the intent stages. The descriptions # for each option are as follows: # # * `BotAlias` – The name of the bot alias. # # * `BotVersion` – The version of the bot. # # * `LocaleId` – The locale of the bot. # # * `Modality` – The modality of the session with the bot (audio, # DTMF, or text). # # * `Channel` – The channel that the bot is integrated with. # # * `SessionId` – The identifier of the session with the bot. # # * `OriginatingRequestId` – The identifier of the first request in a # session. # # * `IntentName` – The name of the intent. # # * `IntentStageName` – The stage in the intent. # @return [String] # # @!attribute [rw] operator # The operation by which to filter the category. The following # operations are possible: # # * `CO` – Contains # # * `EQ` – Equals # # * `GT` – Greater than # # * `LT` – Less than # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentName` – `EQ`, `CO`. # # * `IntentStageName` – `EQ`, `CO`. # @return [String] # # @!attribute [rw] values # An array containing the values of the category by which to apply the # operator to filter the results. You can provide multiple values if # the operator is `EQ` or `CO`. If you provide multiple values, you # filter for results that equal/contain any of the values. For # example, if the `name`, `operator`, and `values` fields are # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for # results where the modality was either `Speech` or `Text`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageFilter AWS API Documentation # class AnalyticsIntentStageFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # Contains the category by which the intent stage analytics and the # values for that category were grouped. # # @!attribute [rw] name # A category by which the intent stage analytics were grouped. # @return [String] # # @!attribute [rw] value # A member of the category by which the intent stage analytics were # grouped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupByKey AWS API Documentation # class AnalyticsIntentStageGroupByKey < Struct.new( :name, :value) SENSITIVE = [] include Aws::Structure end # Contains the category by which to group the intent stages. # # @!attribute [rw] name # Specifies whether to group the intent stages by their name or the # intent to which the session was switched. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageGroupBySpecification AWS API Documentation # class AnalyticsIntentStageGroupBySpecification < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Contains the metric and the summary statistic you want to calculate, # and the order in which to sort the results, for the intent stages # across the user sessions with the bot. # # @!attribute [rw] name # The metric for which you want to get intent stage summary # statistics. See [Key definitions][1] for more details about these # metrics. # # * `Count` – The number of times the intent stage occurred. # # * `Success` – The number of times the intent stage succeeded. # # * `Failure` – The number of times the intent stage failed. # # * `Dropped` – The number of times the user dropped the intent stage. # # * `Retry` – The number of times the bot tried to elicit a response # from the user at this stage. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html # @return [String] # # @!attribute [rw] statistic # The summary statistic to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of intent stages # in the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order of the summary statistic (`value` in the response). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageMetric AWS API Documentation # class AnalyticsIntentStageMetric < Struct.new( :name, :statistic, :order) SENSITIVE = [] include Aws::Structure end # An object containing the results for an intent stage metric you # requested. # # @!attribute [rw] name # The metric that you requested. # # * `Count` – The number of times the intent stage occurred. # # * `Success` – The number of times the intent stage succeeded. # # * `Failure` – The number of times the intent stage failed. # # * `Dropped` – The number of times the user dropped the intent stage. # # * `Retry` – The number of times the bot tried to elicit a response # from the user at this stage. # @return [String] # # @!attribute [rw] statistic # The summary statistic that you requested to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of intent stages # in the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] value # The value of the summary statistic for the metric that you # requested. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageMetricResult AWS API Documentation # class AnalyticsIntentStageMetricResult < Struct.new( :name, :statistic, :value) SENSITIVE = [] include Aws::Structure end # An object containing the results for the intent stage metrics you # requested and the bin and/or group they refer to, if applicable. # # @!attribute [rw] bin_keys # A list of objects containing the criteria you requested for binning # results and the values of the bins. # @return [Array] # # @!attribute [rw] group_by_keys # A list of objects containing the criteria you requested for grouping # results and the values of the bins. # @return [Array] # # @!attribute [rw] metrics_results # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsIntentStageResult AWS API Documentation # class AnalyticsIntentStageResult < Struct.new( :bin_keys, :group_by_keys, :metrics_results) SENSITIVE = [] include Aws::Structure end # Contains fields describing a condition by which to filter the paths. # The expression may be understood as `name` `operator` `values`. For # example: # # * `LocaleId EQ en` – The locale is "en". # # * `BotVersion EQ 2` – The bot version is equal to two. # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # @!attribute [rw] name # The category by which to filter the intent paths. The descriptions # for each option are as follows: # # * `BotAlias` – The name of the bot alias. # # * `BotVersion` – The version of the bot. # # * `LocaleId` – The locale of the bot. # # * `Modality` – The modality of the session with the bot (audio, # DTMF, or text). # # * `Channel` – The channel that the bot is integrated with. # @return [String] # # @!attribute [rw] operator # The operation by which to filter the category. The following # operations are possible: # # * `CO` – Contains # # * `EQ` – Equals # # * `GT` – Greater than # # * `LT` – Less than # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # @return [String] # # @!attribute [rw] values # An array containing the values of the category by which to apply the # operator to filter the results. You can provide multiple values if # the operator is `EQ` or `CO`. If you provide multiple values, you # filter for results that equal/contain any of the values. For # example, if the `name`, `operator`, and `values` fields are # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for # results where the modality was either `Speech` or `Text`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsPathFilter AWS API Documentation # class AnalyticsPathFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # Contains fields describing a condition by which to filter the # sessions. The expression may be understood as `name` `operator` # `values`. For example: # # * `LocaleId EQ en` – The locale is "en". # # * `Duration GT 200` – The duration is greater than 200 seconds. # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `Duration` – `EQ`, `GT`, `LT`. # # * `conversationEndState` – `EQ`, `CO`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentPath` – `EQ`. # # @!attribute [rw] name # The category by which to filter the sessions. The descriptions for # each option are as follows: # # * `BotAlias` – The name of the bot alias. # # * `BotVersion` – The version of the bot. # # * `LocaleId` – The locale of the bot. # # * `Modality` – The modality of the session with the bot (audio, # DTMF, or text). # # * `Channel` – The channel that the bot is integrated with. # # * `Duration` – The duration of the session. # # * `conversationEndState` – The final state of the session. # # * `SessionId` – The identifier of the session with the bot. # # * `OriginatingRequestId` – The identifier of the first request in a # session. # # * `IntentPath` – The order of intents taken in a session. # @return [String] # # @!attribute [rw] operator # The operation by which to filter the category. The following # operations are possible: # # * `CO` – Contains # # * `EQ` – Equals # # * `GT` – Greater than # # * `LT` – Less than # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `Duration` – `EQ`, `GT`, `LT`. # # * `conversationEndState` – `EQ`, `CO`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `IntentPath` – `EQ`. # @return [String] # # @!attribute [rw] values # An array containing the values of the category by which to apply the # operator to filter the results. You can provide multiple values if # the operator is `EQ` or `CO`. If you provide multiple values, you # filter for results that equal/contain any of the values. For # example, if the `name`, `operator`, and `values` fields are # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for # results where the modality was either `Speech` or `Text`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionFilter AWS API Documentation # class AnalyticsSessionFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # Contains the category by which the session analytics were grouped and # a member of that category. # # @!attribute [rw] name # The category by which the session analytics were grouped. # @return [String] # # @!attribute [rw] value # A member of the category by which the session analytics were # grouped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionGroupByKey AWS API Documentation # class AnalyticsSessionGroupByKey < Struct.new( :name, :value) SENSITIVE = [] include Aws::Structure end # Contains the category by which to group the sessions. # # @!attribute [rw] name # Specifies whether to group the session by their end state or their # locale. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionGroupBySpecification AWS API Documentation # class AnalyticsSessionGroupBySpecification < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Contains the metric and the summary statistic you want to calculate, # and the order in which to sort the results, for the user sessions with # the bot. # # @!attribute [rw] name # The metric for which you want to get session summary statistics. # # * `Count` – The number of sessions. # # * `Success` – The number of sessions that succeeded. # # * `Failure` – The number of sessions that failed. # # * `Dropped` – The number of sessions that the user dropped. # # * `Duration` – The duration of sessions. # # * `TurnsPerSession` – The number of turns in the sessions. # # * `Concurrency` – The number of sessions occurring in the same # period of time. # @return [String] # # @!attribute [rw] statistic # The summary statistic to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of sessions in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionMetric AWS API Documentation # class AnalyticsSessionMetric < Struct.new( :name, :statistic, :order) SENSITIVE = [] include Aws::Structure end # An object containing the results for a session metric you requested. # # @!attribute [rw] name # The metric that you requested. # # * `Count` – The number of sessions. # # * `Success` – The number of sessions that succeeded. # # * `Failure` – The number of sessions that failed. # # * `Dropped` – The number of sessions that the user dropped. # # * `Duration` – The duration of sessions. # # * `TurnPersession` – The number of turns in the sessions. # # * `Concurrency` – The number of sessions occurring in the same # period of time. # @return [String] # # @!attribute [rw] statistic # The summary statistic that you requested to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of sessions in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] value # The value of the summary statistic for the metric that you # requested. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionMetricResult AWS API Documentation # class AnalyticsSessionMetricResult < Struct.new( :name, :statistic, :value) SENSITIVE = [] include Aws::Structure end # An object containing the results for the session metrics you requested # and the bin and/or group(s) they refer to, if applicable. # # @!attribute [rw] bin_keys # A list of objects containing the criteria you requested for binning # results and the values of the bins. # @return [Array] # # @!attribute [rw] group_by_keys # A list of objects containing the criteria you requested for grouping # results and the values of the bins. # @return [Array] # # @!attribute [rw] metrics_results # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsSessionResult AWS API Documentation # class AnalyticsSessionResult < Struct.new( :bin_keys, :group_by_keys, :metrics_results) SENSITIVE = [] include Aws::Structure end # An object that specifies the last used intent at the time of the # utterance as an attribute to return. # # @!attribute [rw] name # An attribute to return. The only available attribute is the intent # that the bot mapped the utterance to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceAttribute AWS API Documentation # class AnalyticsUtteranceAttribute < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # An object containing the intent that the bot mapped the utterance to. # # @!attribute [rw] last_used_intent # The intent that the bot mapped the utterance to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceAttributeResult AWS API Documentation # class AnalyticsUtteranceAttributeResult < Struct.new( :last_used_intent) SENSITIVE = [] include Aws::Structure end # Contains fields describing a condition by which to filter the # utterances. The expression may be understood as `name` `operator` # `values`. For example: # # * `LocaleId EQ Book` – The locale is the string "en". # # * `UtteranceText CO help` – The text of the utterance contains the # string "help". # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `UtteranceState` – `EQ`. # # * `UtteranceText` – `EQ`, `CO`. # # @!attribute [rw] name # The category by which to filter the utterances. The descriptions for # each option are as follows: # # * `BotAlias` – The name of the bot alias. # # * `BotVersion` – The version of the bot. # # * `LocaleId` – The locale of the bot. # # * `Modality` – The modality of the session with the bot (audio, # DTMF, or text). # # * `Channel` – The channel that the bot is integrated with. # # * `SessionId` – The identifier of the session with the bot. # # * `OriginatingRequestId` – The identifier of the first request in a # session. # # * `UtteranceState` – The state of the utterance. # # * `UtteranceText` – The text in the utterance. # @return [String] # # @!attribute [rw] operator # The operation by which to filter the category. The following # operations are possible: # # * `CO` – Contains # # * `EQ` – Equals # # * `GT` – Greater than # # * `LT` – Less than # # The operators that each filter supports are listed below: # # * `BotAlias` – `EQ`. # # * `BotVersion` – `EQ`. # # * `LocaleId` – `EQ`. # # * `Modality` – `EQ`. # # * `Channel` – `EQ`. # # * `SessionId` – `EQ`. # # * `OriginatingRequestId` – `EQ`. # # * `UtteranceState` – `EQ`. # # * `UtteranceText` – `EQ`, `CO`. # @return [String] # # @!attribute [rw] values # An array containing the values of the category by which to apply the # operator to filter the results. You can provide multiple values if # the operator is `EQ` or `CO`. If you provide multiple values, you # filter for results that equal/contain any of the values. For # example, if the `name`, `operator`, and `values` fields are # `Modality`, `EQ`, and `[Speech, Text]`, the operation filters for # results where the modality was either `Speech` or `Text`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceFilter AWS API Documentation # class AnalyticsUtteranceFilter < Struct.new( :name, :operator, :values) SENSITIVE = [] include Aws::Structure end # Contains the category by which the utterance analytics were grouped # and the values for that category. # # @!attribute [rw] name # The category by which the utterance analytics were grouped. # @return [String] # # @!attribute [rw] value # A member of the category by which the utterance analytics were # grouped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupByKey AWS API Documentation # class AnalyticsUtteranceGroupByKey < Struct.new( :name, :value) SENSITIVE = [] include Aws::Structure end # Contains the category by which to group the utterances. # # @!attribute [rw] name # Specifies whether to group the utterances by their text or their # state. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceGroupBySpecification AWS API Documentation # class AnalyticsUtteranceGroupBySpecification < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Contains the metric and the summary statistic you want to calculate, # and the order in which to sort the results, for the utterances across # the user sessions with the bot. # # @!attribute [rw] name # The metric for which you want to get utterance summary statistics. # # * `Count` – The number of utterances. # # * `Missed` – The number of utterances that Amazon Lex failed to # recognize. # # * `Detected` – The number of utterances that Amazon Lex managed to # detect. # # * `UtteranceTimestamp` – The date and time of the utterance. # @return [String] # # @!attribute [rw] statistic # The summary statistic to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of utterances in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceMetric AWS API Documentation # class AnalyticsUtteranceMetric < Struct.new( :name, :statistic, :order) SENSITIVE = [] include Aws::Structure end # An object containing the results for the utterance metric you # requested. # # @!attribute [rw] name # The metric that you requested. # # * `Count` – The number of utterances. # # * `Missed` – The number of utterances that Amazon Lex failed to # recognize. # # * `Detected` – The number of utterances that Amazon Lex managed to # detect. # # * `UtteranceTimestamp` – The date and time of the utterance. # @return [String] # # @!attribute [rw] statistic # The summary statistic that you requested to calculate. # # * `Sum` – The total count for the category you provide in `name`. # # * `Average` – The total count divided by the number of utterances in # the category you provide in `name`. # # * `Max` – The highest count in the category you provide in `name`. # @return [String] # # @!attribute [rw] value # The value of the summary statistic for the metric that you # requested. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceMetricResult AWS API Documentation # class AnalyticsUtteranceMetricResult < Struct.new( :name, :statistic, :value) SENSITIVE = [] include Aws::Structure end # An object containing the results for the utterance metrics you # requested and the bin and/or group(s) they refer to, if applicable. # # @!attribute [rw] bin_keys # A list of objects containing the criteria you requested for binning # results and the values of the bins. # @return [Array] # # @!attribute [rw] group_by_keys # A list of objects containing the criteria you requested for grouping # results and the values of the bins. # @return [Array] # # @!attribute [rw] metrics_results # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @!attribute [rw] attribute_results # A list of objects containing information about the last used intent # at the time of an utterance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AnalyticsUtteranceResult AWS API Documentation # class AnalyticsUtteranceResult < Struct.new( :bin_keys, :group_by_keys, :metrics_results, :attribute_results) SENSITIVE = [] include Aws::Structure end # The object containing information that associates the recommended # intent/slot type with a conversation. # # @!attribute [rw] transcript # The content of the transcript that meets the search filter criteria. # For the JSON format of the transcript, see [Output transcript # format][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AssociatedTranscript AWS API Documentation # class AssociatedTranscript < Struct.new( :transcript) SENSITIVE = [] include Aws::Structure end # Filters to search for the associated transcript. # # @!attribute [rw] name # The name of the field to use for filtering. The allowed names are # IntentId and SlotTypeId. # @return [String] # # @!attribute [rw] values # The values to use to filter the transcript. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AssociatedTranscriptFilter AWS API Documentation # class AssociatedTranscriptFilter < Struct.new( :name, :values) SENSITIVE = [] include Aws::Structure end # Specifies the audio and DTMF input specification. # # @!attribute [rw] start_timeout_ms # Time for which a bot waits before assuming that the customer isn't # going to speak or press a key. This timeout is shared between Audio # and DTMF inputs. # @return [Integer] # # @!attribute [rw] audio_specification # Specifies the settings on audio input. # @return [Types::AudioSpecification] # # @!attribute [rw] dtmf_specification # Specifies the settings on DTMF input. # @return [Types::DTMFSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AudioAndDTMFInputSpecification AWS API Documentation # class AudioAndDTMFInputSpecification < Struct.new( :start_timeout_ms, :audio_specification, :dtmf_specification) SENSITIVE = [] include Aws::Structure end # The location of audio log files collected when conversation logging is # enabled for a bot. # # @!attribute [rw] s3_bucket # The Amazon S3 bucket where the audio log files are stored. The IAM # role specified in the `roleArn` parameter of the [CreateBot][1] # operation must have permission to write to this bucket. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html # @return [Types::S3BucketLogDestination] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AudioLogDestination AWS API Documentation # class AudioLogDestination < Struct.new( :s3_bucket) SENSITIVE = [] include Aws::Structure end # Settings for logging audio of conversations between Amazon Lex and a # user. You specify whether to log audio and the Amazon S3 bucket where # the audio file is stored. # # @!attribute [rw] enabled # Determines whether audio logging in enabled for the bot. # @return [Boolean] # # @!attribute [rw] destination # The location of audio log files collected when conversation logging # is enabled for a bot. # @return [Types::AudioLogDestination] # # @!attribute [rw] selective_logging_enabled # The option to enable selective conversation log capture for audio. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AudioLogSetting AWS API Documentation # class AudioLogSetting < Struct.new( :enabled, :destination, :selective_logging_enabled) SENSITIVE = [] include Aws::Structure end # Specifies the audio input specifications. # # @!attribute [rw] max_length_ms # Time for how long Amazon Lex waits before speech input is truncated # and the speech is returned to application. # @return [Integer] # # @!attribute [rw] end_timeout_ms # Time for which a bot waits after the customer stops speaking to # assume the utterance is finished. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/AudioSpecification AWS API Documentation # class AudioSpecification < Struct.new( :max_length_ms, :end_timeout_ms) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] custom_vocabulary_item_list # A list of new custom vocabulary items. Each entry must contain a # phrase and can optionally contain a displayAs and/or a weight. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItemRequest AWS API Documentation # class BatchCreateCustomVocabularyItemRequest < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_item_list) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] errors # A list of custom vocabulary items that failed to create during the # operation. The reason for the error is contained within each error # object. # @return [Array] # # @!attribute [rw] resources # A list of custom vocabulary items that were successfully created # during the operation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchCreateCustomVocabularyItemResponse AWS API Documentation # class BatchCreateCustomVocabularyItemResponse < Struct.new( :bot_id, :bot_version, :locale_id, :errors, :resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] custom_vocabulary_item_list # A list of custom vocabulary items requested to be deleted. Each # entry must contain the unique custom vocabulary entry identifier. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItemRequest AWS API Documentation # class BatchDeleteCustomVocabularyItemRequest < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_item_list) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see Supported languages # (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). # @return [String] # # @!attribute [rw] errors # A list of custom vocabulary items that failed to delete during the # operation. The reason for the error is contained within each error # object. # @return [Array] # # @!attribute [rw] resources # A list of custom vocabulary items that were successfully deleted # during the operation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchDeleteCustomVocabularyItemResponse AWS API Documentation # class BatchDeleteCustomVocabularyItemResponse < Struct.new( :bot_id, :bot_version, :locale_id, :errors, :resources) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] custom_vocabulary_item_list # A list of custom vocabulary items with updated fields. Each entry # must contain a phrase and can optionally contain a displayAs and/or # a weight. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItemRequest AWS API Documentation # class BatchUpdateCustomVocabularyItemRequest < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_item_list) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] errors # A list of custom vocabulary items that failed to update during the # operation. The reason for the error is contained within each error # object. # @return [Array] # # @!attribute [rw] resources # A list of custom vocabulary items that were successfully updated # during the operation. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BatchUpdateCustomVocabularyItemResponse AWS API Documentation # class BatchUpdateCustomVocabularyItemResponse < Struct.new( :bot_id, :bot_version, :locale_id, :errors, :resources) SENSITIVE = [] include Aws::Structure end # The details on the Bedrock guardrail configuration. # # @!attribute [rw] identifier # The unique guardrail id for the Bedrock guardrail configuration. # @return [String] # # @!attribute [rw] version # The guardrail version for the Bedrock guardrail configuration. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BedrockGuardrailConfiguration AWS API Documentation # class BedrockGuardrailConfiguration < Struct.new( :identifier, :version) SENSITIVE = [] include Aws::Structure end # Contains details about the configuration of a Amazon Bedrock knowledge # base. # # @!attribute [rw] bedrock_knowledge_base_arn # The base ARN of the knowledge base used. # @return [String] # # @!attribute [rw] exact_response # Specifies whether to return an exact response, or to return an # answer generated by the model, using the fields you specify from the # database. # @return [Boolean] # # @!attribute [rw] exact_response_fields # Contains the names of the fields used for an exact response to the # user. # @return [Types::BedrockKnowledgeStoreExactResponseFields] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BedrockKnowledgeStoreConfiguration AWS API Documentation # class BedrockKnowledgeStoreConfiguration < Struct.new( :bedrock_knowledge_base_arn, :exact_response, :exact_response_fields) SENSITIVE = [] include Aws::Structure end # The exact response fields given by the Bedrock knowledge store. # # @!attribute [rw] answer_field # The answer field used for an exact response from Bedrock Knowledge # Store. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BedrockKnowledgeStoreExactResponseFields AWS API Documentation # class BedrockKnowledgeStoreExactResponseFields < Struct.new( :answer_field) SENSITIVE = [] include Aws::Structure end # Contains information about the Amazon Bedrock model used to interpret # the prompt used in descriptive bot building. # # @!attribute [rw] model_arn # The ARN of the foundation model used in descriptive bot building. # @return [String] # # @!attribute [rw] guardrail # The guardrail configuration in the Bedrock model specification # details. # @return [Types::BedrockGuardrailConfiguration] # # @!attribute [rw] trace_status # The Bedrock trace status in the Bedrock model specification details. # @return [String] # # @!attribute [rw] custom_prompt # The custom prompt used in the Bedrock model specification details. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BedrockModelSpecification AWS API Documentation # class BedrockModelSpecification < Struct.new( :model_arn, :guardrail, :trace_status, :custom_prompt) SENSITIVE = [] include Aws::Structure end # Provides a record of an event that affects a bot alias. For example, # when the version of a bot that the alias points to changes. # # @!attribute [rw] bot_version # The version of the bot that was used in the event. # @return [String] # # @!attribute [rw] start_date # The date and time that the event started. # @return [Time] # # @!attribute [rw] end_date # The date and time that the event ended. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasHistoryEvent AWS API Documentation # class BotAliasHistoryEvent < Struct.new( :bot_version, :start_date, :end_date) SENSITIVE = [] include Aws::Structure end # Specifies settings that are unique to a locale. For example, you can # use different Lambda function depending on the bot's locale. # # @!attribute [rw] enabled # Determines whether the locale is enabled for the bot. If the value # is `false`, the locale isn't available for use. # @return [Boolean] # # @!attribute [rw] code_hook_specification # Specifies the Lambda function that should be used in the locale. # @return [Types::CodeHookSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasLocaleSettings AWS API Documentation # class BotAliasLocaleSettings < Struct.new( :enabled, :code_hook_specification) SENSITIVE = [] include Aws::Structure end # Contains information about all the aliases replication statuses # applicable for global resiliency. # # @!attribute [rw] bot_alias_id # The bot alias ID for all the alias bot replications. # @return [String] # # @!attribute [rw] bot_alias_replication_status # The replication statuses for all the alias bot replications. # @return [String] # # @!attribute [rw] bot_version # The bot version for all the alias bot replications. # @return [String] # # @!attribute [rw] creation_date_time # The creation time and date for all the alias bot replications. # @return [Time] # # @!attribute [rw] last_updated_date_time # The last time and date updated for all the alias bot replications. # @return [Time] # # @!attribute [rw] failure_reasons # The reasons for failure for the aliases bot replications. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasReplicaSummary AWS API Documentation # class BotAliasReplicaSummary < Struct.new( :bot_alias_id, :bot_alias_replication_status, :bot_version, :creation_date_time, :last_updated_date_time, :failure_reasons) SENSITIVE = [] include Aws::Structure end # Summary information about bot aliases returned from the # [ListBotAliases][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html # # @!attribute [rw] bot_alias_id # The unique identifier assigned to the bot alias. You can use this ID # to get detailed information about the alias using the # [DescribeBotAlias][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html # @return [String] # # @!attribute [rw] bot_alias_name # The name of the bot alias. # @return [String] # # @!attribute [rw] description # The description of the bot alias. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that the bot alias references. # @return [String] # # @!attribute [rw] bot_alias_status # The current state of the bot alias. If the status is `Available`, # the alias is ready for use. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot alias was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot alias was last # updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasSummary AWS API Documentation # class BotAliasSummary < Struct.new( :bot_alias_id, :bot_alias_name, :description, :bot_version, :bot_alias_status, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # The target Amazon S3 location for the test set execution using a bot # alias. # # @!attribute [rw] bot_id # The bot Id of the bot alias used in the test set execution. # @return [String] # # @!attribute [rw] bot_alias_id # The bot alias Id of the bot alias used in the test set execution. # @return [String] # # @!attribute [rw] locale_id # The locale Id of the bot alias used in the test set execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotAliasTestExecutionTarget AWS API Documentation # class BotAliasTestExecutionTarget < Struct.new( :bot_id, :bot_alias_id, :locale_id) SENSITIVE = [] include Aws::Structure end # Provides the identity of a the bot that was exported. # # @!attribute [rw] bot_id # The identifier of the bot assigned by Amazon Lex. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that was exported. This will be either # `DRAFT` or the version number. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotExportSpecification AWS API Documentation # class BotExportSpecification < Struct.new( :bot_id, :bot_version) SENSITIVE = [] include Aws::Structure end # Filters the responses returned by the `ListBots` operation. # # @!attribute [rw] name # The name of the field to filter the list of bots. # @return [String] # # @!attribute [rw] values # The value to use for filtering the list of bots. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the `ListBots` # operation should return only aliases that equal the specified value. # Specify `CO` when the `ListBots` operation should return aliases # that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotFilter AWS API Documentation # class BotFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Provides the bot parameters required for importing a bot. # # @!attribute [rw] bot_name # The name that Amazon Lex should use for the bot. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the IAM role used to build and run # the bot. # @return [String] # # @!attribute [rw] data_privacy # By default, data stored by Amazon Lex is encrypted. The # `DataPrivacy` structure provides settings that determine how Amazon # Lex handles special cases of securing the data for your bot. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The time, in seconds, that Amazon Lex should keep information about # a user's conversation with the bot. # # A user interaction remains active for the amount of time specified. # If no conversation occurs during this time, the session expires and # Amazon Lex deletes any data provided before the timeout. # # You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. # @return [Integer] # # @!attribute [rw] bot_tags # A list of tags to add to the bot. You can only add tags when you # import a bot. You can't use the `UpdateBot` operation to update # tags. To update tags, use the `TagResource` operation. # @return [Hash] # # @!attribute [rw] test_bot_alias_tags # A list of tags to add to the test alias for a bot. You can only add # tags when you import a bot. You can't use the `UpdateAlias` # operation to update tags. To update tags on the test alias, use the # `TagResource` operation. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotImportSpecification AWS API Documentation # class BotImportSpecification < Struct.new( :bot_name, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_tags, :test_bot_alias_tags) SENSITIVE = [] include Aws::Structure end # Provides the bot locale parameters required for exporting a bot # locale. # # @!attribute [rw] bot_id # The identifier of the bot to create the locale for. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to export. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale to export. The string must # match one of the locales in the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleExportSpecification AWS API Documentation # class BotLocaleExportSpecification < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # Filters responses returned by the `ListBotLocales` operation. # # @!attribute [rw] name # The name of the field to filter the list of bots. # @return [String] # # @!attribute [rw] values # The value to use for filtering the list of bots. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the # `ListBotLocales` operation should return only aliases that equal the # specified value. Specify `CO` when the `ListBotLocales` operation # should return aliases that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleFilter AWS API Documentation # class BotLocaleFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Provides information about an event that occurred affecting the bot # locale. # # @!attribute [rw] event # A description of the event that occurred. # @return [String] # # @!attribute [rw] event_date # A timestamp of the date and time that the event occurred. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleHistoryEvent AWS API Documentation # class BotLocaleHistoryEvent < Struct.new( :event, :event_date) SENSITIVE = [] include Aws::Structure end # Provides the bot locale parameters required for importing a bot # locale. # # @!attribute [rw] bot_id # The identifier of the bot to import the locale to. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to import the locale to. This can only be the # `DRAFT` version of the bot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the bot will be used # in. The string must match one of the supported locales. All of the # intents, slot types, and slots used in the bot must have the same # locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # Determines the threshold where Amazon Lex will insert the # `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when # returning alternative intents. `AMAZON.FallbackIntent` and # `AMAZON.KendraSearchIntent` are only inserted if they are configured # for the bot. # # For example, suppose a bot is configured with the confidence # threshold of 0.80 and the `AMAZON.FallbackIntent`. Amazon Lex # returns three alternative intents with the following confidence # scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response # from the `PostText` operation would be: # # * `AMAZON.FallbackIntent` # # * `IntentA` # # * `IntentB` # # * `IntentC` # @return [Float] # # @!attribute [rw] voice_settings # Defines settings for using an Amazon Polly voice to communicate with # a user. # # Valid values include: # # * `standard` # # * `neural` # # * `long-form` # # * `generative` # @return [Types::VoiceSettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleImportSpecification AWS API Documentation # class BotLocaleImportSpecification < Struct.new( :bot_id, :bot_version, :locale_id, :nlu_intent_confidence_threshold, :voice_settings) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of bot locales. # # @!attribute [rw] attribute # The bot locale attribute to sort by. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the bot locales in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleSortBy AWS API Documentation # class BotLocaleSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Summary information about bot locales returned by the # [ListBotLocales][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html # # @!attribute [rw] locale_id # The language and locale of the bot locale. # @return [String] # # @!attribute [rw] locale_name # The name of the bot locale. # @return [String] # # @!attribute [rw] description # The description of the bot locale. # @return [String] # # @!attribute [rw] bot_locale_status # The current status of the bot locale. When the status is `Built` the # locale is ready for use. # @return [String] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot locale was last # updated. # @return [Time] # # @!attribute [rw] last_build_submitted_date_time # A timestamp of the date and time that the bot locale was last built. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotLocaleSummary AWS API Documentation # class BotLocaleSummary < Struct.new( :locale_id, :locale_name, :description, :bot_locale_status, :last_updated_date_time, :last_build_submitted_date_time) SENSITIVE = [] include Aws::Structure end # A bot that is a member of a network of bots. # # @!attribute [rw] bot_member_id # The unique ID of a bot that is a member of this network of bots. # @return [String] # # @!attribute [rw] bot_member_name # The unique name of a bot that is a member of this network of bots. # @return [String] # # @!attribute [rw] bot_member_alias_id # The alias ID of a bot that is a member of this network of bots. # @return [String] # # @!attribute [rw] bot_member_alias_name # The alias name of a bot that is a member of this network of bots. # @return [String] # # @!attribute [rw] bot_member_version # The version of a bot that is a member of this network of bots. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotMember AWS API Documentation # class BotMember < Struct.new( :bot_member_id, :bot_member_name, :bot_member_alias_id, :bot_member_alias_name, :bot_member_version) SENSITIVE = [] include Aws::Structure end # A statistical summary of the bot recommendation results. # # @!attribute [rw] intents # Statistical information about about the intents associated with the # bot recommendation results. # @return [Types::IntentStatistics] # # @!attribute [rw] slot_types # Statistical information about the slot types associated with the bot # recommendation results. # @return [Types::SlotTypeStatistics] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationResultStatistics AWS API Documentation # class BotRecommendationResultStatistics < Struct.new( :intents, :slot_types) SENSITIVE = [] include Aws::Structure end # The object representing the URL of the bot definition, the URL of the # associated transcript, and a statistical summary of the bot # recommendation results. # # @!attribute [rw] bot_locale_export_url # The presigned URL link of the recommended bot definition. # @return [String] # # @!attribute [rw] associated_transcripts_url # The presigned url link of the associated transcript. # @return [String] # # @!attribute [rw] statistics # The statistical summary of the bot recommendation results. # @return [Types::BotRecommendationResultStatistics] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationResults AWS API Documentation # class BotRecommendationResults < Struct.new( :bot_locale_export_url, :associated_transcripts_url, :statistics) SENSITIVE = [] include Aws::Structure end # A summary of the bot recommendation. # # @!attribute [rw] bot_recommendation_status # The status of the bot recommendation. # # If the status is Failed, then the reasons for the failure are listed # in the failureReasons field. # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation to be updated. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot recommendation was # created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot recommendation was # last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotRecommendationSummary AWS API Documentation # class BotRecommendationSummary < Struct.new( :bot_recommendation_status, :bot_recommendation_id, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Contains summary information about all the replication statuses # applicable for global resiliency. # # @!attribute [rw] replica_region # The replica region used in the replication statuses summary. # @return [String] # # @!attribute [rw] creation_date_time # The creation time and date for the replicated bots. # @return [Time] # # @!attribute [rw] bot_replica_status # The operation status for the replicated bot applicable. # @return [String] # # @!attribute [rw] failure_reasons # The reasons for the failure for the replicated bot. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotReplicaSummary AWS API Documentation # class BotReplicaSummary < Struct.new( :replica_region, :creation_date_time, :bot_replica_status, :failure_reasons) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of bots. # # @!attribute [rw] attribute # The attribute to use to sort the list of bots. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can choose ascending or descending. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotSortBy AWS API Documentation # class BotSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Summary information about a bot returned by the [ListBots][1] # operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html # # @!attribute [rw] bot_id # The unique identifier assigned to the bot. Use this ID to get # detailed information about the bot with the [DescribeBot][1] # operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html # @return [String] # # @!attribute [rw] bot_name # The name of the bot. # @return [String] # # @!attribute [rw] description # The description of the bot. # @return [String] # # @!attribute [rw] bot_status # The current status of the bot. When the status is `Available` the # bot is ready for use. # @return [String] # # @!attribute [rw] latest_bot_version # The latest numerical version in use for the bot. # @return [String] # # @!attribute [rw] last_updated_date_time # The date and time that the bot was last updated. # @return [Time] # # @!attribute [rw] bot_type # The type of the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotSummary AWS API Documentation # class BotSummary < Struct.new( :bot_id, :bot_name, :description, :bot_status, :latest_bot_version, :last_updated_date_time, :bot_type) SENSITIVE = [] include Aws::Structure end # The version of a bot used for a bot locale. # # @!attribute [rw] source_bot_version # The version of a bot used for a bot locale. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionLocaleDetails AWS API Documentation # class BotVersionLocaleDetails < Struct.new( :source_bot_version) SENSITIVE = [] include Aws::Structure end # The sort category for the version replicated bots. # # @!attribute [rw] attribute # The attribute of the sort category for the version replicated bots. # @return [String] # # @!attribute [rw] order # The order of the sort category for the version replicated bots. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionReplicaSortBy AWS API Documentation # class BotVersionReplicaSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Contains summary information for all the version replication statuses # applicable for Global resiliency. # # @!attribute [rw] bot_version # The bot version for the summary information for all the version # replication statuses. # @return [String] # # @!attribute [rw] bot_version_replication_status # The version replication status for all the replicated bots. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time of the replication status for all the # replicated bots. # @return [Time] # # @!attribute [rw] failure_reasons # The reasons for replication failure for all the replicated bots. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionReplicaSummary AWS API Documentation # class BotVersionReplicaSummary < Struct.new( :bot_version, :bot_version_replication_status, :creation_date_time, :failure_reasons) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of bot versions. # # @!attribute [rw] attribute # The attribute to use to sort the list of versions. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can specify ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionSortBy AWS API Documentation # class BotVersionSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Summary information about a bot version returned by the # [ListBotVersions][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html # # @!attribute [rw] bot_name # The name of the bot associated with the version. # @return [String] # # @!attribute [rw] bot_version # The numeric version of the bot, or `DRAFT` to indicate that this is # the version of the bot that can be updated.. # @return [String] # # @!attribute [rw] description # The description of the version. # @return [String] # # @!attribute [rw] bot_status # The status of the bot. When the status is available, the version of # the bot is ready for use. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the version was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BotVersionSummary AWS API Documentation # class BotVersionSummary < Struct.new( :bot_name, :bot_version, :description, :bot_status, :creation_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to build. The identifier is returned in # the response from the [CreateBot][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html # @return [String] # # @!attribute [rw] bot_version # The version of the bot to build. This can only be the draft version # of the bot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the bot will be used # in. The string must match one of the supported locales. All of the # intents, slot types, and slots used in the bot must have the same # locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuildBotLocaleRequest AWS API Documentation # class BuildBotLocaleRequest < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the specified bot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that was built. This is only the draft # version of the bot. # @return [String] # # @!attribute [rw] locale_id # The language and locale specified of where the bot can be used. # @return [String] # # @!attribute [rw] bot_locale_status # The bot's build status. When the status is `ReadyExpressTesting` # you can test the bot using the utterances defined for the intents # and slot types. When the status is `Built`, the bot is ready for use # and can be tested using any utterance. # @return [String] # # @!attribute [rw] last_build_submitted_date_time # A timestamp indicating the date and time that the bot was last built # for this locale. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuildBotLocaleResponse AWS API Documentation # class BuildBotLocaleResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_locale_status, :last_build_submitted_date_time) SENSITIVE = [] include Aws::Structure end # Contains specifications about the Amazon Lex build time generative AI # capabilities from Amazon Bedrock that you can turn on for your bot. # # @!attribute [rw] descriptive_bot_builder # An object containing specifications for the descriptive bot building # feature. # @return [Types::DescriptiveBotBuilderSpecification] # # @!attribute [rw] sample_utterance_generation # Contains specifications for the sample utterance generation feature. # @return [Types::SampleUtteranceGenerationSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuildtimeSettings AWS API Documentation # class BuildtimeSettings < Struct.new( :descriptive_bot_builder, :sample_utterance_generation) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of built-in intents. # # @!attribute [rw] attribute # The attribute to use to sort the list of built-in intents. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can specify ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuiltInIntentSortBy AWS API Documentation # class BuiltInIntentSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Provides summary information about a built-in intent for the [ # ListBuiltInIntents ][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html # # @!attribute [rw] intent_signature # The signature of the built-in intent. Use this to specify the parent # intent of a derived intent. # @return [String] # # @!attribute [rw] description # The description of the intent. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuiltInIntentSummary AWS API Documentation # class BuiltInIntentSummary < Struct.new( :intent_signature, :description) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of built-in slot types. # # @!attribute [rw] attribute # The attribute to use to sort the list of built-in intents. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can choose ascending or descending. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuiltInSlotTypeSortBy AWS API Documentation # class BuiltInSlotTypeSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Provides summary information about a built-in slot type for the [ # ListBuiltInSlotTypes ][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html # # @!attribute [rw] slot_type_signature # The signature of the built-in slot type. Use this to specify the # parent slot type of a derived slot type. # @return [String] # # @!attribute [rw] description # The description of the built-in slot type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/BuiltInSlotTypeSummary AWS API Documentation # class BuiltInSlotTypeSummary < Struct.new( :slot_type_signature, :description) SENSITIVE = [] include Aws::Structure end # Describes a button to use on a response card used to gather slot # values from a user. # # @!attribute [rw] text # The text that appears on the button. Use this to tell the user what # value is returned when they choose this button. # @return [String] # # @!attribute [rw] value # The value returned to Amazon Lex when the user chooses this button. # This must be one of the slot values configured for the slot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Button AWS API Documentation # class Button < Struct.new( :text, :value) SENSITIVE = [] include Aws::Structure end # The Amazon CloudWatch Logs log group where the text and metadata logs # are delivered. The log group must exist before you enable logging. # # @!attribute [rw] cloud_watch_log_group_arn # The Amazon Resource Name (ARN) of the log group where text and # metadata logs are delivered. # @return [String] # # @!attribute [rw] log_prefix # The prefix of the log stream name within the log group that you # specified # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CloudWatchLogGroupLogDestination AWS API Documentation # class CloudWatchLogGroupLogDestination < Struct.new( :cloud_watch_log_group_arn, :log_prefix) SENSITIVE = [] include Aws::Structure end # Contains information about code hooks that Amazon Lex calls during a # conversation. # # @!attribute [rw] lambda_code_hook # Specifies a Lambda function that verifies requests to a bot or # fulfills the user's request to a bot. # @return [Types::LambdaCodeHook] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CodeHookSpecification AWS API Documentation # class CodeHookSpecification < Struct.new( :lambda_code_hook) SENSITIVE = [] include Aws::Structure end # A composite slot is a combination of two or more slots that capture # multiple pieces of information in a single user input. # # @!attribute [rw] sub_slots # Subslots in the composite slot. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CompositeSlotTypeSetting AWS API Documentation # class CompositeSlotTypeSetting < Struct.new( :sub_slots) SENSITIVE = [] include Aws::Structure end # Provides an expression that evaluates to true or false. # # @!attribute [rw] expression_string # The expression string that is evaluated. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Condition AWS API Documentation # class Condition < Struct.new( :expression_string) SENSITIVE = [] include Aws::Structure end # A set of actions that Amazon Lex should run if the condition is # matched. # # @!attribute [rw] name # The name of the branch. # @return [String] # # @!attribute [rw] condition # Contains the expression to evaluate. If the condition is true, the # branch's actions are taken. # @return [Types::Condition] # # @!attribute [rw] next_step # The next step in the conversation. # @return [Types::DialogState] # # @!attribute [rw] response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConditionalBranch AWS API Documentation # class ConditionalBranch < Struct.new( :name, :condition, :next_step, :response) SENSITIVE = [] include Aws::Structure end # Provides a list of conditional branches. Branches are evaluated in the # order that they are entered in the list. The first branch with a # condition that evaluates to true is executed. The last branch in the # list is the default branch. The default branch should not have any # condition expression. The default branch is executed if no other # branch has a matching condition. # # @!attribute [rw] active # Determines whether a conditional branch is active. When `active` is # false, the conditions are not evaluated. # @return [Boolean] # # @!attribute [rw] conditional_branches # A list of conditional branches. A conditional branch is made up of a # condition, a response and a next step. The response and next step # are executed when the condition is true. # @return [Array] # # @!attribute [rw] default_branch # The conditional branch that should be followed when the conditions # for other branches are not satisfied. A conditional branch is made # up of a condition, a response and a next step. # @return [Types::DefaultConditionalBranch] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConditionalSpecification AWS API Documentation # class ConditionalSpecification < Struct.new( :active, :conditional_branches, :default_branch) SENSITIVE = [] include Aws::Structure end # The action that you tried to perform couldn't be completed because # the resource is in a conflicting state. For example, deleting a bot # that is in the CREATING state. Try your request again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The item listing the evaluation of intent level success or failure. # # @!attribute [rw] intent_name # The intent name used in the evaluation of intent level success or # failure. # @return [String] # # @!attribute [rw] match_result # The number of times the specific intent is used in the evaluation of # intent level success or failure. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelIntentClassificationResultItem AWS API Documentation # class ConversationLevelIntentClassificationResultItem < Struct.new( :intent_name, :match_result) SENSITIVE = [] include Aws::Structure end # The conversation level details of the conversation used in the test # set. # # @!attribute [rw] end_to_end_result # The success or failure of the streaming of the conversation. # @return [String] # # @!attribute [rw] speech_transcription_result # The speech transcription success or failure details of the # conversation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelResultDetail AWS API Documentation # class ConversationLevelResultDetail < Struct.new( :end_to_end_result, :speech_transcription_result) SENSITIVE = [] include Aws::Structure end # The slots used for the slot resolution in the conversation. # # @!attribute [rw] intent_name # The intents used in the slots list for the slot resolution details. # @return [String] # # @!attribute [rw] slot_name # The slot name in the slots list for the slot resolution details. # @return [String] # # @!attribute [rw] match_result # The number of matching slots used in the slots listings for the slot # resolution evaluation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelSlotResolutionResultItem AWS API Documentation # class ConversationLevelSlotResolutionResultItem < Struct.new( :intent_name, :slot_name, :match_result) SENSITIVE = [] include Aws::Structure end # The test result evaluation item at the conversation level. # # @!attribute [rw] conversation_id # The conversation Id of the test result evaluation item. # @return [String] # # @!attribute [rw] end_to_end_result # The end-to-end success or failure of the test result evaluation # item. # @return [String] # # @!attribute [rw] speech_transcription_result # The speech transcription success or failure of the test result # evaluation item. # @return [String] # # @!attribute [rw] intent_classification_results # The intent classification of the test result evaluation item. # @return [Array] # # @!attribute [rw] slot_resolution_results # The slot success or failure of the test result evaluation item. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelTestResultItem AWS API Documentation # class ConversationLevelTestResultItem < Struct.new( :conversation_id, :end_to_end_result, :speech_transcription_result, :intent_classification_results, :slot_resolution_results) SENSITIVE = [] include Aws::Structure end # The test set results data at the conversation level. # # @!attribute [rw] items # The item list in the test set results data at the conversation # level. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelTestResults AWS API Documentation # class ConversationLevelTestResults < Struct.new( :items) SENSITIVE = [] include Aws::Structure end # The selection to filter the test set results data at the conversation # level. # # @!attribute [rw] end_to_end_result # The selection of matched or mismatched end-to-end status to filter # test set results data at the conversation level. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLevelTestResultsFilterBy AWS API Documentation # class ConversationLevelTestResultsFilterBy < Struct.new( :end_to_end_result) SENSITIVE = [] include Aws::Structure end # Configures conversation logging that saves audio, text, and metadata # for the conversations with your users. # # @!attribute [rw] text_log_settings # The Amazon CloudWatch Logs settings for logging text and metadata. # @return [Array] # # @!attribute [rw] audio_log_settings # The Amazon S3 settings for logging audio to an S3 bucket. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLogSettings AWS API Documentation # class ConversationLogSettings < Struct.new( :text_log_settings, :audio_log_settings) SENSITIVE = [] include Aws::Structure end # The data source that uses conversation logs. # # @!attribute [rw] bot_id # The bot Id from the conversation logs. # @return [String] # # @!attribute [rw] bot_alias_id # The bot alias Id from the conversation logs. # @return [String] # # @!attribute [rw] locale_id # The locale Id of the conversation log. # @return [String] # # @!attribute [rw] filter # The filter for the data source of the conversation log. # @return [Types::ConversationLogsDataSourceFilterBy] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLogsDataSource AWS API Documentation # class ConversationLogsDataSource < Struct.new( :bot_id, :bot_alias_id, :locale_id, :filter) SENSITIVE = [] include Aws::Structure end # The selected data source to filter the conversation log. # # @!attribute [rw] start_time # The start time for the conversation log. # @return [Time] # # @!attribute [rw] end_time # The end time for the conversation log. # @return [Time] # # @!attribute [rw] input_mode # The selection to filter by input mode for the conversation logs. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ConversationLogsDataSourceFilterBy AWS API Documentation # class ConversationLogsDataSourceFilterBy < Struct.new( :start_time, :end_time, :input_mode) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_name # The alias to create. The name must be unique for the bot. # @return [String] # # @!attribute [rw] description # A description of the alias. Use this description to help identify # the alias. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that this alias points to. You can use the # [UpdateBotAlias][1] operation to change the bot version associated # with the alias. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html # @return [String] # # @!attribute [rw] bot_alias_locale_settings # Maps configuration information to a specific locale. You can use # this parameter to specify a specific Lambda function to run # different functions in different locales. # @return [Hash] # # @!attribute [rw] conversation_log_settings # Specifies whether Amazon Lex logs text and audio for a conversation # with the bot. When you enable conversation logs, text logs store # text input, transcripts of audio input, and associated metadata in # Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3. # @return [Types::ConversationLogSettings] # # @!attribute [rw] sentiment_analysis_settings # Determines whether Amazon Lex will use Amazon Comprehend to detect # the sentiment of user utterances. # @return [Types::SentimentAnalysisSettings] # # @!attribute [rw] bot_id # The unique identifier of the bot that the alias applies to. # @return [String] # # @!attribute [rw] tags # A list of tags to add to the bot alias. You can only add tags when # you create an alias, you can't use the `UpdateBotAlias` operation # to update the tags on a bot alias. To update tags, use the # `TagResource` operation. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotAliasRequest AWS API Documentation # class CreateBotAliasRequest < Struct.new( :bot_alias_name, :description, :bot_version, :bot_alias_locale_settings, :conversation_log_settings, :sentiment_analysis_settings, :bot_id, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_id # The unique identifier of the bot alias. # @return [String] # # @!attribute [rw] bot_alias_name # The name specified for the bot alias. # @return [String] # # @!attribute [rw] description # The description specified for the bot alias. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with this alias. # @return [String] # # @!attribute [rw] bot_alias_locale_settings # Configuration information for a specific locale. # @return [Hash] # # @!attribute [rw] conversation_log_settings # The conversation log settings specified for the alias. # @return [Types::ConversationLogSettings] # # @!attribute [rw] sentiment_analysis_settings # Determines whether Amazon Lex will use Amazon Comprehend to detect # the sentiment of user utterances. # @return [Types::SentimentAnalysisSettings] # # @!attribute [rw] bot_alias_status # The current status of the alias. The alias is first put into the # `Creating` state. When the alias is ready to be used, it is put into # the `Available` state. You can use the `DescribeBotAlias` operation # to get the current state of an alias. # @return [String] # # @!attribute [rw] bot_id # The unique identifier of the bot that this alias applies to. # @return [String] # # @!attribute [rw] creation_date_time # A Unix timestamp indicating the date and time that the bot alias was # created. # @return [Time] # # @!attribute [rw] tags # A list of tags associated with the bot alias. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotAliasResponse AWS API Documentation # class CreateBotAliasResponse < Struct.new( :bot_alias_id, :bot_alias_name, :description, :bot_version, :bot_alias_locale_settings, :conversation_log_settings, :sentiment_analysis_settings, :bot_alias_status, :bot_id, :creation_date_time, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to create the locale for. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to create the locale for. This can only be # the draft version of the bot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the bot will be used # in. The string must match one of the supported locales. All of the # intents, slot types, and slots used in the bot must have the same # locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] description # A description of the bot locale. Use this to help identify the bot # locale in lists. # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # Determines the threshold where Amazon Lex will insert the # `AMAZON.FallbackIntent`, `AMAZON.KendraSearchIntent`, or both when # returning alternative intents. `AMAZON.FallbackIntent` and # `AMAZON.KendraSearchIntent` are only inserted if they are configured # for the bot. # # For example, suppose a bot is configured with the confidence # threshold of 0.80 and the `AMAZON.FallbackIntent`. Amazon Lex # returns three alternative intents with the following confidence # scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response # from the `RecognizeText` operation would be: # # * AMAZON.FallbackIntent # # * IntentA # # * IntentB # # * IntentC # @return [Float] # # @!attribute [rw] voice_settings # The Amazon Polly voice ID that Amazon Lex uses for voice interaction # with the user. # @return [Types::VoiceSettings] # # @!attribute [rw] generative_ai_settings # Contains specifications about the generative AI capabilities from # Amazon Bedrock that you can turn on for your bot. # @return [Types::GenerativeAISettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotLocaleRequest AWS API Documentation # class CreateBotLocaleRequest < Struct.new( :bot_id, :bot_version, :locale_id, :description, :nlu_intent_confidence_threshold, :voice_settings, :generative_ai_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The specified bot identifier. # @return [String] # # @!attribute [rw] bot_version # The specified bot version. # @return [String] # # @!attribute [rw] locale_name # The specified locale name. # @return [String] # # @!attribute [rw] locale_id # The specified locale identifier. # @return [String] # # @!attribute [rw] description # The specified description of the bot locale. # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # The specified confidence threshold for inserting the # `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents. # @return [Float] # # @!attribute [rw] voice_settings # The Amazon Polly voice ID that Amazon Lex uses for voice interaction # with the user. # @return [Types::VoiceSettings] # # @!attribute [rw] bot_locale_status # The status of the bot. # # When the status is `Creating` the bot locale is being configured. # When the status is `Building` Amazon Lex is building the bot for # testing and use. # # If the status of the bot is `ReadyExpressTesting`, you can test the # bot using the exact utterances specified in the bots' intents. When # the bot is ready for full testing or to run, the status is `Built`. # # If there was a problem with building the bot, the status is # `Failed`. If the bot was saved but not built, the status is # `NotBuilt`. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp specifying the date and time that the bot locale was # created. # @return [Time] # # @!attribute [rw] generative_ai_settings # Contains specifications about the generative AI capabilities from # Amazon Bedrock that you can turn on for your bot. # @return [Types::GenerativeAISettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotLocaleResponse AWS API Documentation # class CreateBotLocaleResponse < Struct.new( :bot_id, :bot_version, :locale_name, :locale_id, :description, :nlu_intent_confidence_threshold, :voice_settings, :bot_locale_status, :creation_date_time, :generative_ai_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The request for the unique bot ID of the source bot to be replicated # in the secondary region. # @return [String] # # @!attribute [rw] replica_region # The request for the secondary region that will be used in the # replication of the source bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotReplicaRequest AWS API Documentation # class CreateBotReplicaRequest < Struct.new( :bot_id, :replica_region) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique bot ID of the replicated bot generated. # @return [String] # # @!attribute [rw] replica_region # The region of the replicated bot generated. # @return [String] # # @!attribute [rw] source_region # The source region for the source bot used for the replicated bot # generated. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time of the replicated bot generated. # @return [Time] # # @!attribute [rw] bot_replica_status # The operational status of the replicated bot generated. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotReplicaResponse AWS API Documentation # class CreateBotReplicaResponse < Struct.new( :bot_id, :replica_region, :source_region, :creation_date_time, :bot_replica_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_name # The name of the bot. The bot name must be unique in the account that # creates the bot. # @return [String] # # @!attribute [rw] description # A description of the bot. It appears in lists to help you identify a # particular bot. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permission to # access the bot. # @return [String] # # @!attribute [rw] data_privacy # Provides information on additional privacy protections Amazon Lex # should use with the bot's data. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The time, in seconds, that Amazon Lex should keep information about # a user's conversation with the bot. # # A user interaction remains active for the amount of time specified. # If no conversation occurs during this time, the session expires and # Amazon Lex deletes any data provided before the timeout. # # You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. # @return [Integer] # # @!attribute [rw] bot_tags # A list of tags to add to the bot. You can only add tags when you # create a bot. You can't use the `UpdateBot` operation to update # tags. To update tags, use the `TagResource` operation. # @return [Hash] # # @!attribute [rw] test_bot_alias_tags # A list of tags to add to the test alias for a bot. You can only add # tags when you create a bot. You can't use the `UpdateAlias` # operation to update tags. To update tags on the test alias, use the # `TagResource` operation. # @return [Hash] # # @!attribute [rw] bot_type # The type of a bot to create. # @return [String] # # @!attribute [rw] bot_members # The list of bot members in a network to be created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotRequest AWS API Documentation # class CreateBotRequest < Struct.new( :bot_name, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_tags, :test_bot_alias_tags, :bot_type, :bot_members) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # A unique identifier for a particular bot. You use this to identify # the bot when you call other Amazon Lex API operations. # @return [String] # # @!attribute [rw] bot_name # The name specified for the bot. # @return [String] # # @!attribute [rw] description # The description specified for the bot. # @return [String] # # @!attribute [rw] role_arn # The IAM role specified for the bot. # @return [String] # # @!attribute [rw] data_privacy # The data privacy settings specified for the bot. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The session idle time specified for the bot. # @return [Integer] # # @!attribute [rw] bot_status # Shows the current status of the bot. The bot is first in the # `Creating` status. Once the bot is read for use, it changes to the # `Available` status. After the bot is created, you can use the # `DRAFT` version of the bot. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp indicating the date and time that the bot was created. # @return [Time] # # @!attribute [rw] bot_tags # A list of tags associated with the bot. # @return [Hash] # # @!attribute [rw] test_bot_alias_tags # A list of tags associated with the test alias for the bot. # @return [Hash] # # @!attribute [rw] bot_type # The type of a bot that was created. # @return [String] # # @!attribute [rw] bot_members # The list of bots in a network that was created. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotResponse AWS API Documentation # class CreateBotResponse < Struct.new( :bot_id, :bot_name, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_status, :creation_date_time, :bot_tags, :test_bot_alias_tags, :bot_type, :bot_members) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to create the version for. # @return [String] # # @!attribute [rw] description # A description of the version. Use the description to help identify # the version in lists. # @return [String] # # @!attribute [rw] bot_version_locale_specification # Specifies the locales that Amazon Lex adds to this version. You can # choose the `Draft` version or any other previously published version # for each locale. When you specify a source version, the locale data # is copied from the source version to the new version. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotVersionRequest AWS API Documentation # class CreateBotVersionRequest < Struct.new( :bot_id, :description, :bot_version_locale_specification) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The bot identifier specified in the request. # @return [String] # # @!attribute [rw] description # The description of the version specified in the request. # @return [String] # # @!attribute [rw] bot_version # The version number assigned to the version. # @return [String] # # @!attribute [rw] bot_version_locale_specification # The source versions used for each locale in the new version. # @return [Hash] # # @!attribute [rw] bot_status # When you send a request to create or update a bot, Amazon Lex sets # the status response element to `Creating`. After Amazon Lex builds # the bot, it sets status to `Available`. If Amazon Lex can't build # the bot, it sets status to `Failed`. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the version was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateBotVersionResponse AWS API Documentation # class CreateBotVersionResponse < Struct.new( :bot_id, :description, :bot_version, :bot_version_locale_specification, :bot_status, :creation_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_specification # Specifies the type of resource to export, either a bot or a bot # locale. You can only specify one type of resource to export. # @return [Types::ExportResourceSpecification] # # @!attribute [rw] file_format # The file format of the bot or bot locale definition files. # @return [String] # # @!attribute [rw] file_password # An password to use to encrypt the exported archive. Using a password # is optional, but you should encrypt the archive to protect the data # in transit between Amazon Lex and your local computer. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateExportRequest AWS API Documentation # class CreateExportRequest < Struct.new( :resource_specification, :file_format, :file_password) SENSITIVE = [:file_password] include Aws::Structure end # @!attribute [rw] export_id # An identifier for a specific request to create an export. # @return [String] # # @!attribute [rw] resource_specification # A description of the type of resource that was exported, either a # bot or a bot locale. # @return [Types::ExportResourceSpecification] # # @!attribute [rw] file_format # The file format used for the bot or bot locale definition files. # @return [String] # # @!attribute [rw] export_status # The status of the export. When the status is `Completed`, you can # use the [DescribeExport][1] operation to get the pre-signed S3 URL # link to your exported bot or bot locale. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the request to export a bot was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateExportResponse AWS API Documentation # class CreateExportResponse < Struct.new( :export_id, :resource_specification, :file_format, :export_status, :creation_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_name # The name of the intent. Intent names must be unique in the locale # that contains the intent and cannot match the name of any built-in # intent. # @return [String] # # @!attribute [rw] description # A description of the intent. Use the description to help identify # the intent in lists. # @return [String] # # @!attribute [rw] parent_intent_signature # A unique identifier for the built-in intent to base this intent on. # @return [String] # # @!attribute [rw] sample_utterances # An array of strings that a user might say to signal the intent. For # example, "I want a pizza", or "I want a \\\{PizzaSize\\} pizza". # # In an utterance, slot names are enclosed in curly braces ("\\\{", # "\\}") to indicate where they should be displayed in the utterance # shown to the user.. # @return [Array] # # @!attribute [rw] dialog_code_hook # Specifies that Amazon Lex invokes the alias Lambda function for each # user input. You can invoke this Lambda function to personalize user # interaction. # # For example, suppose that your bot determines that the user's name # is John. You Lambda function might retrieve John's information from # a backend database and prepopulate some of the values. For example, # if you find that John is gluten intolerant, you might set the # corresponding intent slot, `glutenIntolerant` to `true`. You might # find John's phone number and set the corresponding session # attribute. # @return [Types::DialogCodeHookSettings] # # @!attribute [rw] fulfillment_code_hook # Specifies that Amazon Lex invokes the alias Lambda function when the # intent is ready for fulfillment. You can invoke this function to # complete the bot's transaction with the user. # # For example, in a pizza ordering bot, the Lambda function can look # up the closest pizza restaurant to the customer's location and then # place an order on the customer's behalf. # @return [Types::FulfillmentCodeHookSettings] # # @!attribute [rw] intent_confirmation_setting # Provides prompts that Amazon Lex sends to the user to confirm the # completion of an intent. If the user answers "no," the settings # contain a statement that is sent to the user to end the intent. # @return [Types::IntentConfirmationSetting] # # @!attribute [rw] intent_closing_setting # Sets the response that Amazon Lex sends to the user when the intent # is closed. # @return [Types::IntentClosingSetting] # # @!attribute [rw] input_contexts # A list of contexts that must be active for this intent to be # considered by Amazon Lex. # # When an intent has an input context list, Amazon Lex only considers # using the intent in an interaction with the user when the specified # contexts are included in the active context list for the session. If # the contexts are not active, then Amazon Lex will not use the # intent. # # A context can be automatically activated using the `outputContexts` # property or it can be set at runtime. # # For example, if there are two intents with different input contexts # that respond to the same utterances, only the intent with the active # context will respond. # # An intent may have up to 5 input contexts. If an intent has multiple # input contexts, all of the contexts must be active to consider the # intent. # @return [Array] # # @!attribute [rw] output_contexts # A lists of contexts that the intent activates when it is fulfilled. # # You can use an output context to indicate the intents that Amazon # Lex should consider for the next turn of the conversation with a # customer. # # When you use the `outputContextsList` property, all of the contexts # specified in the list are activated when the intent is fulfilled. # You can set up to 10 output contexts. You can also set the number of # conversation turns that the context should be active, or the length # of time that the context should be active. # @return [Array] # # @!attribute [rw] kendra_configuration # Configuration information required to use the # `AMAZON.KendraSearchIntent` intent to connect to an Amazon Kendra # index. The `AMAZON.KendraSearchIntent` intent is called when Amazon # Lex can't determine another intent to invoke. # @return [Types::KendraConfiguration] # # @!attribute [rw] bot_id # The identifier of the bot associated with this intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with this intent. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this intent is used. # All of the bots, slot types, and slots used by the intent must have # the same locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] initial_response_setting # Configuration settings for the response that is sent to the user at # the beginning of a conversation, before eliciting slot values. # @return [Types::InitialResponseSetting] # # @!attribute [rw] qn_a_intent_configuration # Specifies the configuration of the built-in `Amazon.QnAIntent`. The # `AMAZON.QnAIntent` intent is called when Amazon Lex can't determine # another intent to invoke. If you specify this field, you can't # specify the `kendraConfiguration` field. # @return [Types::QnAIntentConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateIntentRequest AWS API Documentation # class CreateIntentRequest < Struct.new( :intent_name, :description, :parent_intent_signature, :sample_utterances, :dialog_code_hook, :fulfillment_code_hook, :intent_confirmation_setting, :intent_closing_setting, :input_contexts, :output_contexts, :kendra_configuration, :bot_id, :bot_version, :locale_id, :initial_response_setting, :qn_a_intent_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # A unique identifier for the intent. # @return [String] # # @!attribute [rw] intent_name # The name specified for the intent. # @return [String] # # @!attribute [rw] description # The description specified for the intent. # @return [String] # # @!attribute [rw] parent_intent_signature # The signature of the parent intent specified for the intent. # @return [String] # # @!attribute [rw] sample_utterances # The sample utterances specified for the intent. # @return [Array] # # @!attribute [rw] dialog_code_hook # The dialog Lambda function specified for the intent. # @return [Types::DialogCodeHookSettings] # # @!attribute [rw] fulfillment_code_hook # The fulfillment Lambda function specified for the intent. # @return [Types::FulfillmentCodeHookSettings] # # @!attribute [rw] intent_confirmation_setting # The confirmation setting specified for the intent. # @return [Types::IntentConfirmationSetting] # # @!attribute [rw] intent_closing_setting # The closing setting specified for the intent. # @return [Types::IntentClosingSetting] # # @!attribute [rw] input_contexts # The list of input contexts specified for the intent. # @return [Array] # # @!attribute [rw] output_contexts # The list of output contexts specified for the intent. # @return [Array] # # @!attribute [rw] kendra_configuration # Configuration for searching a Amazon Kendra index specified for the # intent. # @return [Types::KendraConfiguration] # # @!attribute [rw] bot_id # The identifier of the bot associated with the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the intent. # @return [String] # # @!attribute [rw] locale_id # The locale that the intent is specified to use. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the intent was created. # @return [Time] # # @!attribute [rw] initial_response_setting # Configuration settings for the response that is sent to the user at # the beginning of a conversation, before eliciting slot values. # @return [Types::InitialResponseSetting] # # @!attribute [rw] qn_a_intent_configuration # Details about the the configuration of the built-in # `Amazon.QnAIntent`. # @return [Types::QnAIntentConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateIntentResponse AWS API Documentation # class CreateIntentResponse < Struct.new( :intent_id, :intent_name, :description, :parent_intent_signature, :sample_utterances, :dialog_code_hook, :fulfillment_code_hook, :intent_confirmation_setting, :intent_closing_setting, :input_contexts, :output_contexts, :kendra_configuration, :bot_id, :bot_version, :locale_id, :creation_date_time, :initial_response_setting, :qn_a_intent_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] policy # A resource policy to add to the resource. The policy is a JSON # structure that contains one or more statements that define the # policy. The policy must follow the IAM syntax. For more information # about the contents of a JSON policy document, see [ IAM JSON policy # reference ][1]. # # If the policy isn't valid, Amazon Lex returns a validation # exception. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateResourcePolicyRequest AWS API Documentation # class CreateResourcePolicyRequest < Struct.new( :resource_arn, :policy) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy was attached to. # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateResourcePolicyResponse AWS API Documentation # class CreateResourcePolicyResponse < Struct.new( :resource_arn, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] statement_id # The name of the statement. The ID is the same as the `Sid` IAM # property. The statement name must be unique within the policy. For # more information, see [IAM JSON policy elements: Sid][1]. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html # @return [String] # # @!attribute [rw] effect # Determines whether the statement allows or denies access to the # resource. # @return [String] # # @!attribute [rw] principal # An IAM principal, such as an IAM user, IAM role, or Amazon Web # Services services that is allowed or denied access to a resource. # For more information, see [Amazon Web Services JSON policy elements: # Principal][1]. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html # @return [Array] # # @!attribute [rw] action # The Amazon Lex action that this policy either allows or denies. The # action must apply to the resource type of the specified ARN. For # more information, see [ Actions, resources, and condition keys for # Amazon Lex V2][1]. # # # # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html # @return [Array] # # @!attribute [rw] condition # Specifies a condition when the policy is in effect. If the principal # of the policy is a service principal, you must provide two condition # blocks, one with a SourceAccount global condition key and one with a # SourceArn global condition key. # # For more information, see [IAM JSON policy elements: Condition ][1]. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html # @return [Hash>] # # @!attribute [rw] expected_revision_id # The identifier of the revision of the policy to edit. If this # revision ID doesn't match the current revision ID, Amazon Lex # throws an exception. # # If you don't specify a revision, Amazon Lex overwrites the contents # of the policy with the new values. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateResourcePolicyStatementRequest AWS API Documentation # class CreateResourcePolicyStatementRequest < Struct.new( :resource_arn, :statement_id, :effect, :principal, :action, :condition, :expected_revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateResourcePolicyStatementResponse AWS API Documentation # class CreateResourcePolicyStatementResponse < Struct.new( :resource_arn, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_name # The name of the slot. Slot names must be unique within the bot that # contains the slot. # @return [String] # # @!attribute [rw] description # A description of the slot. Use this to help identify the slot in # lists. # @return [String] # # @!attribute [rw] slot_type_id # The unique identifier for the slot type associated with this slot. # The slot type determines the values that can be entered into the # slot. # @return [String] # # @!attribute [rw] value_elicitation_setting # Specifies prompts that Amazon Lex sends to the user to elicit a # response that provides the value for the slot. # @return [Types::SlotValueElicitationSetting] # # @!attribute [rw] obfuscation_setting # Determines how slot values are used in Amazon CloudWatch logs. If # the value of the `obfuscationSetting` parameter is # `DefaultObfuscation`, slot values are obfuscated in the log output. # If the value is `None`, the actual value is present in the log # output. # # The default is to obfuscate values in the CloudWatch logs. # @return [Types::ObfuscationSetting] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the slot will be used # in. The string must match one of the supported locales. All of the # bots, intents, slot types used by the slot must have the same # locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent that contains the slot. # @return [String] # # @!attribute [rw] multiple_values_setting # Indicates whether the slot returns multiple values in one response. # Multi-value slots are only available in the `en-US` locale. If you # set this value to `true` in any other locale, Amazon Lex throws a # `ValidationException`. # # If the `multipleValuesSetting` is not set, the default value is # `false`. # @return [Types::MultipleValuesSetting] # # @!attribute [rw] sub_slot_setting # Specifications for the constituent sub slots and the expression for # the composite slot. # @return [Types::SubSlotSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotRequest AWS API Documentation # class CreateSlotRequest < Struct.new( :slot_name, :description, :slot_type_id, :value_elicitation_setting, :obfuscation_setting, :bot_id, :bot_version, :locale_id, :intent_id, :multiple_values_setting, :sub_slot_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The unique identifier associated with the slot. Use this to identify # the slot when you update or delete it. # @return [String] # # @!attribute [rw] slot_name # The name specified for the slot. # @return [String] # # @!attribute [rw] description # The description associated with the slot. # @return [String] # # @!attribute [rw] slot_type_id # The unique identifier of the slot type associated with this slot. # @return [String] # # @!attribute [rw] value_elicitation_setting # The value elicitation settings specified for the slot. # @return [Types::SlotValueElicitationSetting] # # @!attribute [rw] obfuscation_setting # Indicates whether the slot is configured to obfuscate values in # Amazon CloudWatch logs. # @return [Types::ObfuscationSetting] # # @!attribute [rw] bot_id # The unique identifier of the bot associated with the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot. # @return [String] # # @!attribute [rw] locale_id # The language and local specified for the slot. # @return [String] # # @!attribute [rw] intent_id # The unique identifier of the intent associated with the slot. # @return [String] # # @!attribute [rw] creation_date_time # The timestamp of the date and time that the slot was created. # @return [Time] # # @!attribute [rw] multiple_values_setting # Indicates whether the slot returns multiple values in one response. # @return [Types::MultipleValuesSetting] # # @!attribute [rw] sub_slot_setting # Specifications for the constituent sub slots and the expression for # the composite slot. # @return [Types::SubSlotSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotResponse AWS API Documentation # class CreateSlotResponse < Struct.new( :slot_id, :slot_name, :description, :slot_type_id, :value_elicitation_setting, :obfuscation_setting, :bot_id, :bot_version, :locale_id, :intent_id, :creation_date_time, :multiple_values_setting, :sub_slot_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_name # The name for the slot. A slot type name must be unique within the # intent. # @return [String] # # @!attribute [rw] description # A description of the slot type. Use the description to help identify # the slot type in lists. # @return [String] # # @!attribute [rw] slot_type_values # A list of `SlotTypeValue` objects that defines the values that the # slot type can take. Each value can have a list of synonyms, # additional values that help train the machine learning model about # the values that it resolves for a slot. # @return [Array] # # @!attribute [rw] value_selection_setting # Determines the strategy that Amazon Lex uses to select a value from # the list of possible values. The field can be set to one of the # following values: # # * `ORIGINAL_VALUE` - Returns the value entered by the user, if the # user value is similar to the slot value. # # * `TOP_RESOLUTION` - If there is a resolution list for the slot, # return the first value in the resolution list. If there is no # resolution list, return null. # # If you don't specify the `valueSelectionSetting` parameter, the # default is `ORIGINAL_VALUE`. # @return [Types::SlotValueSelectionSetting] # # @!attribute [rw] parent_slot_type_signature # The built-in slot type used as a parent of this slot type. When you # define a parent slot type, the new slot type has the configuration # of the parent slot type. # # Only `AMAZON.AlphaNumeric` is supported. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with this slot type. # @return [String] # # @!attribute [rw] bot_version # The identifier of the bot version associated with this slot type. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the slot type will be # used in. The string must match one of the supported locales. All of # the bots, intents, and slots used by the slot type must have the # same locale. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] external_source_setting # Sets the type of external information used to create the slot type. # @return [Types::ExternalSourceSetting] # # @!attribute [rw] composite_slot_type_setting # Specifications for a composite slot type. # @return [Types::CompositeSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotTypeRequest AWS API Documentation # class CreateSlotTypeRequest < Struct.new( :slot_type_name, :description, :slot_type_values, :value_selection_setting, :parent_slot_type_signature, :bot_id, :bot_version, :locale_id, :external_source_setting, :composite_slot_type_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The unique identifier assigned to the slot type. Use this to # identify the slot type in the `UpdateSlotType` and `DeleteSlotType` # operations. # @return [String] # # @!attribute [rw] slot_type_name # The name specified for the slot type. # @return [String] # # @!attribute [rw] description # The description specified for the slot type. # @return [String] # # @!attribute [rw] slot_type_values # The list of values that the slot type can assume. # @return [Array] # # @!attribute [rw] value_selection_setting # The strategy that Amazon Lex uses to select a value from the list of # possible values. # @return [Types::SlotValueSelectionSetting] # # @!attribute [rw] parent_slot_type_signature # The signature of the base slot type specified for the slot type. # @return [String] # # @!attribute [rw] bot_id # The identifier for the bot associated with the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot type. # @return [String] # # @!attribute [rw] locale_id # The specified language and local specified for the slot type. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the slot type was created. # @return [Time] # # @!attribute [rw] external_source_setting # The type of external information used to create the slot type. # @return [Types::ExternalSourceSetting] # # @!attribute [rw] composite_slot_type_setting # Specifications for a composite slot type. # @return [Types::CompositeSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotTypeResponse AWS API Documentation # class CreateSlotTypeResponse < Struct.new( :slot_type_id, :slot_type_name, :description, :slot_type_values, :value_selection_setting, :parent_slot_type_signature, :bot_id, :bot_version, :locale_id, :creation_date_time, :external_source_setting, :composite_slot_type_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for the test set discrepancy report. # @return [String] # # @!attribute [rw] target # The target bot for the test set discrepancy report. # @return [Types::TestSetDiscrepancyReportResourceTarget] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReportRequest AWS API Documentation # class CreateTestSetDiscrepancyReportRequest < Struct.new( :test_set_id, :target) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_discrepancy_report_id # The unique identifier of the test set discrepancy report to # describe. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time for the test set discrepancy report. # @return [Time] # # @!attribute [rw] test_set_id # The test set Id for the test set discrepancy report. # @return [String] # # @!attribute [rw] target # The target bot for the test set discrepancy report. # @return [Types::TestSetDiscrepancyReportResourceTarget] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateTestSetDiscrepancyReportResponse AWS API Documentation # class CreateTestSetDiscrepancyReportResponse < Struct.new( :test_set_discrepancy_report_id, :creation_date_time, :test_set_id, :target) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateUploadUrlRequest AWS API Documentation # class CreateUploadUrlRequest < Aws::EmptyStructure; end # @!attribute [rw] import_id # An identifier for a unique import job. Use it when you call the # [StartImport][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html # @return [String] # # @!attribute [rw] upload_url # A pre-signed S3 write URL. Upload the zip archive file that contains # the definition of your bot or bot locale. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateUploadUrlResponse AWS API Documentation # class CreateUploadUrlResponse < Struct.new( :import_id, :upload_url) SENSITIVE = [] include Aws::Structure end # A custom response string that Amazon Lex sends to your application. # You define the content and structure the string. # # @!attribute [rw] value # The string that is sent to your application. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CustomPayload AWS API Documentation # class CustomPayload < Struct.new( :value) SENSITIVE = [] include Aws::Structure end # The unique entry identifier for the custom vocabulary items. # # @!attribute [rw] item_id # The unique item identifier for the custom vocabulary items. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CustomVocabularyEntryId AWS API Documentation # class CustomVocabularyEntryId < Struct.new( :item_id) SENSITIVE = [] include Aws::Structure end # Provides the parameters required for exporting a custom vocabulary. # # @!attribute [rw] bot_id # The identifier of the bot that contains the custom vocabulary to # export. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the custom vocabulary to # export. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot that contains the custom vocabulary to export. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CustomVocabularyExportSpecification AWS API Documentation # class CustomVocabularyExportSpecification < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # Provides the parameters required for importing a custom vocabulary. # # @!attribute [rw] bot_id # The identifier of the bot to import the custom vocabulary to. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to import the custom vocabulary to. # @return [String] # # @!attribute [rw] locale_id # The identifier of the local to import the custom vocabulary to. The # value must be `en_GB`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CustomVocabularyImportSpecification AWS API Documentation # class CustomVocabularyImportSpecification < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # The unique custom vocabulary item from the custom vocabulary list. # # @!attribute [rw] item_id # The unique item identifer for the custom vocabulary item from the # custom vocabulary list. # @return [String] # # @!attribute [rw] phrase # The unique phrase for the custom vocabulary item from the custom # vocabulary list. # @return [String] # # @!attribute [rw] weight # The weight assigned for the custom vocabulary item from the custom # vocabulary list. # @return [Integer] # # @!attribute [rw] display_as # The DisplayAs value for the custom vocabulary item from the custom # vocabulary list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CustomVocabularyItem AWS API Documentation # class CustomVocabularyItem < Struct.new( :item_id, :phrase, :weight, :display_as) SENSITIVE = [] include Aws::Structure end # Specifies the DTMF input specifications. # # @!attribute [rw] max_length # The maximum number of DTMF digits allowed in an utterance. # @return [Integer] # # @!attribute [rw] end_timeout_ms # How long the bot should wait after the last DTMF character input # before assuming that the input has concluded. # @return [Integer] # # @!attribute [rw] deletion_character # The DTMF character that clears the accumulated DTMF digits and # immediately ends the input. # @return [String] # # @!attribute [rw] end_character # The DTMF character that immediately ends input. If the user does not # press this character, the input ends after the end timeout. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DTMFSpecification AWS API Documentation # class DTMFSpecification < Struct.new( :max_length, :end_timeout_ms, :deletion_character, :end_character) SENSITIVE = [] include Aws::Structure end # By default, data stored by Amazon Lex is encrypted. The `DataPrivacy` # structure provides settings that determine how Amazon Lex handles # special cases of securing the data for your bot. # # @!attribute [rw] child_directed # For each Amazon Lex bot created with the Amazon Lex Model Building # Service, you must specify whether your use of Amazon Lex is related # to a website, program, or other application that is directed or # targeted, in whole or in part, to children under age 13 and subject # to the Children's Online Privacy Protection Act (COPPA) by # specifying `true` or `false` in the `childDirected` field. By # specifying `true` in the `childDirected` field, you confirm that # your use of Amazon Lex **is** related to a website, program, or # other application that is directed or targeted, in whole or in part, # to children under age 13 and subject to COPPA. By specifying `false` # in the `childDirected` field, you confirm that your use of Amazon # Lex **is not** related to a website, program, or other application # that is directed or targeted, in whole or in part, to children under # age 13 and subject to COPPA. You may not specify a default value for # the `childDirected` field that does not accurately reflect whether # your use of Amazon Lex is related to a website, program, or other # application that is directed or targeted, in whole or in part, to # children under age 13 and subject to COPPA. If your use of Amazon # Lex relates to a website, program, or other application that is # directed in whole or in part, to children under age 13, you must # obtain any required verifiable parental consent under COPPA. For # information regarding the use of Amazon Lex in connection with # websites, programs, or other applications that are directed or # targeted, in whole or in part, to children under age 13, see the # [Amazon Lex FAQ][1]. # # # # [1]: http://aws.amazon.com/lex/faqs#data-security # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DataPrivacy AWS API Documentation # class DataPrivacy < Struct.new( :child_directed) SENSITIVE = [] include Aws::Structure end # Contains details about the configuration of the knowledge store used # for the `AMAZON.QnAIntent`. You must have already created the # knowledge store and indexed the documents within it. # # @!attribute [rw] opensearch_configuration # Contains details about the configuration of the Amazon OpenSearch # Service database used for the `AMAZON.QnAIntent`. To create a # domain, follow the steps at [Creating and managing Amazon OpenSearch # Service domains][1]. # # # # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html # @return [Types::OpensearchConfiguration] # # @!attribute [rw] kendra_configuration # Contains details about the configuration of the Amazon Kendra index # used for the `AMAZON.QnAIntent`. To create a Amazon Kendra index, # follow the steps at [Creating an index][1]. # # # # [1]: https://docs.aws.amazon.com/kendra/latest/dg/create-index.html # @return [Types::QnAKendraConfiguration] # # @!attribute [rw] bedrock_knowledge_store_configuration # Contains details about the configuration of the Amazon Bedrock # knowledge base used for the `AMAZON.QnAIntent`. To set up a # knowledge base, follow the steps at [Building a knowledge base][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html # @return [Types::BedrockKnowledgeStoreConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DataSourceConfiguration AWS API Documentation # class DataSourceConfiguration < Struct.new( :opensearch_configuration, :kendra_configuration, :bedrock_knowledge_store_configuration) SENSITIVE = [] include Aws::Structure end # The object used for specifying the data range that the customer wants # Amazon Lex to read through in the input transcripts. # # @!attribute [rw] start_date_time # A timestamp indicating the start date for the date range filter. # @return [Time] # # @!attribute [rw] end_date_time # A timestamp indicating the end date for the date range filter. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DateRangeFilter AWS API Documentation # class DateRangeFilter < Struct.new( :start_date_time, :end_date_time) SENSITIVE = [] include Aws::Structure end # A set of actions that Amazon Lex should run if none of the other # conditions are met. # # @!attribute [rw] next_step # The next step in the conversation. # @return [Types::DialogState] # # @!attribute [rw] response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DefaultConditionalBranch AWS API Documentation # class DefaultConditionalBranch < Struct.new( :next_step, :response) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_id # The unique identifier of the bot alias to delete. # @return [String] # # @!attribute [rw] bot_id # The unique identifier of the bot associated with the alias to # delete. # @return [String] # # @!attribute [rw] skip_resource_in_use_check # By default, Amazon Lex checks if any other resource, such as a bot # network, is using the bot alias before it is deleted and throws a # `ResourceInUseException` exception if the alias is being used by # another resource. Set this parameter to `true` to skip this check # and remove the alias even if it is being used by another resource. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotAliasRequest AWS API Documentation # class DeleteBotAliasRequest < Struct.new( :bot_alias_id, :bot_id, :skip_resource_in_use_check) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_id # The unique identifier of the bot alias to delete. # @return [String] # # @!attribute [rw] bot_id # The unique identifier of the bot that contains the alias to delete. # @return [String] # # @!attribute [rw] bot_alias_status # The current status of the alias. The status is `Deleting` while the # alias is in the process of being deleted. Once the alias is deleted, # it will no longer appear in the list of aliases returned by the # `ListBotAliases` operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotAliasResponse AWS API Documentation # class DeleteBotAliasResponse < Struct.new( :bot_alias_id, :bot_id, :bot_alias_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the locale. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that will be deleted. The # string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotLocaleRequest AWS API Documentation # class DeleteBotLocaleRequest < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contained the deleted locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contained the deleted locale. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the deleted locale. # @return [String] # # @!attribute [rw] bot_locale_status # The status of deleting the bot locale. The locale first enters the # `Deleting` status. Once the locale is deleted it no longer appears # in the list of locales for the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotLocaleResponse AWS API Documentation # class DeleteBotLocaleResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_locale_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique ID of the replicated bot to be deleted from the secondary # region # @return [String] # # @!attribute [rw] replica_region # The secondary region of the replicated bot that will be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotReplicaRequest AWS API Documentation # class DeleteBotReplicaRequest < Struct.new( :bot_id, :replica_region) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique bot ID of the replicated bot generated. # @return [String] # # @!attribute [rw] replica_region # The region of the replicated bot generated. # @return [String] # # @!attribute [rw] bot_replica_status # The operational status of the replicated bot generated. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotReplicaResponse AWS API Documentation # class DeleteBotReplicaResponse < Struct.new( :bot_id, :replica_region, :bot_replica_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to delete. # @return [String] # # @!attribute [rw] skip_resource_in_use_check # By default, Amazon Lex checks if any other resource, such as an # alias or bot network, is using the bot version before it is deleted # and throws a `ResourceInUseException` exception if the bot is being # used by another resource. Set this parameter to `true` to skip this # check and remove the bot even if it is being used by another # resource. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotRequest AWS API Documentation # class DeleteBotRequest < Struct.new( :bot_id, :skip_resource_in_use_check) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that Amazon Lex is deleting. # @return [String] # # @!attribute [rw] bot_status # The current status of the bot. The status is `Deleting` while the # bot and its associated resources are being deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotResponse AWS API Documentation # class DeleteBotResponse < Struct.new( :bot_id, :bot_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the version. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to delete. # @return [String] # # @!attribute [rw] skip_resource_in_use_check # By default, Amazon Lex checks if any other resource, such as an # alias or bot network, is using the bot version before it is deleted # and throws a `ResourceInUseException` exception if the version is # being used by another resource. Set this parameter to `true` to skip # this check and remove the version even if it is being used by # another resource. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotVersionRequest AWS API Documentation # class DeleteBotVersionRequest < Struct.new( :bot_id, :bot_version, :skip_resource_in_use_check) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that is being deleted. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that is being deleted. # @return [String] # # @!attribute [rw] bot_status # The current status of the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteBotVersionResponse AWS API Documentation # class DeleteBotVersionResponse < Struct.new( :bot_id, :bot_version, :bot_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot to remove the custom vocabulary # from. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to remove the custom vocabulary from. # @return [String] # # @!attribute [rw] locale_id # The locale identifier for the locale that contains the custom # vocabulary to remove. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteCustomVocabularyRequest AWS API Documentation # class DeleteCustomVocabularyRequest < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that the custom vocabulary was removed # from. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that the custom vocabulary was removed from. # @return [String] # # @!attribute [rw] locale_id # The locale identifier for the locale that the custom vocabulary was # removed from. # @return [String] # # @!attribute [rw] custom_vocabulary_status # The status of removing the custom vocabulary. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteCustomVocabularyResponse AWS API Documentation # class DeleteCustomVocabularyResponse < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier of the export to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteExportRequest AWS API Documentation # class DeleteExportRequest < Struct.new( :export_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier of the deleted export. # @return [String] # # @!attribute [rw] export_status # The current status of the deletion. When the deletion is complete, # the export will no longer be returned by the [ListExports][1] # operation and calls to the [ DescribeExport][2] operation with the # export identifier will fail. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html # [2]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteExportResponse AWS API Documentation # class DeleteExportResponse < Struct.new( :export_id, :export_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_id # The unique identifier of the import to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteImportRequest AWS API Documentation # class DeleteImportRequest < Struct.new( :import_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_id # The unique identifier of the deleted import. # @return [String] # # @!attribute [rw] import_status # The current status of the deletion. When the deletion is complete, # the import will no longer be returned by the [ListImports][1] # operation and calls to the [DescribeImport][2] operation with the # import identifier will fail. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html # [2]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteImportResponse AWS API Documentation # class DeleteImportResponse < Struct.new( :import_id, :import_status) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The unique identifier of the intent to delete. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the intent. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where the bot will be # deleted. The string must match one of the supported locales. For # more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteIntentRequest AWS API Documentation # class DeleteIntentRequest < Struct.new( :intent_id, :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that has the # resource policy attached. # @return [String] # # @!attribute [rw] expected_revision_id # The identifier of the revision to edit. If this ID doesn't match # the current revision number, Amazon Lex returns an exception # # If you don't specify a revision ID, Amazon Lex will delete the # current policy. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteResourcePolicyRequest AWS API Documentation # class DeleteResourcePolicyRequest < Struct.new( :resource_arn, :expected_revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy was deleted from. # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteResourcePolicyResponse AWS API Documentation # class DeleteResourcePolicyResponse < Struct.new( :resource_arn, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] statement_id # The name of the statement (SID) to delete from the policy. # @return [String] # # @!attribute [rw] expected_revision_id # The identifier of the revision of the policy to delete the statement # from. If this revision ID doesn't match the current revision ID, # Amazon Lex throws an exception. # # If you don't specify a revision, Amazon Lex removes the current # contents of the statement. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteResourcePolicyStatementRequest AWS API Documentation # class DeleteResourcePolicyStatementRequest < Struct.new( :resource_arn, :statement_id, :expected_revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy statement was removed from. # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteResourcePolicyStatementResponse AWS API Documentation # class DeleteResourcePolicyStatementResponse < Struct.new( :resource_arn, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The identifier of the slot to delete. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot to delete. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot to delete. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the slot will be # deleted from. The string must match one of the supported locales. # For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent associated with the slot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteSlotRequest AWS API Documentation # class DeleteSlotRequest < Struct.new( :slot_id, :bot_id, :bot_version, :locale_id, :intent_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The identifier of the slot type to delete. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot type. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the slot type will be # deleted from. The string must match one of the supported locales. # For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] skip_resource_in_use_check # By default, the `DeleteSlotType` operations throws a # `ResourceInUseException` exception if you try to delete a slot type # used by a slot. Set the `skipResourceInUseCheck` parameter to `true` # to skip this check and remove the slot type even if a slot uses it. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteSlotTypeRequest AWS API Documentation # class DeleteSlotTypeRequest < Struct.new( :slot_type_id, :bot_id, :bot_version, :locale_id, :skip_resource_in_use_check) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id of the test set to be deleted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteTestSetRequest AWS API Documentation # class DeleteTestSetRequest < Struct.new( :test_set_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the utterances. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where the utterances were # collected. The string must match one of the supported locales. For # more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] session_id # The unique identifier of the session with the user. The ID is # returned in the response from the [RecognizeText][1] and # [RecognizeUtterance][2] operations. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html # [2]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteUtterancesRequest AWS API Documentation # class DeleteUtterancesRequest < Struct.new( :bot_id, :locale_id, :session_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DeleteUtterancesResponse AWS API Documentation # class DeleteUtterancesResponse < Aws::EmptyStructure; end # @!attribute [rw] bot_alias_id # The identifier of the bot alias to describe. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the bot alias to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotAliasRequest AWS API Documentation # class DescribeBotAliasRequest < Struct.new( :bot_alias_id, :bot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_id # The identifier of the bot alias. # @return [String] # # @!attribute [rw] bot_alias_name # The name of the bot alias. # @return [String] # # @!attribute [rw] description # The description of the bot alias. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the bot alias. # @return [String] # # @!attribute [rw] bot_alias_locale_settings # The locale settings that are unique to the alias. # @return [Hash] # # @!attribute [rw] conversation_log_settings # Specifics of how Amazon Lex logs text and audio conversations with # the bot associated with the alias. # @return [Types::ConversationLogSettings] # # @!attribute [rw] sentiment_analysis_settings # Determines whether Amazon Lex will use Amazon Comprehend to detect # the sentiment of user utterances. # @return [Types::SentimentAnalysisSettings] # # @!attribute [rw] bot_alias_history_events # A list of events that affect a bot alias. For example, an event is # recorded when the version that the alias points to changes. # @return [Array] # # @!attribute [rw] bot_alias_status # The current status of the alias. When the alias is `Available`, the # alias is ready for use with your bot. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the bot alias. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the alias was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the alias was last updated. # @return [Time] # # @!attribute [rw] parent_bot_networks # A list of the networks to which the bot alias you described belongs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotAliasResponse AWS API Documentation # class DescribeBotAliasResponse < Struct.new( :bot_alias_id, :bot_alias_name, :description, :bot_version, :bot_alias_locale_settings, :conversation_log_settings, :sentiment_analysis_settings, :bot_alias_history_events, :bot_alias_status, :bot_id, :creation_date_time, :last_updated_date_time, :parent_bot_networks) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with the locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the locale. # @return [String] # # @!attribute [rw] locale_id # The unique identifier of the locale to describe. The string must # match one of the supported locales. For more information, see # [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotLocaleRequest AWS API Documentation # class DescribeBotLocaleRequest < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with the locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the locale. # @return [String] # # @!attribute [rw] locale_id # The unique identifier of the described locale. # @return [String] # # @!attribute [rw] locale_name # The name of the locale. # @return [String] # # @!attribute [rw] description # The description of the locale. # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # The confidence threshold where Amazon Lex inserts the # `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in # the list of possible intents for an utterance. # @return [Float] # # @!attribute [rw] voice_settings # The Amazon Polly voice Amazon Lex uses for voice interaction with # the user. # @return [Types::VoiceSettings] # # @!attribute [rw] intents_count # The number of intents defined for the locale. # @return [Integer] # # @!attribute [rw] slot_types_count # The number of slot types defined for the locale. # @return [Integer] # # @!attribute [rw] bot_locale_status # The status of the bot. If the status is `Failed`, the reasons for # the failure are listed in the `failureReasons` field. # @return [String] # # @!attribute [rw] failure_reasons # if `botLocaleStatus` is `Failed`, Amazon Lex explains why it failed # to build the bot. # @return [Array] # # @!attribute [rw] creation_date_time # The date and time that the locale was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the locale was last updated. # @return [Time] # # @!attribute [rw] last_build_submitted_date_time # The date and time that the locale was last submitted for building. # @return [Time] # # @!attribute [rw] bot_locale_history_events # History of changes, such as when a locale is used in an alias, that # have taken place for the locale. # @return [Array] # # @!attribute [rw] recommended_actions # Recommended actions to take to resolve an error in the # `failureReasons` field. # @return [Array] # # @!attribute [rw] generative_ai_settings # Contains settings for Amazon Bedrock's generative AI features for # your bot locale. # @return [Types::GenerativeAISettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotLocaleResponse AWS API Documentation # class DescribeBotLocaleResponse < Struct.new( :bot_id, :bot_version, :locale_id, :locale_name, :description, :nlu_intent_confidence_threshold, :voice_settings, :intents_count, :slot_types_count, :bot_locale_status, :failure_reasons, :creation_date_time, :last_updated_date_time, :last_build_submitted_date_time, :bot_locale_history_events, :recommended_actions, :generative_ai_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with the bot # recommendation. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the bot recommendation. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to describe. The string must match one of the supported locales. For # more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The identifier of the bot recommendation to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotRecommendationRequest AWS API Documentation # class DescribeBotRecommendationRequest < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with the bot recommendation. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the bot recommendation. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to describe. # @return [String] # # @!attribute [rw] bot_recommendation_status # The status of the bot recommendation. If the status is Failed, then # the reasons for the failure are listed in the failureReasons field. # @return [String] # # @!attribute [rw] bot_recommendation_id # The identifier of the bot recommendation being described. # @return [String] # # @!attribute [rw] failure_reasons # If botRecommendationStatus is Failed, Amazon Lex explains why. # @return [Array] # # @!attribute [rw] creation_date_time # The date and time that the bot recommendation was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the bot recommendation was last updated. # @return [Time] # # @!attribute [rw] transcript_source_setting # The object representing the Amazon S3 bucket containing the # transcript, as well as the associated metadata. # @return [Types::TranscriptSourceSetting] # # @!attribute [rw] encryption_setting # The object representing the passwords that were used to encrypt the # data related to the bot recommendation results, as well as the KMS # key ARN used to encrypt the associated metadata. # @return [Types::EncryptionSetting] # # @!attribute [rw] bot_recommendation_results # The object representing the URL of the bot definition, the URL of # the associated transcript and a statistical summary of the bot # recommendation results. # @return [Types::BotRecommendationResults] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotRecommendationResponse AWS API Documentation # class DescribeBotRecommendationResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_status, :bot_recommendation_id, :failure_reasons, :creation_date_time, :last_updated_date_time, :transcript_source_setting, :encryption_setting, :bot_recommendation_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The request for the unique bot ID of the replicated bot being # monitored. # @return [String] # # @!attribute [rw] replica_region # The request for the region of the replicated bot being monitored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotReplicaRequest AWS API Documentation # class DescribeBotReplicaRequest < Struct.new( :bot_id, :replica_region) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique bot ID of the replicated bot being monitored. # @return [String] # # @!attribute [rw] replica_region # The region of the replicated bot being monitored. # @return [String] # # @!attribute [rw] source_region # The source region of the replicated bot being monitored. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time of the replicated bot being monitored. # @return [Time] # # @!attribute [rw] bot_replica_status # The operational status of the replicated bot being monitored. # @return [String] # # @!attribute [rw] failure_reasons # The failure reasons the bot being monitored failed to replicate. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotReplicaResponse AWS API Documentation # class DescribeBotReplicaResponse < Struct.new( :bot_id, :replica_region, :source_region, :creation_date_time, :bot_replica_status, :failure_reasons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotRequest AWS API Documentation # class DescribeBotRequest < Struct.new( :bot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot for which to return the generation # details. # @return [String] # # @!attribute [rw] bot_version # The version of the bot for which to return the generation details. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot for which to return the generation details. # @return [String] # # @!attribute [rw] generation_id # The unique identifier of the generation request for which to return # the generation details. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotResourceGenerationRequest AWS API Documentation # class DescribeBotResourceGenerationRequest < Struct.new( :bot_id, :bot_version, :locale_id, :generation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot for which the generation request # was made. # @return [String] # # @!attribute [rw] bot_version # The version of the bot for which the generation request was made. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot for which the generation request was made. # @return [String] # # @!attribute [rw] generation_id # The generation ID for which to return the generation details. # @return [String] # # @!attribute [rw] failure_reasons # A list of reasons why the generation of bot resources through # natural language description failed. # @return [Array] # # @!attribute [rw] generation_status # The status of the generation request. # @return [String] # # @!attribute [rw] generation_input_prompt # The prompt used in the generation request. # @return [String] # # @!attribute [rw] generated_bot_locale_url # The Amazon S3 location of the generated bot locale configuration. # @return [String] # # @!attribute [rw] creation_date_time # The date and time at which the item was generated. # @return [Time] # # @!attribute [rw] model_arn # The ARN of the model used to generate the bot resources. # @return [String] # # @!attribute [rw] last_updated_date_time # The date and time at which the generated item was updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotResourceGenerationResponse AWS API Documentation # class DescribeBotResourceGenerationResponse < Struct.new( :bot_id, :bot_version, :locale_id, :generation_id, :failure_reasons, :generation_status, :generation_input_prompt, :generated_bot_locale_url, :creation_date_time, :model_arn, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot. # @return [String] # # @!attribute [rw] bot_name # The name of the bot. # @return [String] # # @!attribute [rw] description # The description of the bot. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permission to # access the bot. # @return [String] # # @!attribute [rw] data_privacy # Settings for managing data privacy of the bot and its conversations # with users. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The maximum time in seconds that Amazon Lex retains the data # gathered in a conversation. # @return [Integer] # # @!attribute [rw] bot_status # The current status of the bot. When the status is `Available` the # bot is ready to be used in conversations with users. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot was last updated. # @return [Time] # # @!attribute [rw] bot_type # The type of the bot that was described. # @return [String] # # @!attribute [rw] bot_members # The list of bots in the network that was described. # @return [Array] # # @!attribute [rw] failure_reasons # If the `botStatus` is `Failed`, this contains a list of reasons that # the bot couldn't be built. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotResponse AWS API Documentation # class DescribeBotResponse < Struct.new( :bot_id, :bot_name, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_status, :creation_date_time, :last_updated_date_time, :bot_type, :bot_members, :failure_reasons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot containing the version to return metadata # for. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to return metadata for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotVersionRequest AWS API Documentation # class DescribeBotVersionRequest < Struct.new( :bot_id, :bot_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the version. # @return [String] # # @!attribute [rw] bot_name # The name of the bot that contains the version. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that was described. # @return [String] # # @!attribute [rw] description # The description specified for the bot. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permission to # access the bot version. # @return [String] # # @!attribute [rw] data_privacy # Data privacy settings for the bot version. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The number of seconds that a session with the bot remains active # before it is discarded by Amazon Lex. # @return [Integer] # # @!attribute [rw] bot_status # The current status of the bot. When the status is `Available`, the # bot version is ready for use. # @return [String] # # @!attribute [rw] failure_reasons # If the `botStatus` is `Failed`, this contains a list of reasons that # the version couldn't be built. # @return [Array] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot version was created. # @return [Time] # # @!attribute [rw] parent_bot_networks # A list of the networks to which the bot version you described # belongs. # @return [Array] # # @!attribute [rw] bot_type # The type of the bot in the version that was described. # @return [String] # # @!attribute [rw] bot_members # The members of bot network in the version that was described. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeBotVersionResponse AWS API Documentation # class DescribeBotVersionResponse < Struct.new( :bot_id, :bot_name, :bot_version, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_status, :failure_reasons, :creation_date_time, :parent_bot_networks, :bot_type, :bot_members) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the custom # vocabulary. # @return [String] # # @!attribute [rw] bot_version # The bot version of the bot to return metadata for. # @return [String] # # @!attribute [rw] locale_id # The locale to return the custom vocabulary information for. The # locale must be `en_GB`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadataRequest AWS API Documentation # class DescribeCustomVocabularyMetadataRequest < Struct.new( :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the custom vocabulary to # describe. # @return [String] # # @!attribute [rw] locale_id # The locale that contains the custom vocabulary to describe. # @return [String] # # @!attribute [rw] custom_vocabulary_status # The status of the custom vocabulary. If the status is `Ready` the # custom vocabulary is ready to use. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the custom vocabulary was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the custom vocabulary was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeCustomVocabularyMetadataResponse AWS API Documentation # class DescribeCustomVocabularyMetadataResponse < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_status, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier of the export to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeExportRequest AWS API Documentation # class DescribeExportRequest < Struct.new( :export_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier of the described export. # @return [String] # # @!attribute [rw] resource_specification # The bot, bot ID, and optional locale ID of the exported bot or bot # locale. # @return [Types::ExportResourceSpecification] # # @!attribute [rw] file_format # The file format used in the files that describe the resource. # @return [String] # # @!attribute [rw] export_status # The status of the export. When the status is `Complete` the export # archive file is available for download. # @return [String] # # @!attribute [rw] failure_reasons # If the `exportStatus` is failed, contains one or more reasons why # the export could not be completed. # @return [Array] # # @!attribute [rw] download_url # A pre-signed S3 URL that points to the bot or bot locale archive. # The URL is only available for 5 minutes after calling the # `DescribeExport` operation. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the export was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The last date and time that the export was updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeExportResponse AWS API Documentation # class DescribeExportResponse < Struct.new( :export_id, :resource_specification, :file_format, :export_status, :failure_reasons, :download_url, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_id # The unique identifier of the import to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeImportRequest AWS API Documentation # class DescribeImportRequest < Struct.new( :import_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_id # The unique identifier of the described import. # @return [String] # # @!attribute [rw] resource_specification # The specifications of the imported bot, bot locale, or custom # vocabulary. # @return [Types::ImportResourceSpecification] # # @!attribute [rw] imported_resource_id # The unique identifier that Amazon Lex assigned to the resource # created by the import. # @return [String] # # @!attribute [rw] imported_resource_name # The name of the imported resource. # @return [String] # # @!attribute [rw] merge_strategy # The strategy used when there was a name conflict between the # imported resource and an existing resource. When the merge strategy # is `FailOnConflict` existing resources are not overwritten and the # import fails. # @return [String] # # @!attribute [rw] import_status # The status of the import process. When the status is `Completed` the # resource is imported and ready for use. # @return [String] # # @!attribute [rw] failure_reasons # If the `importStatus` field is `Failed`, this provides one or more # reasons for the failure. # @return [Array] # # @!attribute [rw] creation_date_time # The date and time that the import was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the import was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeImportResponse AWS API Documentation # class DescribeImportResponse < Struct.new( :import_id, :resource_specification, :imported_resource_id, :imported_resource_name, :merge_strategy, :import_status, :failure_reasons, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The identifier of the intent to describe. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the intent. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the intent to describe. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeIntentRequest AWS API Documentation # class DescribeIntentRequest < Struct.new( :intent_id, :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The unique identifier assigned to the intent when it was created. # @return [String] # # @!attribute [rw] intent_name # The name specified for the intent. # @return [String] # # @!attribute [rw] description # The description of the intent. # @return [String] # # @!attribute [rw] parent_intent_signature # The identifier of the built-in intent that this intent is derived # from, if any. # @return [String] # # @!attribute [rw] sample_utterances # User utterances that trigger this intent. # @return [Array] # # @!attribute [rw] dialog_code_hook # The Lambda function called during each turn of a conversation with # the intent. # @return [Types::DialogCodeHookSettings] # # @!attribute [rw] fulfillment_code_hook # The Lambda function called when the intent is complete and ready for # fulfillment. # @return [Types::FulfillmentCodeHookSettings] # # @!attribute [rw] slot_priorities # The list that determines the priority that slots should be elicited # from the user. # @return [Array] # # @!attribute [rw] intent_confirmation_setting # Prompts that Amazon Lex sends to the user to confirm completion of # an intent. # @return [Types::IntentConfirmationSetting] # # @!attribute [rw] intent_closing_setting # The response that Amazon Lex sends to when the intent is closed. # @return [Types::IntentClosingSetting] # # @!attribute [rw] input_contexts # A list of contexts that must be active for the intent to be # considered for sending to the user. # @return [Array] # # @!attribute [rw] output_contexts # A list of contexts that are activated when the intent is fulfilled. # @return [Array] # # @!attribute [rw] kendra_configuration # Configuration information required to use the # `AMAZON.KendraSearchIntent` intent. # @return [Types::KendraConfiguration] # # @!attribute [rw] bot_id # The identifier of the bot associated with the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the intent. # @return [String] # # @!attribute [rw] locale_id # The language and locale specified for the intent. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the intent was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the intent was last updated. # @return [Time] # # @!attribute [rw] initial_response_setting # Configuration setting for a response sent to the user before Amazon # Lex starts eliciting slots. # @return [Types::InitialResponseSetting] # # @!attribute [rw] qn_a_intent_configuration # Details about the configuration of the built-in `Amazon.QnAIntent`. # @return [Types::QnAIntentConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeIntentResponse AWS API Documentation # class DescribeIntentResponse < Struct.new( :intent_id, :intent_name, :description, :parent_intent_signature, :sample_utterances, :dialog_code_hook, :fulfillment_code_hook, :slot_priorities, :intent_confirmation_setting, :intent_closing_setting, :input_contexts, :output_contexts, :kendra_configuration, :bot_id, :bot_version, :locale_id, :creation_date_time, :last_updated_date_time, :initial_response_setting, :qn_a_intent_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeResourcePolicyRequest AWS API Documentation # class DescribeResourcePolicyRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] policy # The JSON structure that contains the resource policy. For more # information about the contents of a JSON policy document, see [ IAM # JSON policy reference ][1]. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeResourcePolicyResponse AWS API Documentation # class DescribeResourcePolicyResponse < Struct.new( :resource_arn, :policy, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The unique identifier for the slot. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the slot to describe. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent that contains the slot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotRequest AWS API Documentation # class DescribeSlotRequest < Struct.new( :slot_id, :bot_id, :bot_version, :locale_id, :intent_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The unique identifier generated for the slot. # @return [String] # # @!attribute [rw] slot_name # The name specified for the slot. # @return [String] # # @!attribute [rw] description # The description specified for the slot. # @return [String] # # @!attribute [rw] slot_type_id # The identifier of the slot type that determines the values entered # into the slot. # @return [String] # # @!attribute [rw] value_elicitation_setting # Prompts that Amazon Lex uses to elicit a value for the slot. # @return [Types::SlotValueElicitationSetting] # # @!attribute [rw] obfuscation_setting # Whether slot values are shown in Amazon CloudWatch logs. If the # value is `None`, the actual value of the slot is shown in logs. # @return [Types::ObfuscationSetting] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot. # @return [String] # # @!attribute [rw] locale_id # The language and locale specified for the slot. # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent associated with the slot. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the slot was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the slot was last updated. # @return [Time] # # @!attribute [rw] multiple_values_setting # Indicates whether the slot accepts multiple values in a single # utterance. # # If the `multipleValuesSetting` is not set, the default value is # `false`. # @return [Types::MultipleValuesSetting] # # @!attribute [rw] sub_slot_setting # Specifications for the constituent sub slots and the expression for # the composite slot. # @return [Types::SubSlotSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotResponse AWS API Documentation # class DescribeSlotResponse < Struct.new( :slot_id, :slot_name, :description, :slot_type_id, :value_elicitation_setting, :obfuscation_setting, :bot_id, :bot_version, :locale_id, :intent_id, :creation_date_time, :last_updated_date_time, :multiple_values_setting, :sub_slot_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The identifier of the slot type. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot type. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the slot type to # describe. The string must match one of the supported locales. For # more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotTypeRequest AWS API Documentation # class DescribeSlotTypeRequest < Struct.new( :slot_type_id, :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The unique identifier for the slot type. # @return [String] # # @!attribute [rw] slot_type_name # The name specified for the slot type. # @return [String] # # @!attribute [rw] description # The description specified for the slot type. # @return [String] # # @!attribute [rw] slot_type_values # The values that the slot type can take. Includes any synonyms for # the slot type values. # @return [Array] # # @!attribute [rw] value_selection_setting # The strategy that Amazon Lex uses to choose a value from a list of # possible values. # @return [Types::SlotValueSelectionSetting] # # @!attribute [rw] parent_slot_type_signature # The built in slot type used as a parent to this slot type. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot associated with the slot type. # @return [String] # # @!attribute [rw] locale_id # The language and locale specified for the slot type. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the slot type was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the slot type was last # updated. # @return [Time] # # @!attribute [rw] external_source_setting # Provides information about the external source of the slot type's # definition. # @return [Types::ExternalSourceSetting] # # @!attribute [rw] composite_slot_type_setting # Specifications for a composite slot type. # @return [Types::CompositeSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotTypeResponse AWS API Documentation # class DescribeSlotTypeResponse < Struct.new( :slot_type_id, :slot_type_name, :description, :slot_type_values, :value_selection_setting, :parent_slot_type_signature, :bot_id, :bot_version, :locale_id, :creation_date_time, :last_updated_date_time, :external_source_setting, :composite_slot_type_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The execution Id of the test set execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestExecutionRequest AWS API Documentation # class DescribeTestExecutionRequest < Struct.new( :test_execution_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The execution Id for the test set execution. # @return [String] # # @!attribute [rw] creation_date_time # The execution creation date and time for the test set execution. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time of the last update for the execution. # @return [Time] # # @!attribute [rw] test_execution_status # The test execution status for the test execution. # @return [String] # # @!attribute [rw] test_set_id # The test set Id for the test set execution. # @return [String] # # @!attribute [rw] test_set_name # The test set name of the test set execution. # @return [String] # # @!attribute [rw] target # The target bot for the test set execution details. # @return [Types::TestExecutionTarget] # # @!attribute [rw] api_mode # Indicates whether we use streaming or non-streaming APIs are used # for the test set execution. For streaming, `StartConversation` # Amazon Lex Runtime API is used. Whereas for non-streaming, # `RecognizeUtterance` and `RecognizeText` Amazon Lex Runtime API is # used. # @return [String] # # @!attribute [rw] test_execution_modality # Indicates whether test set is audio or text. # @return [String] # # @!attribute [rw] failure_reasons # Reasons for the failure of the test set execution. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestExecutionResponse AWS API Documentation # class DescribeTestExecutionResponse < Struct.new( :test_execution_id, :creation_date_time, :last_updated_date_time, :test_execution_status, :test_set_id, :test_set_name, :target, :api_mode, :test_execution_modality, :failure_reasons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_discrepancy_report_id # The unique identifier of the test set discrepancy report. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReportRequest AWS API Documentation # class DescribeTestSetDiscrepancyReportRequest < Struct.new( :test_set_discrepancy_report_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_discrepancy_report_id # The unique identifier of the test set discrepancy report to # describe. # @return [String] # # @!attribute [rw] test_set_id # The test set Id for the test set discrepancy report. # @return [String] # # @!attribute [rw] creation_date_time # The time and date of creation for the test set discrepancy report. # @return [Time] # # @!attribute [rw] target # The target bot location for the test set discrepancy report. # @return [Types::TestSetDiscrepancyReportResourceTarget] # # @!attribute [rw] test_set_discrepancy_report_status # The status for the test set discrepancy report. # @return [String] # # @!attribute [rw] last_updated_data_time # The date and time of the last update for the test set discrepancy # report. # @return [Time] # # @!attribute [rw] test_set_discrepancy_top_errors # The top 200 error results from the test set discrepancy report. # @return [Types::TestSetDiscrepancyErrors] # # @!attribute [rw] test_set_discrepancy_raw_output_url # Pre-signed Amazon S3 URL to download the test set discrepancy # report. # @return [String] # # @!attribute [rw] failure_reasons # The failure report for the test set discrepancy report generation # action. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetDiscrepancyReportResponse AWS API Documentation # class DescribeTestSetDiscrepancyReportResponse < Struct.new( :test_set_discrepancy_report_id, :test_set_id, :creation_date_time, :target, :test_set_discrepancy_report_status, :last_updated_data_time, :test_set_discrepancy_top_errors, :test_set_discrepancy_raw_output_url, :failure_reasons) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_generation_id # The unique identifier of the test set generation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetGenerationRequest AWS API Documentation # class DescribeTestSetGenerationRequest < Struct.new( :test_set_generation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_generation_id # The unique identifier of the test set generation. # @return [String] # # @!attribute [rw] test_set_generation_status # The status for the test set generation. # @return [String] # # @!attribute [rw] failure_reasons # The reasons the test set generation failed. # @return [Array] # # @!attribute [rw] test_set_id # The unique identifier for the test set created for the generated # test set. # @return [String] # # @!attribute [rw] test_set_name # The test set name for the generated test set. # @return [String] # # @!attribute [rw] description # The test set description for the test set generation. # @return [String] # # @!attribute [rw] storage_location # The Amazon S3 storage location for the test set generation. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] generation_data_source # The data source of the test set used for the test set generation. # @return [Types::TestSetGenerationDataSource] # # @!attribute [rw] role_arn # The roleARN of the test set used for the test set generation. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time for the test set generation. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time of the last update for the test set generation. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetGenerationResponse AWS API Documentation # class DescribeTestSetGenerationResponse < Struct.new( :test_set_generation_id, :test_set_generation_status, :failure_reasons, :test_set_id, :test_set_name, :description, :storage_location, :generation_data_source, :role_arn, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for the test set request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetRequest AWS API Documentation # class DescribeTestSetRequest < Struct.new( :test_set_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for the test set response. # @return [String] # # @!attribute [rw] test_set_name # The test set name of the test set. # @return [String] # # @!attribute [rw] description # The description of the test set. # @return [String] # # @!attribute [rw] modality # Indicates whether the test set is audio or text data. # @return [String] # # @!attribute [rw] status # The status of the test set. # @return [String] # # @!attribute [rw] role_arn # The roleARN used for any operation in the test set to access # resources in the Amazon Web Services account. # @return [String] # # @!attribute [rw] num_turns # The total number of agent and user turn in the test set. # @return [Integer] # # @!attribute [rw] storage_location # The Amazon S3 storage location for the test set data. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] creation_date_time # The creation date and time for the test set data. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time for the last update of the test set data. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeTestSetResponse AWS API Documentation # class DescribeTestSetResponse < Struct.new( :test_set_id, :test_set_name, :description, :modality, :status, :role_arn, :num_turns, :storage_location, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Contains specifications for the descriptive bot building feature. # # @!attribute [rw] enabled # Specifies whether the descriptive bot building feature is activated # or not. # @return [Boolean] # # @!attribute [rw] bedrock_model_specification # An object containing information about the Amazon Bedrock model used # to interpret the prompt used in descriptive bot building. # @return [Types::BedrockModelSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescriptiveBotBuilderSpecification AWS API Documentation # class DescriptiveBotBuilderSpecification < Struct.new( :enabled, :bedrock_model_specification) SENSITIVE = [] include Aws::Structure end # Defines the action that the bot executes at runtime when the # conversation reaches this step. # # @!attribute [rw] type # The action that the bot should execute. # @return [String] # # @!attribute [rw] slot_to_elicit # If the dialog action is `ElicitSlot`, defines the slot to elicit # from the user. # @return [String] # # @!attribute [rw] suppress_next_message # When true the next message for the intent is not used. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DialogAction AWS API Documentation # class DialogAction < Struct.new( :type, :slot_to_elicit, :suppress_next_message) SENSITIVE = [] include Aws::Structure end # Settings that specify the dialog code hook that is called by Amazon # Lex at a step of the conversation. # # @!attribute [rw] enable_code_hook_invocation # Indicates whether a Lambda function should be invoked for the # dialog. # @return [Boolean] # # @!attribute [rw] active # Determines whether a dialog code hook is used when the intent is # activated. # @return [Boolean] # # @!attribute [rw] invocation_label # A label that indicates the dialog step from which the dialog code # hook is happening. # @return [String] # # @!attribute [rw] post_code_hook_specification # Contains the responses and actions that Amazon Lex takes after the # Lambda function is complete. # @return [Types::PostDialogCodeHookInvocationSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DialogCodeHookInvocationSetting AWS API Documentation # class DialogCodeHookInvocationSetting < Struct.new( :enable_code_hook_invocation, :active, :invocation_label, :post_code_hook_specification) SENSITIVE = [] include Aws::Structure end # Settings that determine the Lambda function that Amazon Lex uses for # processing user responses. # # @!attribute [rw] enabled # Enables the dialog code hook so that it processes user requests. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DialogCodeHookSettings AWS API Documentation # class DialogCodeHookSettings < Struct.new( :enabled) SENSITIVE = [] include Aws::Structure end # The current state of the conversation with the user. # # @!attribute [rw] dialog_action # Defines the action that the bot executes at runtime when the # conversation reaches this step. # @return [Types::DialogAction] # # @!attribute [rw] intent # Override settings to configure the intent state. # @return [Types::IntentOverride] # # @!attribute [rw] session_attributes # Map of key/value pairs representing session-specific context # information. It contains application information passed between # Amazon Lex and a client application. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DialogState AWS API Documentation # class DialogState < Struct.new( :dialog_action, :intent, :session_attributes) SENSITIVE = [] include Aws::Structure end # Settings that specify the dialog code hook that is called by Amazon # Lex between eliciting slot values. # # @!attribute [rw] enable_code_hook_invocation # Indicates whether a Lambda function should be invoked for the # dialog. # @return [Boolean] # # @!attribute [rw] invocation_label # A label that indicates the dialog step from which the dialog code # hook is happening. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ElicitationCodeHookInvocationSetting AWS API Documentation # class ElicitationCodeHookInvocationSetting < Struct.new( :enable_code_hook_invocation, :invocation_label) SENSITIVE = [] include Aws::Structure end # The object representing the passwords that were used to encrypt the # data related to the bot recommendation, as well as the KMS key ARN # used to encrypt the associated metadata. # # @!attribute [rw] kms_key_arn # The KMS key ARN used to encrypt the metadata associated with the bot # recommendation. # @return [String] # # @!attribute [rw] bot_locale_export_password # The password used to encrypt the recommended bot recommendation # file. # @return [String] # # @!attribute [rw] associated_transcripts_password # The password used to encrypt the associated transcript file. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/EncryptionSetting AWS API Documentation # class EncryptionSetting < Struct.new( :kms_key_arn, :bot_locale_export_password, :associated_transcripts_password) SENSITIVE = [:bot_locale_export_password, :associated_transcripts_password] include Aws::Structure end # Contains the names of the fields used for an exact response to the # user. # # @!attribute [rw] question_field # The name of the field that contains the query made to the OpenSearch # Service database. # @return [String] # # @!attribute [rw] answer_field # The name of the field that contains the answer to the query made to # the OpenSearch Service database. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExactResponseFields AWS API Documentation # class ExactResponseFields < Struct.new( :question_field, :answer_field) SENSITIVE = [] include Aws::Structure end # Details about an error in an execution of a test set. # # @!attribute [rw] error_code # The error code for the error. # @return [String] # # @!attribute [rw] error_message # The message describing the error. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExecutionErrorDetails AWS API Documentation # class ExecutionErrorDetails < Struct.new( :error_code, :error_message) SENSITIVE = [] include Aws::Structure end # Filters the response form the [ListExports][1] operation # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html # # @!attribute [rw] name # The name of the field to use for filtering. # @return [String] # # @!attribute [rw] values # The values to use to filter the response. The values must be `Bot`, # `BotLocale`, or `CustomVocabulary`. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify EQ when the # `ListExports` operation should return only resource types that equal # the specified value. Specify CO when the `ListExports` operation # should return resource types that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExportFilter AWS API Documentation # class ExportFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Provides information about the bot or bot locale that you want to # export. You can specify the `botExportSpecification` or the # `botLocaleExportSpecification`, but not both. # # @!attribute [rw] bot_export_specification # Parameters for exporting a bot. # @return [Types::BotExportSpecification] # # @!attribute [rw] bot_locale_export_specification # Parameters for exporting a bot locale. # @return [Types::BotLocaleExportSpecification] # # @!attribute [rw] custom_vocabulary_export_specification # The parameters required to export a custom vocabulary. # @return [Types::CustomVocabularyExportSpecification] # # @!attribute [rw] test_set_export_specification # Specifications for the test set that is exported as a resource. # @return [Types::TestSetExportSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExportResourceSpecification AWS API Documentation # class ExportResourceSpecification < Struct.new( :bot_export_specification, :bot_locale_export_specification, :custom_vocabulary_export_specification, :test_set_export_specification) SENSITIVE = [] include Aws::Structure end # Provides information about sorting a list of exports. # # @!attribute [rw] attribute # The export field to use for sorting. # @return [String] # # @!attribute [rw] order # The order to sort the list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExportSortBy AWS API Documentation # class ExportSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Provides summary information about an export in an export list. # # @!attribute [rw] export_id # The unique identifier that Amazon Lex assigned to the export. # @return [String] # # @!attribute [rw] resource_specification # Information about the bot or bot locale that was exported. # @return [Types::ExportResourceSpecification] # # @!attribute [rw] file_format # The file format used in the export files. # @return [String] # # @!attribute [rw] export_status # The status of the export. When the status is `Completed` the export # is ready to download. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the export was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the export was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExportSummary AWS API Documentation # class ExportSummary < Struct.new( :export_id, :resource_specification, :file_format, :export_status, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Provides information about the external source of the slot type's # definition. # # @!attribute [rw] grammar_slot_type_setting # Settings required for a slot type based on a grammar that you # provide. # @return [Types::GrammarSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ExternalSourceSetting AWS API Documentation # class ExternalSourceSetting < Struct.new( :grammar_slot_type_setting) SENSITIVE = [] include Aws::Structure end # The unique failed custom vocabulary item from the custom vocabulary # list. # # @!attribute [rw] item_id # The unique item identifer for the failed custom vocabulary item from # the custom vocabulary list. # @return [String] # # @!attribute [rw] error_message # The error message for the failed custom vocabulary item from the # custom vocabulary list. # @return [String] # # @!attribute [rw] error_code # The unique error code for the failed custom vocabulary item from the # custom vocabulary list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/FailedCustomVocabularyItem AWS API Documentation # class FailedCustomVocabularyItem < Struct.new( :item_id, :error_message, :error_code) SENSITIVE = [] include Aws::Structure end # Determines if a Lambda function should be invoked for a specific # intent. # # @!attribute [rw] enabled # Indicates whether a Lambda function should be invoked to fulfill a # specific intent. # @return [Boolean] # # @!attribute [rw] post_fulfillment_status_specification # Provides settings for messages sent to the user for after the Lambda # fulfillment function completes. Post-fulfillment messages can be # sent for both streaming and non-streaming conversations. # @return [Types::PostFulfillmentStatusSpecification] # # @!attribute [rw] fulfillment_updates_specification # Provides settings for update messages sent to the user for # long-running Lambda fulfillment functions. Fulfillment updates can # be used only with streaming conversations. # @return [Types::FulfillmentUpdatesSpecification] # # @!attribute [rw] active # Determines whether the fulfillment code hook is used. When `active` # is false, the code hook doesn't run. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/FulfillmentCodeHookSettings AWS API Documentation # class FulfillmentCodeHookSettings < Struct.new( :enabled, :post_fulfillment_status_specification, :fulfillment_updates_specification, :active) SENSITIVE = [] include Aws::Structure end # Provides settings for a message that is sent to the user when a # fulfillment Lambda function starts running. # # @!attribute [rw] delay_in_seconds # The delay between when the Lambda fulfillment function starts # running and the start message is played. If the Lambda function # returns before the delay is over, the start message isn't played. # @return [Integer] # # @!attribute [rw] message_groups # 1 - 5 message groups that contain start messages. Amazon Lex chooses # one of the messages to play to the user. # @return [Array] # # @!attribute [rw] allow_interrupt # Determines whether the user can interrupt the start message while it # is playing. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/FulfillmentStartResponseSpecification AWS API Documentation # class FulfillmentStartResponseSpecification < Struct.new( :delay_in_seconds, :message_groups, :allow_interrupt) SENSITIVE = [] include Aws::Structure end # Provides settings for a message that is sent periodically to the user # while a fulfillment Lambda function is running. # # @!attribute [rw] frequency_in_seconds # The frequency that a message is sent to the user. When the period # ends, Amazon Lex chooses a message from the message groups and plays # it to the user. If the fulfillment Lambda returns before the first # period ends, an update message is not played to the user. # @return [Integer] # # @!attribute [rw] message_groups # 1 - 5 message groups that contain update messages. Amazon Lex # chooses one of the messages to play to the user. # @return [Array] # # @!attribute [rw] allow_interrupt # Determines whether the user can interrupt an update message while it # is playing. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/FulfillmentUpdateResponseSpecification AWS API Documentation # class FulfillmentUpdateResponseSpecification < Struct.new( :frequency_in_seconds, :message_groups, :allow_interrupt) SENSITIVE = [] include Aws::Structure end # Provides information for updating the user on the progress of # fulfilling an intent. # # @!attribute [rw] active # Determines whether fulfillment updates are sent to the user. When # this field is true, updates are sent. # # If the `active` field is set to true, the `startResponse`, # `updateResponse`, and `timeoutInSeconds` fields are required. # @return [Boolean] # # @!attribute [rw] start_response # Provides configuration information for the message sent to users # when the fulfillment Lambda functions starts running. # @return [Types::FulfillmentStartResponseSpecification] # # @!attribute [rw] update_response # Provides configuration information for messages sent periodically to # the user while the fulfillment Lambda function is running. # @return [Types::FulfillmentUpdateResponseSpecification] # # @!attribute [rw] timeout_in_seconds # The length of time that the fulfillment Lambda function should run # before it times out. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/FulfillmentUpdatesSpecification AWS API Documentation # class FulfillmentUpdatesSpecification < Struct.new( :active, :start_response, :update_response, :timeout_in_seconds) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The intent unique Id for the bot request to generate utterances. # @return [String] # # @!attribute [rw] bot_id # The bot unique Id for the bot request to generate utterances. # @return [String] # # @!attribute [rw] bot_version # The bot version for the bot request to generate utterances. # @return [String] # # @!attribute [rw] locale_id # The unique locale Id for the bot request to generate utterances. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GenerateBotElementRequest AWS API Documentation # class GenerateBotElementRequest < Struct.new( :intent_id, :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique bot Id for the bot which received the response. # @return [String] # # @!attribute [rw] bot_version # The unique bot version for the bot which received the response. # @return [String] # # @!attribute [rw] locale_id # The unique locale Id for the bot which received the response. # @return [String] # # @!attribute [rw] intent_id # The unique intent Id for the bot which received the response. # @return [String] # # @!attribute [rw] sample_utterances # The sample utterances for the bot which received the response. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GenerateBotElementResponse AWS API Documentation # class GenerateBotElementResponse < Struct.new( :bot_id, :bot_version, :locale_id, :intent_id, :sample_utterances) SENSITIVE = [] include Aws::Structure end # Specifies the attribute and method by which to sort the generation # request information. # # @!attribute [rw] attribute # The attribute by which to sort the generation request information. # You can sort by the following attributes. # # * `creationStartTime` – The time at which the generation request was # created. # # * `lastUpdatedTime` – The time at which the generation request was # last updated. # @return [String] # # @!attribute [rw] order # The order by which to sort the generation request information. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GenerationSortBy AWS API Documentation # class GenerationSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Contains information about a generation request made for the bot # locale. # # @!attribute [rw] generation_id # The unique identifier of the generation request. # @return [String] # # @!attribute [rw] generation_status # The status of the generation request. # @return [String] # # @!attribute [rw] creation_date_time # The date and time at which the generation request was made. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time at which the generation request was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GenerationSummary AWS API Documentation # class GenerationSummary < Struct.new( :generation_id, :generation_status, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Contains specifications about the generative AI capabilities from # Amazon Bedrock that you can turn on for your bot. # # @!attribute [rw] runtime_settings # Contains specifications about the Amazon Lex runtime generative AI # capabilities from Amazon Bedrock that you can turn on for your bot. # @return [Types::RuntimeSettings] # # @!attribute [rw] buildtime_settings # Contains specifications about the Amazon Lex build time generative # AI capabilities from Amazon Bedrock that you can turn on for your # bot. # @return [Types::BuildtimeSettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GenerativeAISettings AWS API Documentation # class GenerativeAISettings < Struct.new( :runtime_settings, :buildtime_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The unique identifier of the completed test execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrlRequest AWS API Documentation # class GetTestExecutionArtifactsUrlRequest < Struct.new( :test_execution_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The unique identifier of the completed test execution. # @return [String] # # @!attribute [rw] download_artifacts_url # The pre-signed Amazon S3 URL to download completed test execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GetTestExecutionArtifactsUrlResponse AWS API Documentation # class GetTestExecutionArtifactsUrlResponse < Struct.new( :test_execution_id, :download_artifacts_url) SENSITIVE = [] include Aws::Structure end # Settings requried for a slot type based on a grammar that you provide. # # @!attribute [rw] source # The source of the grammar used to create the slot type. # @return [Types::GrammarSlotTypeSource] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GrammarSlotTypeSetting AWS API Documentation # class GrammarSlotTypeSetting < Struct.new( :source) SENSITIVE = [] include Aws::Structure end # Describes the Amazon S3 bucket name and location for the grammar that # is the source for the slot type. # # @!attribute [rw] s3_bucket_name # The name of the Amazon S3 bucket that contains the grammar source. # @return [String] # # @!attribute [rw] s3_object_key # The path to the grammar in the Amazon S3 bucket. # @return [String] # # @!attribute [rw] kms_key_arn # The KMS key required to decrypt the contents of the grammar, if any. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/GrammarSlotTypeSource AWS API Documentation # class GrammarSlotTypeSource < Struct.new( :s3_bucket_name, :s3_object_key, :kms_key_arn) SENSITIVE = [] include Aws::Structure end # A card that is shown to the user by a messaging platform. You define # the contents of the card, the card is displayed by the platform. # # When you use a response card, the response from the user is # constrained to the text associated with a button on the card. # # @!attribute [rw] title # The title to display on the response card. The format of the title # is determined by the platform displaying the response card. # @return [String] # # @!attribute [rw] subtitle # The subtitle to display on the response card. The format of the # subtitle is determined by the platform displaying the response card. # @return [String] # # @!attribute [rw] image_url # The URL of an image to display on the response card. The image URL # must be publicly available so that the platform displaying the # response card has access to the image. # @return [String] # # @!attribute [rw] buttons # A list of buttons that should be displayed on the response card. The # arrangement of the buttons is determined by the platform that # displays the button. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ImageResponseCard AWS API Documentation # class ImageResponseCard < Struct.new( :title, :subtitle, :image_url, :buttons) SENSITIVE = [] include Aws::Structure end # Filters the response from the [ListImports][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html # # @!attribute [rw] name # The name of the field to use for filtering. # @return [String] # # @!attribute [rw] values # The values to use to filter the response. The values must be `Bot`, # `BotLocale`, or `CustomVocabulary`. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify EQ when the # `ListImports` operation should return only resource types that equal # the specified value. Specify CO when the `ListImports` operation # should return resource types that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ImportFilter AWS API Documentation # class ImportFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Provides information about the bot or bot locale that you want to # import. You can specify the `botImportSpecification` or the # `botLocaleImportSpecification`, but not both. # # @!attribute [rw] bot_import_specification # Parameters for importing a bot. # @return [Types::BotImportSpecification] # # @!attribute [rw] bot_locale_import_specification # Parameters for importing a bot locale. # @return [Types::BotLocaleImportSpecification] # # @!attribute [rw] custom_vocabulary_import_specification # Provides the parameters required for importing a custom vocabulary. # @return [Types::CustomVocabularyImportSpecification] # # @!attribute [rw] test_set_import_resource_specification # Specifications for the test set that is imported. # @return [Types::TestSetImportResourceSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ImportResourceSpecification AWS API Documentation # class ImportResourceSpecification < Struct.new( :bot_import_specification, :bot_locale_import_specification, :custom_vocabulary_import_specification, :test_set_import_resource_specification) SENSITIVE = [] include Aws::Structure end # Provides information for sorting a list of imports. # # @!attribute [rw] attribute # The export field to use for sorting. # @return [String] # # @!attribute [rw] order # The order to sort the list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ImportSortBy AWS API Documentation # class ImportSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Provides summary information about an import in an import list. # # @!attribute [rw] import_id # The unique identifier that Amazon Lex assigned to the import. # @return [String] # # @!attribute [rw] imported_resource_id # The unique identifier that Amazon Lex assigned to the imported # resource. # @return [String] # # @!attribute [rw] imported_resource_name # The name that you gave the imported resource. # @return [String] # # @!attribute [rw] import_status # The status of the resource. When the status is `Completed` the # resource is ready to build. # @return [String] # # @!attribute [rw] merge_strategy # The strategy used to merge existing bot or bot locale definitions # with the imported definition. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the import was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the import was last updated. # @return [Time] # # @!attribute [rw] imported_resource_type # The type of resource that was imported. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ImportSummary AWS API Documentation # class ImportSummary < Struct.new( :import_id, :imported_resource_id, :imported_resource_name, :import_status, :merge_strategy, :creation_date_time, :last_updated_date_time, :imported_resource_type) SENSITIVE = [] include Aws::Structure end # Configuration setting for a response sent to the user before Amazon # Lex starts eliciting slots. # # @!attribute [rw] initial_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] next_step # The next step in the conversation. # @return [Types::DialogState] # # @!attribute [rw] conditional # Provides a list of conditional branches. Branches are evaluated in # the order that they are entered in the list. The first branch with a # condition that evaluates to true is executed. The last branch in the # list is the default branch. The default branch should not have any # condition expression. The default branch is executed if no other # branch has a matching condition. # @return [Types::ConditionalSpecification] # # @!attribute [rw] code_hook # Settings that specify the dialog code hook that is called by Amazon # Lex at a step of the conversation. # @return [Types::DialogCodeHookInvocationSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InitialResponseSetting AWS API Documentation # class InitialResponseSetting < Struct.new( :initial_response, :next_step, :conditional, :code_hook) SENSITIVE = [] include Aws::Structure end # A context that must be active for an intent to be selected by Amazon # Lex. # # @!attribute [rw] name # The name of the context. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InputContext AWS API Documentation # class InputContext < Struct.new( :name) SENSITIVE = [] include Aws::Structure end # Specifications for the current state of the dialog between the user # and the bot in the test set. # # @!attribute [rw] session_attributes # Session attributes for the session state. # @return [Hash] # # @!attribute [rw] active_contexts # Active contexts for the session state. # @return [Array] # # @!attribute [rw] runtime_hints # Runtime hints for the session state. # @return [Types::RuntimeHints] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InputSessionStateSpecification AWS API Documentation # class InputSessionStateSpecification < Struct.new( :session_attributes, :active_contexts, :runtime_hints) SENSITIVE = [] include Aws::Structure end # Information for an intent that is classified by the test workbench. # # @!attribute [rw] intent_name # The name of the intent. # @return [String] # # @!attribute [rw] multi_turn_conversation # Indicates whether the conversation involves multiple turns or not. # @return [Boolean] # # @!attribute [rw] result_counts # The result of the intent classification test. # @return [Types::IntentClassificationTestResultItemCounts] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentClassificationTestResultItem AWS API Documentation # class IntentClassificationTestResultItem < Struct.new( :intent_name, :multi_turn_conversation, :result_counts) SENSITIVE = [] include Aws::Structure end # The number of items in the intent classification test. # # @!attribute [rw] total_result_count # The total number of results in the intent classification test. # @return [Integer] # # @!attribute [rw] speech_transcription_result_counts # The number of matched, mismatched, and execution error results for # speech transcription for the intent. # @return [Hash] # # @!attribute [rw] intent_match_result_counts # The number of matched and mismatched results for intent recognition # for the intent. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentClassificationTestResultItemCounts AWS API Documentation # class IntentClassificationTestResultItemCounts < Struct.new( :total_result_count, :speech_transcription_result_counts, :intent_match_result_counts) SENSITIVE = [] include Aws::Structure end # Information for the results of the intent classification test. # # @!attribute [rw] items # A list of the results for the intent classification test. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentClassificationTestResults AWS API Documentation # class IntentClassificationTestResults < Struct.new( :items) SENSITIVE = [] include Aws::Structure end # Provides a statement the Amazon Lex conveys to the user when the # intent is successfully fulfilled. # # @!attribute [rw] closing_response # The response that Amazon Lex sends to the user when the intent is # complete. # @return [Types::ResponseSpecification] # # @!attribute [rw] active # Specifies whether an intent's closing response is used. When this # field is false, the closing response isn't sent to the user. If the # `active` field isn't specified, the default is true. # @return [Boolean] # # @!attribute [rw] next_step # Specifies the next step that the bot executes after playing the # intent's closing response. # @return [Types::DialogState] # # @!attribute [rw] conditional # A list of conditional branches associated with the intent's closing # response. These branches are executed when the `nextStep` attribute # is set to `EvalutateConditional`. # @return [Types::ConditionalSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentClosingSetting AWS API Documentation # class IntentClosingSetting < Struct.new( :closing_response, :active, :next_step, :conditional) SENSITIVE = [] include Aws::Structure end # Provides a prompt for making sure that the user is ready for the # intent to be fulfilled. # # @!attribute [rw] prompt_specification # Prompts the user to confirm the intent. This question should have a # yes or no answer. # # Amazon Lex uses this prompt to ensure that the user acknowledges # that the intent is ready for fulfillment. For example, with the # `OrderPizza` intent, you might want to confirm that the order is # correct before placing it. For other intents, such as intents that # simply respond to user questions, you might not need to ask the user # for confirmation before providing the information. # @return [Types::PromptSpecification] # # @!attribute [rw] declination_response # When the user answers "no" to the question defined in # `promptSpecification`, Amazon Lex responds with this response to # acknowledge that the intent was canceled. # @return [Types::ResponseSpecification] # # @!attribute [rw] active # Specifies whether the intent's confirmation is sent to the user. # When this field is false, confirmation and declination responses # aren't sent. If the `active` field isn't specified, the default is # true. # @return [Boolean] # # @!attribute [rw] confirmation_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] confirmation_next_step # Specifies the next step that the bot executes when the customer # confirms the intent. # @return [Types::DialogState] # # @!attribute [rw] confirmation_conditional # A list of conditional branches to evaluate after the intent is # closed. # @return [Types::ConditionalSpecification] # # @!attribute [rw] declination_next_step # Specifies the next step that the bot executes when the customer # declines the intent. # @return [Types::DialogState] # # @!attribute [rw] declination_conditional # A list of conditional branches to evaluate after the intent is # declined. # @return [Types::ConditionalSpecification] # # @!attribute [rw] failure_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] failure_next_step # The next step to take in the conversation if the confirmation step # fails. # @return [Types::DialogState] # # @!attribute [rw] failure_conditional # Provides a list of conditional branches. Branches are evaluated in # the order that they are entered in the list. The first branch with a # condition that evaluates to true is executed. The last branch in the # list is the default branch. The default branch should not have any # condition expression. The default branch is executed if no other # branch has a matching condition. # @return [Types::ConditionalSpecification] # # @!attribute [rw] code_hook # The `DialogCodeHookInvocationSetting` object associated with # intent's confirmation step. The dialog code hook is triggered based # on these invocation settings when the confirmation next step or # declination next step or failure next step is # `InvokeDialogCodeHook`. # @return [Types::DialogCodeHookInvocationSetting] # # @!attribute [rw] elicitation_code_hook # The `DialogCodeHookInvocationSetting` used when the code hook is # invoked during confirmation prompt retries. # @return [Types::ElicitationCodeHookInvocationSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentConfirmationSetting AWS API Documentation # class IntentConfirmationSetting < Struct.new( :prompt_specification, :declination_response, :active, :confirmation_response, :confirmation_next_step, :confirmation_conditional, :declination_next_step, :declination_conditional, :failure_response, :failure_next_step, :failure_conditional, :code_hook, :elicitation_code_hook) SENSITIVE = [] include Aws::Structure end # Filters the response from the `ListIntents` operation. # # @!attribute [rw] name # The name of the field to use for the filter. # @return [String] # # @!attribute [rw] values # The value to use for the filter. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the # `ListIntents` operation should return only aliases that equal the # specified value. Specify `CO` when the `ListIntents` operation # should return aliases that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentFilter AWS API Documentation # class IntentFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Information about intent-level slot resolution in a test result. # # @!attribute [rw] intent_name # The name of the intent that was recognized. # @return [String] # # @!attribute [rw] multi_turn_conversation # Indicates whether the conversation involves multiple turns or not. # @return [Boolean] # # @!attribute [rw] slot_resolution_results # The results for the slot resolution in the test execution result. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResultItem AWS API Documentation # class IntentLevelSlotResolutionTestResultItem < Struct.new( :intent_name, :multi_turn_conversation, :slot_resolution_results) SENSITIVE = [] include Aws::Structure end # Indicates the success or failure of slots at the intent level. # # @!attribute [rw] items # Indicates the items for the slot level resolution for the intents. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentLevelSlotResolutionTestResults AWS API Documentation # class IntentLevelSlotResolutionTestResults < Struct.new( :items) SENSITIVE = [] include Aws::Structure end # Override settings to configure the intent state. # # @!attribute [rw] name # The name of the intent. Only required when you're switching # intents. # @return [String] # # @!attribute [rw] slots # A map of all of the slot value overrides for the intent. The name of # the slot maps to the value of the slot. Slots that are not included # in the map aren't overridden. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentOverride AWS API Documentation # class IntentOverride < Struct.new( :name, :slots) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of intents. # # @!attribute [rw] attribute # The attribute to use to sort the list of intents. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can choose ascending or descending. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentSortBy AWS API Documentation # class IntentSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # The object that contains the statistical summary of recommended # intents associated with the bot recommendation. # # @!attribute [rw] discovered_intent_count # The number of recommended intents associated with the bot # recommendation. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentStatistics AWS API Documentation # class IntentStatistics < Struct.new( :discovered_intent_count) SENSITIVE = [] include Aws::Structure end # Summary information about an intent returned by the `ListIntents` # operation. # # @!attribute [rw] intent_id # The unique identifier assigned to the intent. Use this ID to get # detailed information about the intent with the `DescribeIntent` # operation. # @return [String] # # @!attribute [rw] intent_name # The name of the intent. # @return [String] # # @!attribute [rw] description # The description of the intent. # @return [String] # # @!attribute [rw] parent_intent_signature # If this intent is derived from a built-in intent, the name of the # parent intent. # @return [String] # # @!attribute [rw] input_contexts # The input contexts that must be active for this intent to be # considered for recognition. # @return [Array] # # @!attribute [rw] output_contexts # The output contexts that are activated when this intent is # fulfilled. # @return [Array] # # @!attribute [rw] last_updated_date_time # The timestamp of the date and time that the intent was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/IntentSummary AWS API Documentation # class IntentSummary < Struct.new( :intent_id, :intent_name, :description, :parent_intent_signature, :input_contexts, :output_contexts, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # The service encountered an unexpected condition. Try your request # again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # An object containing the name of an intent that was invoked. # # @!attribute [rw] intent_name # The name of an intent that was invoked. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/InvokedIntentSample AWS API Documentation # class InvokedIntentSample < Struct.new( :intent_name) SENSITIVE = [] include Aws::Structure end # Provides configuration information for the `AMAZON.KendraSearchIntent` # intent. When you use this intent, Amazon Lex searches the specified # Amazon Kendra index and returns documents from the index that match # the user's utterance. # # @!attribute [rw] kendra_index # The Amazon Resource Name (ARN) of the Amazon Kendra index that you # want the `AMAZON.KendraSearchIntent` intent to search. The index # must be in the same account and Region as the Amazon Lex bot. # @return [String] # # @!attribute [rw] query_filter_string_enabled # Determines whether the `AMAZON.KendraSearchIntent` intent uses a # custom query string to query the Amazon Kendra index. # @return [Boolean] # # @!attribute [rw] query_filter_string # A query filter that Amazon Lex sends to Amazon Kendra to filter the # response from a query. The filter is in the format defined by Amazon # Kendra. For more information, see [Filtering queries][1]. # # # # [1]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/KendraConfiguration AWS API Documentation # class KendraConfiguration < Struct.new( :kendra_index, :query_filter_string_enabled, :query_filter_string) SENSITIVE = [] include Aws::Structure end # Specifies a Lambda function that verifies requests to a bot or # fulfills the user's request to a bot. # # @!attribute [rw] lambda_arn # The Amazon Resource Name (ARN) of the Lambda function. # @return [String] # # @!attribute [rw] code_hook_interface_version # The version of the request-response that you want Amazon Lex to use # to invoke your Lambda function. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/LambdaCodeHook AWS API Documentation # class LambdaCodeHook < Struct.new( :lambda_arn, :code_hook_interface_version) SENSITIVE = [] include Aws::Structure end # The object that contains transcript filter details that are associated # with a bot recommendation. # # @!attribute [rw] date_range_filter # The object that contains a date range filter that will be applied to # the transcript. Specify this object if you want Amazon Lex to only # read the files that are within the date range. # @return [Types::DateRangeFilter] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/LexTranscriptFilter AWS API Documentation # class LexTranscriptFilter < Struct.new( :date_range_filter) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with this request. # @return [String] # # @!attribute [rw] bot_alias_id # The identifier of the bot alias associated with this request. If you # specify the bot alias, you can't specify the bot version. # @return [String] # # @!attribute [rw] bot_version # The identifier of the bot version associated with this request. If # you specify the bot version, you can't specify the bot alias. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where the utterances were # collected. For more information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] aggregation_duration # The time window for aggregating the utterance information. You can # specify a time between one hour and two weeks. # @return [Types::UtteranceAggregationDuration] # # @!attribute [rw] sort_by # Specifies sorting parameters for the list of utterances. You can # sort by the hit count, the missed count, or the number of distinct # sessions the utterance appeared in. # @return [Types::AggregatedUtterancesSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the utterances # in the response to only those that match the filter specification. # You can only specify one filter and one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of utterances to return in each page of results. # If there are fewer results than the maximum page size, only the # actual number of results are returned. If you don't specify the # `maxResults` parameter, 1,000 results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListAggregatedUtterances` operation # contains more results that specified in the `maxResults` parameter, # a token is returned in the response. Use that token in the # `nextToken` parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListAggregatedUtterancesRequest AWS API Documentation # class ListAggregatedUtterancesRequest < Struct.new( :bot_id, :bot_alias_id, :bot_version, :locale_id, :aggregation_duration, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the utterances. # @return [String] # # @!attribute [rw] bot_alias_id # The identifier of the bot alias that contains the utterances. If you # specified the bot version, the bot alias ID isn't returned. # @return [String] # # @!attribute [rw] bot_version # The identifier of the bot version that contains the utterances. If # you specified the bot alias, the bot version isn't returned. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that the utterances are # in. # @return [String] # # @!attribute [rw] aggregation_duration # The time period used to aggregate the utterance data. # @return [Types::UtteranceAggregationDuration] # # @!attribute [rw] aggregation_window_start_time # The date and time that the aggregation window begins. Only data # collected after this time is returned in the results. # @return [Time] # # @!attribute [rw] aggregation_window_end_time # The date and time that the aggregation window ends. Only data # collected between the start time and the end time are returned in # the results. # @return [Time] # # @!attribute [rw] aggregation_last_refreshed_date_time # The last date and time that the aggregated data was collected. The # time period depends on the length of the aggregation window. # # * **Hours** - for 1 hour time window, every half hour; otherwise # every hour. # # * **Days** - every 6 hours # # * **Weeks** - for a one week time window, every 12 hours; otherwise, # every day # @return [Time] # # @!attribute [rw] aggregated_utterances_summaries # Summaries of the aggregated utterance data. Each response contains # information about the number of times that the utterance was seen # during the time period, whether it was detected or missed, and when # it was seen during the time period. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListAggregatedUtterances` operation. If the # `nextToken` field is present, you send the contents as the # `nextToken` parameter of a `ListAggregatedUtterances` operation # request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListAggregatedUtterancesResponse AWS API Documentation # class ListAggregatedUtterancesResponse < Struct.new( :bot_id, :bot_alias_id, :bot_version, :locale_id, :aggregation_duration, :aggregation_window_start_time, :aggregation_window_end_time, :aggregation_last_refreshed_date_time, :aggregated_utterances_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The request for the unique bot ID of the replicated bot created from # the source bot alias. # @return [String] # # @!attribute [rw] replica_region # The request for the secondary region of the replicated bot created # from the source bot alias. # @return [String] # # @!attribute [rw] max_results # The request for maximum results to list the replicated bots created # from the source bot alias. # @return [Integer] # # @!attribute [rw] next_token # The request for the next token for the replicated bot created from # the source bot alias. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasReplicasRequest AWS API Documentation # class ListBotAliasReplicasRequest < Struct.new( :bot_id, :replica_region, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique bot ID of the replicated bot created from the source bot # alias. # @return [String] # # @!attribute [rw] source_region # The source region of the replicated bot created from the source bot # alias. # @return [String] # # @!attribute [rw] replica_region # The secondary region of the replicated bot created from the source # bot alias. # @return [String] # # @!attribute [rw] bot_alias_replica_summaries # The summary information of the replicated bot created from the # source bot alias. # @return [Array] # # @!attribute [rw] next_token # The next token for the replicated bots created from the source bot # alias. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasReplicasResponse AWS API Documentation # class ListBotAliasReplicasResponse < Struct.new( :bot_id, :source_region, :replica_region, :bot_alias_replica_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to list aliases for. # @return [String] # # @!attribute [rw] max_results # The maximum number of aliases to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListBotAliases` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. Use that token in the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasesRequest AWS API Documentation # class ListBotAliasesRequest < Struct.new( :bot_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_summaries # Summary information for the bot aliases that meet the filter # criteria specified in the request. The length of the list is # specified in the `maxResults` parameter of the request. If there are # more aliases available, the `nextToken` field contains a token to # get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBotAliases` operation. If the `nextToken` field # is present, you send the contents as the `nextToken` parameter of a # `ListBotAliases` operation request to get the next page of results. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot associated with the aliases. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotAliasesResponse AWS API Documentation # class ListBotAliasesResponse < Struct.new( :bot_alias_summaries, :next_token, :bot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to list locales for. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to list locales for. # @return [String] # # @!attribute [rw] sort_by # Specifies sorting parameters for the list of locales. You can sort # by locale name in ascending or descending order. # @return [Types::BotLocaleSortBy] # # @!attribute [rw] filters # Provides the specification for a filter used to limit the response # to only those locales that match the filter specification. You can # only specify one filter and one value to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of aliases to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListBotLocales` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. Use that token as the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotLocalesRequest AWS API Documentation # class ListBotLocalesRequest < Struct.new( :bot_id, :bot_version, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to list locales for. # @return [String] # # @!attribute [rw] bot_version # The version of the bot. # @return [String] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBotLocales` operation. If the `nextToken` field # is present, you send the contents as the `nextToken` parameter of a # `ListBotLocales` operation request to get the next page of results. # @return [String] # # @!attribute [rw] bot_locale_summaries # Summary information for the locales that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter of the request. If there are more locales # available, the `nextToken` field contains a token to get the next # page of results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotLocalesResponse AWS API Documentation # class ListBotLocalesResponse < Struct.new( :bot_id, :bot_version, :next_token, :bot_locale_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the bot # recommendation list. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the bot recommendation list. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # list. # @return [String] # # @!attribute [rw] max_results # The maximum number of bot recommendations to return in each page of # results. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListBotRecommendation operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. Use that token in the nextToken parameter # to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotRecommendationsRequest AWS API Documentation # class ListBotRecommendationsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the bot # recommendation list. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the bot recommendation list. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # list. # @return [String] # # @!attribute [rw] bot_recommendation_summaries # Summary information for the bot recommendations that meet the filter # specified in this request. The length of the list is specified in # the maxResults parameter of the request. If there are more bot # recommendations available, the nextToken field contains a token to # get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the ListBotRecommendations operation. If the nextToken # field is present, you send the contents as the nextToken parameter # of a ListBotRecommendations operation request to get the next page # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotRecommendationsResponse AWS API Documentation # class ListBotRecommendationsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The request for the unique bot IDs in the list of replicated bots. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotReplicasRequest AWS API Documentation # class ListBotReplicasRequest < Struct.new( :bot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # the unique bot IDs in the list of replicated bots. # @return [String] # # @!attribute [rw] source_region # The source region of the source bots in the list of replicated bots. # @return [String] # # @!attribute [rw] bot_replica_summaries # The summary details for the replicated bots. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotReplicasResponse AWS API Documentation # class ListBotReplicasResponse < Struct.new( :bot_id, :source_region, :bot_replica_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot whose generation requests you want # to view. # @return [String] # # @!attribute [rw] bot_version # The version of the bot whose generation requests you want to view. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot whose generation requests you want to view. # @return [String] # # @!attribute [rw] sort_by # An object containing information about the attribute and the method # by which to sort the results # @return [Types::GenerationSortBy] # # @!attribute [rw] max_results # The maximum number of results to return in the response. # @return [Integer] # # @!attribute [rw] next_token # If the total number of results is greater than the number specified # in the `maxResults`, the response returns a token in the `nextToken` # field. Use this token when making a request to return the next batch # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotResourceGenerationsRequest AWS API Documentation # class ListBotResourceGenerationsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot for which the generation requests # were made. # @return [String] # # @!attribute [rw] bot_version # The version of the bot for which the generation requests were made. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot for which the generation requests were made. # @return [String] # # @!attribute [rw] generation_summaries # A list of objects, each containing information about a generation # request for the bot locale. # @return [Array] # # @!attribute [rw] next_token # If the total number of results is greater than the number specified # in the `maxResults`, the response returns a token in the `nextToken` # field. Use this token when making a request to return the next batch # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotResourceGenerationsResponse AWS API Documentation # class ListBotResourceGenerationsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :generation_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The request for the unique ID in the list of replicated bots. # @return [String] # # @!attribute [rw] replica_region # The request for the region used in the list of replicated bots. # @return [String] # # @!attribute [rw] max_results # The maximum results given in the list of replicated bots. # @return [Integer] # # @!attribute [rw] next_token # The next token given in the list of replicated bots. # @return [String] # # @!attribute [rw] sort_by # The requested sort category for the list of replicated bots. # @return [Types::BotVersionReplicaSortBy] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionReplicasRequest AWS API Documentation # class ListBotVersionReplicasRequest < Struct.new( :bot_id, :replica_region, :max_results, :next_token, :sort_by) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique ID of the bots in the list of replicated bots. # @return [String] # # @!attribute [rw] source_region # The source region used for the bots in the list of replicated bots. # @return [String] # # @!attribute [rw] replica_region # The region used for the replicated bots in the list of replicated # bots. # @return [String] # # @!attribute [rw] bot_version_replica_summaries # The information summary used for the replicated bots in the list of # replicated bots. # @return [Array] # # @!attribute [rw] next_token # The next token used for the replicated bots in the list of # replicated bots. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionReplicasResponse AWS API Documentation # class ListBotVersionReplicasResponse < Struct.new( :bot_id, :source_region, :replica_region, :bot_version_replica_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to list versions for. # @return [String] # # @!attribute [rw] sort_by # Specifies sorting parameters for the list of versions. You can # specify that the list be sorted by version name in either ascending # or descending order. # @return [Types::BotVersionSortBy] # # @!attribute [rw] max_results # The maximum number of versions to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response to the `ListBotVersion` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. Use that token in the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionsRequest AWS API Documentation # class ListBotVersionsRequest < Struct.new( :bot_id, :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot to list versions for. # @return [String] # # @!attribute [rw] bot_version_summaries # Summary information for the bot versions that meet the filter # criteria specified in the request. The length of the list is # specified in the `maxResults` parameter of the request. If there are # more versions available, the `nextToken` field contains a token to # get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBotVersions` operation. If the `nextToken` # field is present, you send the contents as the `nextToken` parameter # of a `ListBotAliases` operation request to get the next page of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotVersionsResponse AWS API Documentation # class ListBotVersionsResponse < Struct.new( :bot_id, :bot_version_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] sort_by # Specifies sorting parameters for the list of bots. You can specify # that the list be sorted by bot name in ascending or descending # order. # @return [Types::BotSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the bots in the # response to only those that match the filter specification. You can # only specify one filter and one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of bots to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListBots` operation contains more results # than specified in the `maxResults` parameter, a token is returned in # the response. # # Use the returned token in the `nextToken` parameter of a `ListBots` # request to return the next page of results. For a complete set of # results, call the `ListBots` operation until the `nextToken` # returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotsRequest AWS API Documentation # class ListBotsRequest < Struct.new( :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_summaries # Summary information for the bots that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter of the request. If there are more bots # available, the `nextToken` field contains a token to the next page # of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBots` operation. If the `nextToken` field is # present, you send the contents as the `nextToken` parameter of a # `ListBots` operation request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBotsResponse AWS API Documentation # class ListBotsResponse < Struct.new( :bot_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] locale_id # The identifier of the language and locale of the intents to list. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] sort_by # Specifies sorting parameters for the list of built-in intents. You # can specify that the list be sorted by the built-in intent signature # in either ascending or descending order. # @return [Types::BuiltInIntentSortBy] # # @!attribute [rw] max_results # The maximum number of built-in intents to return in each page of # results. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListBuiltInIntents` operation contains # more results than specified in the `maxResults` parameter, a token # is returned in the response. Use that token in the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBuiltInIntentsRequest AWS API Documentation # class ListBuiltInIntentsRequest < Struct.new( :locale_id, :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] built_in_intent_summaries # Summary information for the built-in intents that meet the filter # criteria specified in the request. The length of the list is # specified in the `maxResults` parameter of the request. If there are # more intents available, the `nextToken` field contains a token to # get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBuiltInIntents` operation. If the `nextToken` # field is present, you send the contents as the `nextToken` parameter # of a `ListBotAliases` operation request to get the next page of # results. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the intents in the list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBuiltInIntentsResponse AWS API Documentation # class ListBuiltInIntentsResponse < Struct.new( :built_in_intent_summaries, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] locale_id # The identifier of the language and locale of the slot types to list. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] sort_by # Determines the sort order for the response from the # `ListBuiltInSlotTypes` operation. You can choose to sort by the slot # type signature in either ascending or descending order. # @return [Types::BuiltInSlotTypeSortBy] # # @!attribute [rw] max_results # The maximum number of built-in slot types to return in each page of # results. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListBuiltInSlotTypes` operation contains # more results than specified in the `maxResults` parameter, a token # is returned in the response. Use that token in the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBuiltInSlotTypesRequest AWS API Documentation # class ListBuiltInSlotTypesRequest < Struct.new( :locale_id, :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] built_in_slot_type_summaries # Summary information for the built-in slot types that meet the filter # criteria specified in the request. The length of the list is # specified in the `maxResults` parameter of the request. If there are # more slot types available, the `nextToken` field contains a token to # get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListBuiltInSlotTypes` operation. If the `nextToken` # field is present, you send the contents as the `nextToken` parameter # of a `LIstBuiltInSlotTypes` operation request to get the next page # of results. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the slot types in the list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListBuiltInSlotTypesResponse AWS API Documentation # class ListBuiltInSlotTypesResponse < Struct.new( :built_in_slot_type_summaries, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] bot_version # The bot version of the bot to the list custom vocabulary request. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see Supported languages # (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html). # @return [String] # # @!attribute [rw] max_results # The maximum number of items returned by the list operation. # @return [Integer] # # @!attribute [rw] next_token # The nextToken identifier to the list custom vocabulary request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListCustomVocabularyItemsRequest AWS API Documentation # class ListCustomVocabularyItemsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot associated with this custom vocabulary. # @return [String] # # @!attribute [rw] bot_version # The identifier of the version of the bot associated with this custom # vocabulary. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this custom # vocabulary is used. The string must match one of the supported # locales. For more information, see [ Supported Languages ][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] custom_vocabulary_items # The custom vocabulary items from the list custom vocabulary # response. # @return [Array] # # @!attribute [rw] next_token # The nextToken identifier to the list custom vocabulary response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListCustomVocabularyItemsResponse AWS API Documentation # class ListCustomVocabularyItemsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :custom_vocabulary_items, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier that Amazon Lex assigned to the bot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to list exports for. # @return [String] # # @!attribute [rw] sort_by # Determines the field that the list of exports is sorted by. You can # sort by the `LastUpdatedDateTime` field in ascending or descending # order. # @return [Types::ExportSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the exports in # the response to only those that match the filter specification. You # can only specify one filter and one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of exports to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListExports` operation contains more # results that specified in the `maxResults` parameter, a token is # returned in the response. # # Use the returned token in the `nextToken` parameter of a # `ListExports` request to return the next page of results. For a # complete set of results, call the `ListExports` operation until the # `nextToken` returned in the response is null. # @return [String] # # @!attribute [rw] locale_id # Specifies the resources that should be exported. If you don't # specify a resource type in the `filters` parameter, both bot locales # and custom vocabularies are exported. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListExportsRequest AWS API Documentation # class ListExportsRequest < Struct.new( :bot_id, :bot_version, :sort_by, :filters, :max_results, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier assigned to the bot by Amazon Lex. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that was exported. # @return [String] # # @!attribute [rw] export_summaries # Summary information for the exports that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter. If there are more exports available, the # `nextToken` field contains a token to get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListExports` operation. If the `nextToken` field is # present, you send the contents as the `nextToken` parameter of a # `ListExports` operation request to get the next page of results. # @return [String] # # @!attribute [rw] locale_id # The locale specified in the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListExportsResponse AWS API Documentation # class ListExportsResponse < Struct.new( :bot_id, :bot_version, :export_summaries, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier that Amazon Lex assigned to the bot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot to list imports for. # @return [String] # # @!attribute [rw] sort_by # Determines the field that the list of imports is sorted by. You can # sort by the `LastUpdatedDateTime` field in ascending or descending # order. # @return [Types::ImportSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the bots in the # response to only those that match the filter specification. You can # only specify one filter and one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of imports to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListImports` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. # # Use the returned token in the `nextToken` parameter of a # `ListImports` request to return the next page of results. For a # complete set of results, call the `ListImports` operation until the # `nextToken` returned in the response is null. # @return [String] # # @!attribute [rw] locale_id # Specifies the locale that should be present in the list. If you # don't specify a resource type in the `filters` parameter, the list # contains both bot locales and custom vocabularies. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsRequest AWS API Documentation # class ListImportsRequest < Struct.new( :bot_id, :bot_version, :sort_by, :filters, :max_results, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier assigned by Amazon Lex to the bot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that was imported. It will always be `DRAFT`. # @return [String] # # @!attribute [rw] import_summaries # Summary information for the imports that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter. If there are more imports available, the # `nextToken` field contains a token to get the next page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListImports` operation. If the `nextToken` field is # present, you send the contents as the `nextToken` parameter of a # `ListImports` operation request to get the next page of results. # @return [String] # # @!attribute [rw] locale_id # The locale specified in the request. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListImportsResponse AWS API Documentation # class ListImportsResponse < Struct.new( :bot_id, :bot_version, :import_summaries, :next_token, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve intent # metrics. # @return [String] # # @!attribute [rw] start_date_time # The timestamp that marks the beginning of the range of time for # which you want to see intent metrics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see intent metrics. # @return [Time] # # @!attribute [rw] metrics # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the order by # which to organize the results. # @return [Array] # # @!attribute [rw] bin_by # A list of objects, each of which contains specifications for # organizing the results by time. # @return [Array] # # @!attribute [rw] group_by # A list of objects, each of which specifies how to group the results. # You can group by the following criteria: # # * `IntentName` – The name of the intent. # # * `IntentEndState` – The final state of the intent. The possible end # states are detailed in [Key definitions][1] in the user guide. # # # # [1]: https://docs.aws.amazon.com/analytics-key-definitions-intents # @return [Array] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListIntentMetrics operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListIntentMetrics request to return the next page of results. For a # complete set of results, call the ListIntentMetrics operation until # the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentMetricsRequest AWS API Documentation # class ListIntentMetricsRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :metrics, :bin_by, :group_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you retrieved intent metrics. # @return [String] # # @!attribute [rw] results # The results for the intent metrics. # @return [Array] # # @!attribute [rw] next_token # If the response from the ListIntentMetrics operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListIntentMetrics request to return the next page of results. For a # complete set of results, call the ListIntentMetrics operation until # the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentMetricsResponse AWS API Documentation # class ListIntentMetricsResponse < Struct.new( :bot_id, :results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve intent # path metrics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see intent path metrics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see intent path metrics. # @return [Time] # # @!attribute [rw] intent_path # The intent path for which you want to retrieve metrics. Use a # forward slash to separate intents in the path. For example: # # * /BookCar # # * /BookCar/BookHotel # # * /BookHotel/BookCar # @return [String] # # @!attribute [rw] filters # A list of objects, each describes a condition by which you want to # filter the results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentPathsRequest AWS API Documentation # class ListIntentPathsRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :intent_path, :filters) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] node_summaries # A list of objects, each of which contains information about a node # in the intent path for which you requested metrics. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentPathsResponse AWS API Documentation # class ListIntentPathsResponse < Struct.new( :node_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve intent # stage metrics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see intent stage metrics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see intent stage metrics. # @return [Time] # # @!attribute [rw] metrics # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @!attribute [rw] bin_by # A list of objects, each of which contains specifications for # organizing the results by time. # @return [Array] # # @!attribute [rw] group_by # A list of objects, each of which specifies how to group the results. # You can group by the following criteria: # # * `IntentStageName` – The name of the intent stage. # # * `SwitchedToIntent` – The intent to which the conversation was # switched (if any). # @return [Array] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListIntentStageMetrics operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListIntentStageMetrics request to return the next page of results. # For a complete set of results, call the ListIntentStageMetrics # operation until the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentStageMetricsRequest AWS API Documentation # class ListIntentStageMetricsRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :metrics, :bin_by, :group_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you retrieved intent stage # metrics. # @return [String] # # @!attribute [rw] results # The results for the intent stage metrics. # @return [Array] # # @!attribute [rw] next_token # If the response from the ListIntentStageMetrics operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListIntentStageMetrics request to return the next page of results. # For a complete set of results, call the ListIntentStageMetrics # operation until the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentStageMetricsResponse AWS API Documentation # class ListIntentStageMetricsResponse < Struct.new( :bot_id, :results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the intent. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the intents to list. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] sort_by # Determines the sort order for the response from the `ListIntents` # operation. You can choose to sort by the intent name or last updated # date in either ascending or descending order. # @return [Types::IntentSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the intents in # the response to only those that match the filter specification. You # can only specify one filter and only one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of intents to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListIntents` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. # # Use the returned token in the `nextToken` parameter of a # `ListIntents` request to return the next page of results. For a # complete set of results, call the `ListIntents` operation until the # `nextToken` returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentsRequest AWS API Documentation # class ListIntentsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the intent. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the intents in the list. # @return [String] # # @!attribute [rw] intent_summaries # Summary information for the intents that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter of the request. If there are more intents # available, the `nextToken` field contains a token to get the next # page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListIntents` operation. If the `nextToken` field is # present, you send the contents as the `nextToken` parameter of a # `ListIntents` operation request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListIntentsResponse AWS API Documentation # class ListIntentsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :intent_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with the recommended # intents. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the recommended intents. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the recommended # intents. # @return [String] # # @!attribute [rw] bot_recommendation_id # The identifier of the bot recommendation that contains the # recommended intents. # @return [String] # # @!attribute [rw] next_token # If the response from the ListRecommendedIntents operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. Use that token in the nextToken parameter # to return the next page of results. # @return [String] # # @!attribute [rw] max_results # The maximum number of bot recommendations to return in each page of # results. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntentsRequest AWS API Documentation # class ListRecommendedIntentsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with the recommended # intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the intent. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the intents to list. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The identifier of the bot recommendation that contains the # recommended intent. # @return [String] # # @!attribute [rw] summary_list # Summary information for the intents that meet the filter criteria # specified in the request. The length of the list is specified in the # maxResults parameter of the request. If there are more intents # available, the nextToken field contains a token to get the next page # of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the ListRecommendedIntents operation. If the nextToken # field is present, you send the contents as the nextToken parameter # of a ListRecommendedIntents operation request to get the next page # of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListRecommendedIntentsResponse AWS API Documentation # class ListRecommendedIntentsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id, :summary_list, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve session # analytics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see session analytics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see session analytics. # @return [Time] # # @!attribute [rw] sort_by # An object specifying the measure and method by which to sort the # session analytics data. # @return [Types::SessionDataSortBy] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListSessionAnalyticsData operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListSessionAnalyticsData request to return the next page of results. # For a complete set of results, call the ListSessionAnalyticsData # operation until the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionAnalyticsDataRequest AWS API Documentation # class ListSessionAnalyticsDataRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that the sessions belong to. # @return [String] # # @!attribute [rw] next_token # If the response from the ListSessionAnalyticsData operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListSessionAnalyticsData request to return the next page of results. # For a complete set of results, call the ListSessionAnalyticsData # operation until the nextToken returned in the response is null. # @return [String] # # @!attribute [rw] sessions # A list of objects, each of which contains information about a # session with the bot. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionAnalyticsDataResponse AWS API Documentation # class ListSessionAnalyticsDataResponse < Struct.new( :bot_id, :next_token, :sessions) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve session # metrics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see session metrics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see session metrics. # @return [Time] # # @!attribute [rw] metrics # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @!attribute [rw] bin_by # A list of objects, each of which contains specifications for # organizing the results by time. # @return [Array] # # @!attribute [rw] group_by # A list of objects, each of which specifies how to group the results. # You can group by the following criteria: # # * `ConversationEndState` – The final state of the conversation. The # possible end states are detailed in [Key definitions][1] in the # user guide. # # * `LocaleId` – The unique identifier of the bot locale. # # # # [1]: https://docs.aws.amazon.com/analytics-key-definitions-conversations # @return [Array] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListSessionMetrics operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListSessionMetrics request to return the next page of results. For a # complete set of results, call the ListSessionMetrics operation until # the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionMetricsRequest AWS API Documentation # class ListSessionMetricsRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :metrics, :bin_by, :group_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you retrieved session metrics. # @return [String] # # @!attribute [rw] results # The results for the session metrics. # @return [Array] # # @!attribute [rw] next_token # If the response from the ListSessionMetrics operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListSessionMetrics request to return the next page of results. For a # complete set of results, call the ListSessionMetrics operation until # the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSessionMetricsResponse AWS API Documentation # class ListSessionMetricsResponse < Struct.new( :bot_id, :results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the slot types. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot type. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the slot types to list. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] sort_by # Determines the sort order for the response from the `ListSlotTypes` # operation. You can choose to sort by the slot type name or last # updated date in either ascending or descending order. # @return [Types::SlotTypeSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the slot types # in the response to only those that match the filter specification. # You can only specify one filter and only one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of slot types to return in each page of results. # If there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListSlotTypes` operation contains more # results than specified in the `maxResults` parameter, a token is # returned in the response. Use that token in the `nextToken` # parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotTypesRequest AWS API Documentation # class ListSlotTypesRequest < Struct.new( :bot_id, :bot_version, :locale_id, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the slot types. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot types. # @return [String] # # @!attribute [rw] locale_id # The language and local of the slot types in the list. # @return [String] # # @!attribute [rw] slot_type_summaries # Summary information for the slot types that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter of the request. If there are more slot types # available, the `nextToken` field contains a token to get the next # page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListSlotTypes` operation. If the `nextToken` field # is present, you send the contents as the `nextToken` parameter of a # `ListSlotTypes` operation request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotTypesResponse AWS API Documentation # class ListSlotTypesResponse < Struct.new( :bot_id, :bot_version, :locale_id, :slot_type_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the slots to list. The # string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] intent_id # The unique identifier of the intent that contains the slot. # @return [String] # # @!attribute [rw] sort_by # Determines the sort order for the response from the `ListSlots` # operation. You can choose to sort by the slot name or last updated # date in either ascending or descending order. # @return [Types::SlotSortBy] # # @!attribute [rw] filters # Provides the specification of a filter used to limit the slots in # the response to only those that match the filter specification. You # can only specify one filter and only one string to filter on. # @return [Array] # # @!attribute [rw] max_results # The maximum number of slots to return in each page of results. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListSlots` operation contains more results # than specified in the `maxResults` parameter, a token is returned in # the response. Use that token in the `nextToken` parameter to return # the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotsRequest AWS API Documentation # class ListSlotsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :intent_id, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the slots. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slots. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the slots in the list. # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent that contains the slots. # @return [String] # # @!attribute [rw] slot_summaries # Summary information for the slots that meet the filter criteria # specified in the request. The length of the list is specified in the # `maxResults` parameter of the request. If there are more slots # available, the `nextToken` field contains a token to get the next # page of results. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListSlots` operation. If the `nextToken` field is # present, you send the contents as the `nextToken` parameter of a # `ListSlots` operation request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListSlotsResponse AWS API Documentation # class ListSlotsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :intent_id, :slot_summaries, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to get a list of tags # for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tags # The tags associated with a resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The unique identifier of the test execution to list the result # items. # @return [String] # # @!attribute [rw] result_filter_by # The filter for the list of results from the test set execution. # @return [Types::TestExecutionResultFilterBy] # # @!attribute [rw] max_results # The maximum number of test execution result items to return in each # page. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the `ListTestExecutionResultItems` operation # contains more results than specified in the `maxResults` parameter, # a token is returned in the response. Use that token in the # `nextToken` parameter to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestExecutionResultItemsRequest AWS API Documentation # class ListTestExecutionResultItemsRequest < Struct.new( :test_execution_id, :result_filter_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_results # The list of results from the test execution. # @return [Types::TestExecutionResultItems] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the `ListTestExecutionResultItems` operation. If the # `nextToken` field is present, you send the contents as the # `nextToken` parameter of a `ListTestExecutionResultItems` operation # request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestExecutionResultItemsResponse AWS API Documentation # class ListTestExecutionResultItemsResponse < Struct.new( :test_execution_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] sort_by # The sort order of the test set executions. # @return [Types::TestExecutionSortBy] # # @!attribute [rw] max_results # The maximum number of test executions to return in each page. If # there are fewer results than the max page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListTestExecutions operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. Use that token in the nextToken parameter # to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestExecutionsRequest AWS API Documentation # class ListTestExecutionsRequest < Struct.new( :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_executions # The list of test executions. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the ListTestExecutions operation. If the nextToken field # is present, you send the contents as the nextToken parameter of a # ListTestExecutions operation request to get the next page of # results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestExecutionsResponse AWS API Documentation # class ListTestExecutionsResponse < Struct.new( :test_executions, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The identifier of the test set to list its test set records. # @return [String] # # @!attribute [rw] max_results # The maximum number of test set records to return in each page. If # there are fewer records than the max page size, only the actual # number of records are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListTestSetRecords operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. Use that token in the nextToken parameter # to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetRecordsRequest AWS API Documentation # class ListTestSetRecordsRequest < Struct.new( :test_set_id, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_records # The list of records from the test set. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more records to return in a # response to the ListTestSetRecords operation. If the nextToken field # is present, you send the contents as the nextToken parameter of a # ListTestSetRecords operation request to get the next page of # records. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetRecordsResponse AWS API Documentation # class ListTestSetRecordsResponse < Struct.new( :test_set_records, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] sort_by # The sort order for the list of test sets. # @return [Types::TestSetSortBy] # # @!attribute [rw] max_results # The maximum number of test sets to return in each page. If there are # fewer results than the max page size, only the actual number of # results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListTestSets operation contains more # results than specified in the maxResults parameter, a token is # returned in the response. Use that token in the nextToken parameter # to return the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsRequest AWS API Documentation # class ListTestSetsRequest < Struct.new( :sort_by, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_sets # The selected test sets in a list of test sets. # @return [Array] # # @!attribute [rw] next_token # A token that indicates whether there are more results to return in a # response to the ListTestSets operation. If the nextToken field is # present, you send the contents as the nextToken parameter of a # ListTestSets operation request to get the next page of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListTestSetsResponse AWS API Documentation # class ListTestSetsResponse < Struct.new( :test_sets, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve utterance # analytics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see utterance analytics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see utterance analytics. # @return [Time] # # @!attribute [rw] sort_by # An object specifying the measure and method by which to sort the # utterance analytics data. # @return [Types::UtteranceDataSortBy] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListUtteranceAnalyticsData operation # contains more results than specified in the maxResults parameter, a # token is returned in the response. # # Use the returned token in the nextToken parameter of a # ListUtteranceAnalyticsData request to return the next page of # results. For a complete set of results, call the # ListUtteranceAnalyticsData operation until the nextToken returned in # the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceAnalyticsDataRequest AWS API Documentation # class ListUtteranceAnalyticsDataRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :sort_by, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that the utterances belong to. # @return [String] # # @!attribute [rw] next_token # If the response from the ListUtteranceAnalyticsData operation # contains more results than specified in the maxResults parameter, a # token is returned in the response. # # Use the returned token in the nextToken parameter of a # ListUtteranceAnalyticsData request to return the next page of # results. For a complete set of results, call the # ListUtteranceAnalyticsData operation until the nextToken returned in # the response is null. # @return [String] # # @!attribute [rw] utterances # A list of objects, each of which contains information about an # utterance in a user session with your bot. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceAnalyticsDataResponse AWS API Documentation # class ListUtteranceAnalyticsDataResponse < Struct.new( :bot_id, :next_token, :utterances) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you want to retrieve utterance # metrics. # @return [String] # # @!attribute [rw] start_date_time # The date and time that marks the beginning of the range of time for # which you want to see utterance metrics. # @return [Time] # # @!attribute [rw] end_date_time # The date and time that marks the end of the range of time for which # you want to see utterance metrics. # @return [Time] # # @!attribute [rw] metrics # A list of objects, each of which contains a metric you want to list, # the statistic for the metric you want to return, and the method by # which to organize the results. # @return [Array] # # @!attribute [rw] bin_by # A list of objects, each of which contains specifications for # organizing the results by time. # @return [Array] # # @!attribute [rw] group_by # A list of objects, each of which specifies how to group the results. # You can group by the following criteria: # # * `UtteranceText` – The transcription of the utterance. # # * `UtteranceState` – The state of the utterance. The possible states # are detailed in [Key definitions][1] in the user guide. # # # # [1]: https://docs.aws.amazon.com/analytics-key-definitions-utterances # @return [Array] # # @!attribute [rw] attributes # A list containing attributes related to the utterance that you want # the response to return. The following attributes are possible: # # * `LastUsedIntent` – The last used intent at the time of the # utterance. # # ^ # @return [Array] # # @!attribute [rw] filters # A list of objects, each of which describes a condition by which you # want to filter the results. # @return [Array] # # @!attribute [rw] max_results # The maximum number of results to return in each page of results. If # there are fewer results than the maximum page size, only the actual # number of results are returned. # @return [Integer] # # @!attribute [rw] next_token # If the response from the ListUtteranceMetrics operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListUtteranceMetrics request to return the next page of results. For # a complete set of results, call the ListUtteranceMetrics operation # until the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceMetricsRequest AWS API Documentation # class ListUtteranceMetricsRequest < Struct.new( :bot_id, :start_date_time, :end_date_time, :metrics, :bin_by, :group_by, :attributes, :filters, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier for the bot for which you retrieved utterance # metrics. # @return [String] # # @!attribute [rw] results # The results for the utterance metrics. # @return [Array] # # @!attribute [rw] next_token # If the response from the ListUtteranceMetrics operation contains # more results than specified in the maxResults parameter, a token is # returned in the response. # # Use the returned token in the nextToken parameter of a # ListUtteranceMetrics request to return the next page of results. For # a complete set of results, call the ListUtteranceMetrics operation # until the nextToken returned in the response is null. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ListUtteranceMetricsResponse AWS API Documentation # class ListUtteranceMetricsResponse < Struct.new( :bot_id, :results, :next_token) SENSITIVE = [] include Aws::Structure end # The object that provides message text and its type. # # @!attribute [rw] plain_text_message # A message in plain text format. # @return [Types::PlainTextMessage] # # @!attribute [rw] custom_payload # A message in a custom format defined by the client application. # @return [Types::CustomPayload] # # @!attribute [rw] ssml_message # A message in Speech Synthesis Markup Language (SSML). # @return [Types::SSMLMessage] # # @!attribute [rw] image_response_card # A message that defines a response card that the client application # can show to the user. # @return [Types::ImageResponseCard] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Message AWS API Documentation # class Message < Struct.new( :plain_text_message, :custom_payload, :ssml_message, :image_response_card) SENSITIVE = [] include Aws::Structure end # Provides one or more messages that Amazon Lex should send to the user. # # @!attribute [rw] message # The primary message that Amazon Lex should send to the user. # @return [Types::Message] # # @!attribute [rw] variations # Message variations to send to the user. When variations are defined, # Amazon Lex chooses the primary message or one of the variations to # send to the user. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/MessageGroup AWS API Documentation # class MessageGroup < Struct.new( :message, :variations) SENSITIVE = [] include Aws::Structure end # Indicates whether a slot can return multiple values. # # @!attribute [rw] allow_multiple_values # Indicates whether a slot can return multiple values. When `true`, # the slot may return more than one value in a response. When `false`, # the slot returns only a single value. # # Multi-value slots are only available in the en-US locale. If you set # this value to `true` in any other locale, Amazon Lex throws a # `ValidationException`. # # If the `allowMutlipleValues` is not set, the default value is # `false`. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/MultipleValuesSetting AWS API Documentation # class MultipleValuesSetting < Struct.new( :allow_multiple_values) SENSITIVE = [] include Aws::Structure end # The new custom vocabulary item from the custom vocabulary list. # # @!attribute [rw] phrase # The unique phrase for the new custom vocabulary item from the custom # vocabulary list. # @return [String] # # @!attribute [rw] weight # The weight assigned to the new custom vocabulary item from the # custom vocabulary list. # @return [Integer] # # @!attribute [rw] display_as # The display as value assigned to the new custom vocabulary item from # the custom vocabulary list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/NewCustomVocabularyItem AWS API Documentation # class NewCustomVocabularyItem < Struct.new( :phrase, :weight, :display_as) SENSITIVE = [] include Aws::Structure end # Determines whether Amazon Lex obscures slot values in conversation # logs. # # @!attribute [rw] obfuscation_setting_type # Value that determines whether Amazon Lex obscures slot values in # conversation logs. The default is to obscure the values. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ObfuscationSetting AWS API Documentation # class ObfuscationSetting < Struct.new( :obfuscation_setting_type) SENSITIVE = [] include Aws::Structure end # Contains details about the configuration of the Amazon OpenSearch # Service database used for the `AMAZON.QnAIntent`. # # @!attribute [rw] domain_endpoint # The endpoint of the Amazon OpenSearch Service domain. # @return [String] # # @!attribute [rw] index_name # The name of the Amazon OpenSearch Service index. # @return [String] # # @!attribute [rw] exact_response # Specifies whether to return an exact response or to return an answer # generated by the model using the fields you specify from the # database. # @return [Boolean] # # @!attribute [rw] exact_response_fields # Contains the names of the fields used for an exact response to the # user. # @return [Types::ExactResponseFields] # # @!attribute [rw] include_fields # Contains a list of fields from the Amazon OpenSearch Service that # the model can use to generate the answer to the query. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/OpensearchConfiguration AWS API Documentation # class OpensearchConfiguration < Struct.new( :domain_endpoint, :index_name, :exact_response, :exact_response_fields, :include_fields) SENSITIVE = [] include Aws::Structure end # Describes a session context that is activated when an intent is # fulfilled. # # @!attribute [rw] name # The name of the output context. # @return [String] # # @!attribute [rw] time_to_live_in_seconds # The amount of time, in seconds, that the output context should # remain active. The time is figured from the first time the context # is sent to the user. # @return [Integer] # # @!attribute [rw] turns_to_live # The number of conversation turns that the output context should # remain active. The number of turns is counted from the first time # that the context is sent to the user. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/OutputContext AWS API Documentation # class OutputContext < Struct.new( :name, :time_to_live_in_seconds, :turns_to_live) SENSITIVE = [] include Aws::Structure end # Information about the overall results for a test execution result. # # @!attribute [rw] multi_turn_conversation # Indicates whether the conversation contains multiple turns or not. # @return [Boolean] # # @!attribute [rw] total_result_count # The total number of overall results in the result of the test # execution. # @return [Integer] # # @!attribute [rw] speech_transcription_result_counts # The number of speech transcription results in the overall test. # @return [Hash] # # @!attribute [rw] end_to_end_result_counts # The number of results that succeeded. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/OverallTestResultItem AWS API Documentation # class OverallTestResultItem < Struct.new( :multi_turn_conversation, :total_result_count, :speech_transcription_result_counts, :end_to_end_result_counts) SENSITIVE = [] include Aws::Structure end # Information about the overall test results. # # @!attribute [rw] items # A list of the overall test results. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/OverallTestResults AWS API Documentation # class OverallTestResults < Struct.new( :items) SENSITIVE = [] include Aws::Structure end # A network of bots. # # @!attribute [rw] bot_id # The identifier of the network of bots assigned by Amazon Lex. # @return [String] # # @!attribute [rw] bot_version # The version of the network of bots. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ParentBotNetwork AWS API Documentation # class ParentBotNetwork < Struct.new( :bot_id, :bot_version) SENSITIVE = [] include Aws::Structure end # The object that contains a path format that will be applied when # Amazon Lex reads the transcript file in the bucket you provide. # Specify this object if you only want Lex to read a subset of files in # your Amazon S3 bucket. # # @!attribute [rw] object_prefixes # A list of Amazon S3 prefixes that points to sub-folders in the # Amazon S3 bucket. Specify this list if you only want Lex to read the # files under this set of sub-folders. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PathFormat AWS API Documentation # class PathFormat < Struct.new( :object_prefixes) SENSITIVE = [] include Aws::Structure end # Defines an ASCII text message to send to the user. # # @!attribute [rw] value # The message to send to the user. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PlainTextMessage AWS API Documentation # class PlainTextMessage < Struct.new( :value) SENSITIVE = [] include Aws::Structure end # Specifies next steps to run after the dialog code hook finishes. # # @!attribute [rw] success_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] success_next_step # Specifics the next step the bot runs after the dialog code hook # finishes successfully. # @return [Types::DialogState] # # @!attribute [rw] success_conditional # A list of conditional branches to evaluate after the dialog code # hook finishes successfully. # @return [Types::ConditionalSpecification] # # @!attribute [rw] failure_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] failure_next_step # Specifies the next step the bot runs after the dialog code hook # throws an exception or returns with the `State` field of the # `Intent` object set to `Failed`. # @return [Types::DialogState] # # @!attribute [rw] failure_conditional # A list of conditional branches to evaluate after the dialog code # hook throws an exception or returns with the `State` field of the # `Intent` object set to `Failed`. # @return [Types::ConditionalSpecification] # # @!attribute [rw] timeout_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] timeout_next_step # Specifies the next step that the bot runs when the code hook times # out. # @return [Types::DialogState] # # @!attribute [rw] timeout_conditional # A list of conditional branches to evaluate if the code hook times # out. # @return [Types::ConditionalSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PostDialogCodeHookInvocationSpecification AWS API Documentation # class PostDialogCodeHookInvocationSpecification < Struct.new( :success_response, :success_next_step, :success_conditional, :failure_response, :failure_next_step, :failure_conditional, :timeout_response, :timeout_next_step, :timeout_conditional) SENSITIVE = [] include Aws::Structure end # Provides a setting that determines whether the post-fulfillment # response is sent to the user. For more information, see # [https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete # # @!attribute [rw] success_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] failure_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] timeout_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] success_next_step # Specifies the next step in the conversation that Amazon Lex invokes # when the fulfillment code hook completes successfully. # @return [Types::DialogState] # # @!attribute [rw] success_conditional # A list of conditional branches to evaluate after the fulfillment # code hook finishes successfully. # @return [Types::ConditionalSpecification] # # @!attribute [rw] failure_next_step # Specifies the next step the bot runs after the fulfillment code hook # throws an exception or returns with the `State` field of the # `Intent` object set to `Failed`. # @return [Types::DialogState] # # @!attribute [rw] failure_conditional # A list of conditional branches to evaluate after the fulfillment # code hook throws an exception or returns with the `State` field of # the `Intent` object set to `Failed`. # @return [Types::ConditionalSpecification] # # @!attribute [rw] timeout_next_step # Specifies the next step that the bot runs when the fulfillment code # hook times out. # @return [Types::DialogState] # # @!attribute [rw] timeout_conditional # A list of conditional branches to evaluate if the fulfillment code # hook times out. # @return [Types::ConditionalSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PostFulfillmentStatusSpecification AWS API Documentation # class PostFulfillmentStatusSpecification < Struct.new( :success_response, :failure_response, :timeout_response, :success_next_step, :success_conditional, :failure_next_step, :failure_conditional, :timeout_next_step, :timeout_conditional) SENSITIVE = [] include Aws::Structure end # Your request couldn't be completed because one or more request fields # aren't valid. Check the fields in your request and try again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PreconditionFailedException AWS API Documentation # class PreconditionFailedException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The IAM principal that you allowing or denying access to an Amazon Lex # action. You must provide a `service` or an `arn`, but not both in the # same statement. For more information, see [ AWS JSON policy elements: # Principal ][1]. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html # # @!attribute [rw] service # The name of the Amazon Web Services service that should allowed or # denied access to an Amazon Lex action. # @return [String] # # @!attribute [rw] arn # The Amazon Resource Name (ARN) of the principal. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Principal AWS API Documentation # class Principal < Struct.new( :service, :arn) SENSITIVE = [] include Aws::Structure end # Specifies the settings on a prompt attempt. # # @!attribute [rw] allow_interrupt # Indicates whether the user can interrupt a speech prompt attempt # from the bot. # @return [Boolean] # # @!attribute [rw] allowed_input_types # Indicates the allowed input types of the prompt attempt. # @return [Types::AllowedInputTypes] # # @!attribute [rw] audio_and_dtmf_input_specification # Specifies the settings on audio and DTMF input. # @return [Types::AudioAndDTMFInputSpecification] # # @!attribute [rw] text_input_specification # Specifies the settings on text input. # @return [Types::TextInputSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PromptAttemptSpecification AWS API Documentation # class PromptAttemptSpecification < Struct.new( :allow_interrupt, :allowed_input_types, :audio_and_dtmf_input_specification, :text_input_specification) SENSITIVE = [] include Aws::Structure end # Specifies a list of message groups that Amazon Lex sends to a user to # elicit a response. # # @!attribute [rw] message_groups # A collection of messages that Amazon Lex can send to the user. # Amazon Lex chooses the actual message to send at runtime. # @return [Array] # # @!attribute [rw] max_retries # The maximum number of times the bot tries to elicit a response from # the user using this prompt. # @return [Integer] # # @!attribute [rw] allow_interrupt # Indicates whether the user can interrupt a speech prompt from the # bot. # @return [Boolean] # # @!attribute [rw] message_selection_strategy # Indicates how a message is selected from a message group among # retries. # @return [String] # # @!attribute [rw] prompt_attempts_specification # Specifies the advanced settings on each attempt of the prompt. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/PromptSpecification AWS API Documentation # class PromptSpecification < Struct.new( :message_groups, :max_retries, :allow_interrupt, :message_selection_strategy, :prompt_attempts_specification) SENSITIVE = [] include Aws::Structure end # Details about the the configuration of the built-in # `Amazon.QnAIntent`. # # @!attribute [rw] data_source_configuration # Contains details about the configuration of the data source used for # the `AMAZON.QnAIntent`. # @return [Types::DataSourceConfiguration] # # @!attribute [rw] bedrock_model_configuration # Contains information about the Amazon Bedrock model used to # interpret the prompt used in descriptive bot building. # @return [Types::BedrockModelSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/QnAIntentConfiguration AWS API Documentation # class QnAIntentConfiguration < Struct.new( :data_source_configuration, :bedrock_model_configuration) SENSITIVE = [] include Aws::Structure end # Contains details about the configuration of the Amazon Kendra index # used for the `AMAZON.QnAIntent`. # # @!attribute [rw] kendra_index # The ARN of the Amazon Kendra index to use. # @return [String] # # @!attribute [rw] query_filter_string_enabled # Specifies whether to enable an Amazon Kendra filter string or not. # @return [Boolean] # # @!attribute [rw] query_filter_string # Contains the Amazon Kendra filter string to use if enabled. For more # information on the Amazon Kendra search filter JSON format, see # [Using document attributes to filter search results][1]. # # # # [1]: https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering # @return [String] # # @!attribute [rw] exact_response # Specifies whether to return an exact response from the Amazon Kendra # index or to let the Amazon Bedrock model you select generate a # response based on the results. To use this feature, you must first # add FAQ questions to your index by following the steps at [Adding # frequently asked questions (FAQs) to an index][1]. # # # # [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/QnAKendraConfiguration AWS API Documentation # class QnAKendraConfiguration < Struct.new( :kendra_index, :query_filter_string_enabled, :query_filter_string, :exact_response) SENSITIVE = [] include Aws::Structure end # An object that contains a summary of a recommended intent. # # @!attribute [rw] intent_id # The unique identifier of a recommended intent associated with the # bot recommendation. # @return [String] # # @!attribute [rw] intent_name # The name of a recommended intent associated with the bot # recommendation. # @return [String] # # @!attribute [rw] sample_utterances_count # The count of sample utterances of a recommended intent that is # associated with a bot recommendation. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RecommendedIntentSummary AWS API Documentation # class RecommendedIntentSummary < Struct.new( :intent_id, :intent_name, :sample_utterances_count) SENSITIVE = [] include Aws::Structure end # Specifies the time window that utterance statistics are returned for. # The time window is always relative to the last time that the that # utterances were aggregated. For example, if the # `ListAggregatedUtterances` operation is called at 1600, the time # window is set to 1 hour, and the last refresh time was 1530, only # utterances made between 1430 and 1530 are returned. # # You can choose the time window that statistics should be returned for. # # * **Hours** - You can request utterance statistics for 1, 3, 6, 12, or # 24 hour time windows. Statistics are refreshed every half hour for 1 # hour time windows, and hourly for the other time windows. # # * **Days** - You can request utterance statistics for 3 days. # Statistics are refreshed every 6 hours. # # * **Weeks** - You can see statistics for one or two weeks. Statistics # are refreshed every 12 hours for one week time windows, and once per # day for two week time windows. # # @!attribute [rw] time_dimension # The type of time period that the `timeValue` field represents. # @return [String] # # @!attribute [rw] time_value # The period of the time window to gather statistics for. The valid # value depends on the setting of the `timeDimension` field. # # * `Hours` - 1/3/6/12/24 # # * `Days` - 3 # # * `Weeks` - 1/2 # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RelativeAggregationDuration AWS API Documentation # class RelativeAggregationDuration < Struct.new( :time_dimension, :time_value) SENSITIVE = [] include Aws::Structure end # You asked to describe a resource that doesn't exist. Check the # resource that you are requesting and try again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Specifies a list of message groups that Amazon Lex uses to respond the # user input. # # @!attribute [rw] message_groups # A collection of responses that Amazon Lex can send to the user. # Amazon Lex chooses the actual response to send at runtime. # @return [Array] # # @!attribute [rw] allow_interrupt # Indicates whether the user can interrupt a speech response from # Amazon Lex. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ResponseSpecification AWS API Documentation # class ResponseSpecification < Struct.new( :message_groups, :allow_interrupt) SENSITIVE = [] include Aws::Structure end # Provides an array of phrases that should be given preference when # resolving values for a slot. # # @!attribute [rw] runtime_hint_values # One or more strings that Amazon Lex should look for in the input to # the bot. Each phrase is given preference when deciding on slot # values. # @return [Array] # # @!attribute [rw] sub_slot_hints # A map of constituent sub slot names inside a composite slot in the # intent and the phrases that should be added for each sub slot. # Inside each composite slot hints, this structure provides a # mechanism to add granular sub slot phrases. Only sub slot hints are # supported for composite slots. The intent name, composite slot name # and the constituent sub slot names must exist. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RuntimeHintDetails AWS API Documentation # class RuntimeHintDetails < Struct.new( :runtime_hint_values, :sub_slot_hints) SENSITIVE = [] include Aws::Structure end # Provides the phrase that Amazon Lex should look for in the user's # input to the bot. # # @!attribute [rw] phrase # The phrase that Amazon Lex should look for in the user's input to # the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RuntimeHintValue AWS API Documentation # class RuntimeHintValue < Struct.new( :phrase) SENSITIVE = [] include Aws::Structure end # You can provide Amazon Lex with hints to the phrases that a customer # is likely to use for a slot. When a slot with hints is resolved, the # phrases in the runtime hints are preferred in the resolution. You can # provide hints for a maximum of 100 intents. You can provide a maximum # of 100 slots. # # Before you can use runtime hints with an existing bot, you must first # rebuild the bot. # # For more information, see [Using runtime hints to improve recognition # of slot values][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html # # @!attribute [rw] slot_hints # A list of the slots in the intent that should have runtime hints # added, and the phrases that should be added for each slot. # # The first level of the `slotHints` map is the name of the intent. # The second level is the name of the slot within the intent. For more # information, see [Using hints to improve accuracy][1]. # # The intent name and slot name must exist. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html # @return [Hash>] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RuntimeHints AWS API Documentation # class RuntimeHints < Struct.new( :slot_hints) SENSITIVE = [] include Aws::Structure end # Contains specifications about the Amazon Lex runtime generative AI # capabilities from Amazon Bedrock that you can turn on for your bot. # # @!attribute [rw] slot_resolution_improvement # An object containing specifications for the assisted slot resolution # feature. # @return [Types::SlotResolutionImprovementSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/RuntimeSettings AWS API Documentation # class RuntimeSettings < Struct.new( :slot_resolution_improvement) SENSITIVE = [] include Aws::Structure end # Specifies an Amazon S3 bucket for logging audio conversations # # @!attribute [rw] kms_key_arn # The Amazon Resource Name (ARN) of an Amazon Web Services Key # Management Service (KMS) key for encrypting audio log files stored # in an S3 bucket. # @return [String] # # @!attribute [rw] s3_bucket_arn # The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio # log files are stored. # @return [String] # # @!attribute [rw] log_prefix # The S3 prefix to assign to audio log files. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/S3BucketLogDestination AWS API Documentation # class S3BucketLogDestination < Struct.new( :kms_key_arn, :s3_bucket_arn, :log_prefix) SENSITIVE = [] include Aws::Structure end # The object representing the Amazon S3 bucket containing the # transcript, as well as the associated metadata. # # @!attribute [rw] s3_bucket_name # The name of the bucket containing the transcript and the associated # metadata. # @return [String] # # @!attribute [rw] path_format # The object that contains a path format that will be applied when # Amazon Lex reads the transcript file in the bucket you provide. # Specify this object if you only want Lex to read a subset of files # in your Amazon S3 bucket. # @return [Types::PathFormat] # # @!attribute [rw] transcript_format # The format of the transcript content. Currently, Genie only supports # the Amazon Lex transcript format. # @return [String] # # @!attribute [rw] transcript_filter # The object that contains the filter which will be applied when # Amazon Lex reads through the Amazon S3 bucket. Specify this object # if you want Amazon Lex to read only a subset of the Amazon S3 bucket # based on the filter you provide. # @return [Types::TranscriptFilter] # # @!attribute [rw] kms_key_arn # The ARN of the KMS key that customer use to encrypt their Amazon S3 # bucket. Only use this field if your bucket is encrypted using a # customer managed KMS key. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/S3BucketTranscriptSource AWS API Documentation # class S3BucketTranscriptSource < Struct.new( :s3_bucket_name, :path_format, :transcript_format, :transcript_filter, :kms_key_arn) SENSITIVE = [] include Aws::Structure end # Defines a Speech Synthesis Markup Language (SSML) prompt. # # @!attribute [rw] value # The SSML text that defines the prompt. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SSMLMessage AWS API Documentation # class SSMLMessage < Struct.new( :value) SENSITIVE = [] include Aws::Structure end # A sample utterance that invokes an intent or respond to a slot # elicitation prompt. # # @!attribute [rw] utterance # The sample utterance that Amazon Lex uses to build its # machine-learning model to recognize intents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SampleUtterance AWS API Documentation # class SampleUtterance < Struct.new( :utterance) SENSITIVE = [] include Aws::Structure end # Contains specifications for the sample utterance generation feature. # # @!attribute [rw] enabled # Specifies whether to enable sample utterance generation or not. # @return [Boolean] # # @!attribute [rw] bedrock_model_specification # Contains information about the Amazon Bedrock model used to # interpret the prompt used in descriptive bot building. # @return [Types::BedrockModelSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SampleUtteranceGenerationSpecification AWS API Documentation # class SampleUtteranceGenerationSpecification < Struct.new( :enabled, :bedrock_model_specification) SENSITIVE = [] include Aws::Structure end # Defines one of the values for a slot type. # # @!attribute [rw] value # The value that can be used for a slot type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SampleValue AWS API Documentation # class SampleValue < Struct.new( :value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with the transcripts # that you are searching. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the transcripts that you are # searching. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the transcripts to # search. The string must match one of the supported locales. For more # information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation associated with the # transcripts to search. # @return [String] # # @!attribute [rw] search_order # How SearchResults are ordered. Valid values are Ascending or # Descending. The default is Descending. # @return [String] # # @!attribute [rw] filters # A list of filter objects. # @return [Array] # # @!attribute [rw] max_results # The maximum number of bot recommendations to return in each page of # results. If there are fewer results than the max page size, only the # actual number of results are returned. # @return [Integer] # # @!attribute [rw] next_index # If the response from the SearchAssociatedTranscriptsRequest # operation contains more results than specified in the maxResults # parameter, an index is returned in the response. Use that index in # the nextIndex parameter to return the next page of results. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SearchAssociatedTranscriptsRequest AWS API Documentation # class SearchAssociatedTranscriptsRequest < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id, :search_order, :filters, :max_results, :next_index) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot associated with the transcripts # that you are searching. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the transcripts that you are # searching. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the transcripts to # search. The string must match one of the supported locales. For more # information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation associated with the # transcripts to search. # @return [String] # # @!attribute [rw] next_index # A index that indicates whether there are more results to return in a # response to the SearchAssociatedTranscripts operation. If the # nextIndex field is present, you send the contents as the nextIndex # parameter of a SearchAssociatedTranscriptsRequest operation to get # the next page of results. # @return [Integer] # # @!attribute [rw] associated_transcripts # The object that contains the associated transcript that meet the # criteria you specified. # @return [Array] # # @!attribute [rw] total_results # The total number of transcripts returned by the search. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SearchAssociatedTranscriptsResponse AWS API Documentation # class SearchAssociatedTranscriptsResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id, :next_index, :associated_transcripts, :total_results) SENSITIVE = [] include Aws::Structure end # Determines whether Amazon Lex will use Amazon Comprehend to detect the # sentiment of user utterances. # # @!attribute [rw] detect_sentiment # Sets whether Amazon Lex uses Amazon Comprehend to detect the # sentiment of user utterances. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SentimentAnalysisSettings AWS API Documentation # class SentimentAnalysisSettings < Struct.new( :detect_sentiment) SENSITIVE = [] include Aws::Structure end # You have reached a quota for your bot. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # An object specifying the measure and method by which to sort the # session analytics data. # # @!attribute [rw] name # The measure by which to sort the session analytics data. # # * `conversationStartTime` – The date and time when the conversation # began. A conversation is defined as a unique combination of a # `sessionId` and an `originatingRequestId`. # # * `numberOfTurns` – The number of turns that the session took. # # * `conversationDurationSeconds` – The duration of the conversation # in seconds. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SessionDataSortBy AWS API Documentation # class SessionDataSortBy < Struct.new( :name, :order) SENSITIVE = [] include Aws::Structure end # An object containing information about a specific session. # # @!attribute [rw] bot_alias_id # The identifier of the alias of the bot that the session was held # with. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that the session was held with. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot that the session was held with. # @return [String] # # @!attribute [rw] channel # The channel that is integrated with the bot that the session was # held with. # @return [String] # # @!attribute [rw] session_id # The identifier of the session. # @return [String] # # @!attribute [rw] conversation_start_time # The date and time when the conversation began. A conversation is # defined as a unique combination of a `sessionId` and an # `originatingRequestId`. # @return [Time] # # @!attribute [rw] conversation_end_time # The date and time when the conversation ended. A conversation is # defined as a unique combination of a `sessionId` and an # `originatingRequestId`. # @return [Time] # # @!attribute [rw] conversation_duration_seconds # The duration of the conversation in seconds. A conversation is # defined as a unique combination of a `sessionId` and an # `originatingRequestId`. # @return [Integer] # # @!attribute [rw] conversation_end_state # The final state of the conversation. A conversation is defined as a # unique combination of a `sessionId` and an `originatingRequestId`. # @return [String] # # @!attribute [rw] mode # The mode of the session. The possible values are as follows: # # * `Speech` – The session was spoken. # # * `Text` – The session was written. # # * `DTMF` – The session used a touch-tone keypad (Dual Tone # Multi-Frequency). # # * `MultiMode` – The session used multiple modes. # @return [String] # # @!attribute [rw] number_of_turns # The number of turns that the session took. # @return [Integer] # # @!attribute [rw] invoked_intent_samples # A list of objects containing the name of an intent that was invoked. # @return [Array] # # @!attribute [rw] originating_request_id # The identifier of the first request in a session. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SessionSpecification AWS API Documentation # class SessionSpecification < Struct.new( :bot_alias_id, :bot_version, :locale_id, :channel, :session_id, :conversation_start_time, :conversation_end_time, :conversation_duration_seconds, :conversation_end_state, :mode, :number_of_turns, :invoked_intent_samples, :originating_request_id) SENSITIVE = [] include Aws::Structure end # Settings used when Amazon Lex successfully captures a slot value from # a user. # # @!attribute [rw] capture_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] capture_next_step # Specifies the next step that the bot runs when the slot value is # captured before the code hook times out. # @return [Types::DialogState] # # @!attribute [rw] capture_conditional # A list of conditional branches to evaluate after the slot value is # captured. # @return [Types::ConditionalSpecification] # # @!attribute [rw] failure_response # Specifies a list of message groups that Amazon Lex uses to respond # the user input. # @return [Types::ResponseSpecification] # # @!attribute [rw] failure_next_step # Specifies the next step that the bot runs when the slot value code # is not recognized. # @return [Types::DialogState] # # @!attribute [rw] failure_conditional # A list of conditional branches to evaluate when the slot value # isn't captured. # @return [Types::ConditionalSpecification] # # @!attribute [rw] code_hook # Code hook called after Amazon Lex successfully captures a slot # value. # @return [Types::DialogCodeHookInvocationSetting] # # @!attribute [rw] elicitation_code_hook # Code hook called when Amazon Lex doesn't capture a slot value. # @return [Types::ElicitationCodeHookInvocationSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotCaptureSetting AWS API Documentation # class SlotCaptureSetting < Struct.new( :capture_response, :capture_next_step, :capture_conditional, :failure_response, :failure_next_step, :failure_conditional, :code_hook, :elicitation_code_hook) SENSITIVE = [] include Aws::Structure end # Specifies the default value to use when a user doesn't provide a # value for a slot. # # @!attribute [rw] default_value # The default value to use when a user doesn't provide a value for a # slot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotDefaultValue AWS API Documentation # class SlotDefaultValue < Struct.new( :default_value) SENSITIVE = [] include Aws::Structure end # Defines a list of values that Amazon Lex should use as the default # value for a slot. # # @!attribute [rw] default_value_list # A list of default values. Amazon Lex chooses the default value to # use in the order that they are presented in the list. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotDefaultValueSpecification AWS API Documentation # class SlotDefaultValueSpecification < Struct.new( :default_value_list) SENSITIVE = [] include Aws::Structure end # Filters the response from the `ListSlots` operation. # # @!attribute [rw] name # The name of the field to use for filtering. # @return [String] # # @!attribute [rw] values # The value to use to filter the response. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the # `ListSlots` operation should return only aliases that equal the # specified value. Specify `CO` when the `ListSlots` operation should # return aliases that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotFilter AWS API Documentation # class SlotFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Sets the priority that Amazon Lex should use when eliciting slot # values from a user. # # @!attribute [rw] priority # The priority that Amazon Lex should apply to the slot. # @return [Integer] # # @!attribute [rw] slot_id # The unique identifier of the slot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotPriority AWS API Documentation # class SlotPriority < Struct.new( :priority, :slot_id) SENSITIVE = [] include Aws::Structure end # Contains specifications for the assisted slot resolution feature. # # @!attribute [rw] enabled # Specifies whether assisted slot resolution is turned on or off. # @return [Boolean] # # @!attribute [rw] bedrock_model_specification # An object containing information about the Amazon Bedrock model used # to assist slot resolution. # @return [Types::BedrockModelSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotResolutionImprovementSpecification AWS API Documentation # class SlotResolutionImprovementSpecification < Struct.new( :enabled, :bedrock_model_specification) SENSITIVE = [] include Aws::Structure end # Contains information about whether assisted slot resolution is turned # on for the slot or not. # # @!attribute [rw] slot_resolution_strategy # Specifies whether assisted slot resolution is turned on for the slot # or not. If the value is `EnhancedFallback`, assisted slot resolution # is activated when Amazon Lex defaults to the # `AMAZON.FallbackIntent`. If the value is `Default`, assisted slot # resolution is turned off. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotResolutionSetting AWS API Documentation # class SlotResolutionSetting < Struct.new( :slot_resolution_strategy) SENSITIVE = [] include Aws::Structure end # Information about the success and failure rate of slot resolution in # the results of a test execution. # # @!attribute [rw] slot_name # The name of the slot. # @return [String] # # @!attribute [rw] result_counts # A result for slot resolution in the results of a test execution. # @return [Types::SlotResolutionTestResultItemCounts] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotResolutionTestResultItem AWS API Documentation # class SlotResolutionTestResultItem < Struct.new( :slot_name, :result_counts) SENSITIVE = [] include Aws::Structure end # Information about the counts for a slot resolution in the results of a # test execution. # # @!attribute [rw] total_result_count # The total number of results. # @return [Integer] # # @!attribute [rw] speech_transcription_result_counts # The number of matched, mismatched and execution error results for # speech transcription for the slot. # @return [Hash] # # @!attribute [rw] slot_match_result_counts # The number of matched and mismatched results for slot resolution for # the slot. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotResolutionTestResultItemCounts AWS API Documentation # class SlotResolutionTestResultItemCounts < Struct.new( :total_result_count, :speech_transcription_result_counts, :slot_match_result_counts) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of bots. # # @!attribute [rw] attribute # The attribute to use to sort the list. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can choose ascending or descending. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotSortBy AWS API Documentation # class SlotSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Summary information about a slot, a value that the bot elicits from # the user. # # @!attribute [rw] slot_id # The unique identifier of the slot. # @return [String] # # @!attribute [rw] slot_name # The name given to the slot. # @return [String] # # @!attribute [rw] description # The description of the slot. # @return [String] # # @!attribute [rw] slot_constraint # Whether the slot is required or optional. An intent is complete when # all required slots are filled. # @return [String] # # @!attribute [rw] slot_type_id # The unique identifier for the slot type that defines the values for # the slot. # @return [String] # # @!attribute [rw] value_elicitation_prompt_specification # Prompts that are sent to the user to elicit a value for the slot. # @return [Types::PromptSpecification] # # @!attribute [rw] last_updated_date_time # The timestamp of the last date and time that the slot was updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotSummary AWS API Documentation # class SlotSummary < Struct.new( :slot_id, :slot_name, :description, :slot_constraint, :slot_type_id, :value_elicitation_prompt_specification, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Filters the response from the `ListSlotTypes` operation. # # @!attribute [rw] name # The name of the field to use for filtering. # @return [String] # # @!attribute [rw] values # The value to use to filter the response. # @return [Array] # # @!attribute [rw] operator # The operator to use for the filter. Specify `EQ` when the # `ListSlotTypes` operation should return only aliases that equal the # specified value. Specify `CO` when the `ListSlotTypes` operation # should return aliases that contain the specified value. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeFilter AWS API Documentation # class SlotTypeFilter < Struct.new( :name, :values, :operator) SENSITIVE = [] include Aws::Structure end # Specifies attributes for sorting a list of slot types. # # @!attribute [rw] attribute # The attribute to use to sort the list of slot types. # @return [String] # # @!attribute [rw] order # The order to sort the list. You can say ascending or descending. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeSortBy AWS API Documentation # class SlotTypeSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # The object that contains the statistical summary of the recommended # slot type associated with the bot recommendation. # # @!attribute [rw] discovered_slot_type_count # The number of recommended slot types associated with the bot # recommendation. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeStatistics AWS API Documentation # class SlotTypeStatistics < Struct.new( :discovered_slot_type_count) SENSITIVE = [] include Aws::Structure end # Provides summary information about a slot type. # # @!attribute [rw] slot_type_id # The unique identifier assigned to the slot type. # @return [String] # # @!attribute [rw] slot_type_name # The name of the slot type. # @return [String] # # @!attribute [rw] description # The description of the slot type. # @return [String] # # @!attribute [rw] parent_slot_type_signature # If the slot type is derived from a built-on slot type, the name of # the parent slot type. # @return [String] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the slot type was last # updated. # @return [Time] # # @!attribute [rw] slot_type_category # Indicates the type of the slot type. # # * `Custom` - A slot type that you created using custom values. For # more information, see [Creating custom slot types][1]. # # * `Extended` - A slot type created by extending the # `AMAZON.AlphaNumeric` built-in slot type. For more information, # see [ `AMAZON.AlphaNumeric` ][2]. # # * `ExternalGrammar` - A slot type using a custom GRXML grammar to # define values. For more information, see [Using a custom grammar # slot type][3]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html # [2]: https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html # [3]: https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeSummary AWS API Documentation # class SlotTypeSummary < Struct.new( :slot_type_id, :slot_type_name, :description, :parent_slot_type_signature, :last_updated_date_time, :slot_type_category) SENSITIVE = [] include Aws::Structure end # Each slot type can have a set of values. Each `SlotTypeValue` # represents a value that the slot type can take. # # @!attribute [rw] sample_value # The value of the slot type entry. # @return [Types::SampleValue] # # @!attribute [rw] synonyms # Additional values related to the slot type entry. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotTypeValue AWS API Documentation # class SlotTypeValue < Struct.new( :sample_value, :synonyms) SENSITIVE = [] include Aws::Structure end # The value to set in a slot. # # @!attribute [rw] interpreted_value # The value that Amazon Lex determines for the slot. The actual value # depends on the setting of the value selection strategy for the bot. # You can choose to use the value entered by the user, or you can have # Amazon Lex choose the first value in the `resolvedValues` list. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValue AWS API Documentation # class SlotValue < Struct.new( :interpreted_value) SENSITIVE = [] include Aws::Structure end # Specifies the elicitation setting details eliciting a slot. # # @!attribute [rw] default_value_specification # A list of default values for a slot. Default values are used when # Amazon Lex hasn't determined a value for a slot. You can specify # default values from context variables, session attributes, and # defined values. # @return [Types::SlotDefaultValueSpecification] # # @!attribute [rw] slot_constraint # Specifies whether the slot is required or optional. # @return [String] # # @!attribute [rw] prompt_specification # The prompt that Amazon Lex uses to elicit the slot value from the # user. # @return [Types::PromptSpecification] # # @!attribute [rw] sample_utterances # If you know a specific pattern that users might respond to an Amazon # Lex request for a slot value, you can provide those utterances to # improve accuracy. This is optional. In most cases, Amazon Lex is # capable of understanding user utterances. # @return [Array] # # @!attribute [rw] wait_and_continue_specification # Specifies the prompts that Amazon Lex uses while a bot is waiting # for customer input. # @return [Types::WaitAndContinueSpecification] # # @!attribute [rw] slot_capture_setting # Specifies the settings that Amazon Lex uses when a slot value is # successfully entered by a user. # @return [Types::SlotCaptureSetting] # # @!attribute [rw] slot_resolution_setting # An object containing information about whether assisted slot # resolution is turned on for the slot or not. # @return [Types::SlotResolutionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueElicitationSetting AWS API Documentation # class SlotValueElicitationSetting < Struct.new( :default_value_specification, :slot_constraint, :prompt_specification, :sample_utterances, :wait_and_continue_specification, :slot_capture_setting, :slot_resolution_setting) SENSITIVE = [] include Aws::Structure end # The slot values that Amazon Lex uses when it sets slot values in a # dialog step. # # @!attribute [rw] shape # When the shape value is `List`, it indicates that the `values` field # contains a list of slot values. When the value is `Scalar`, it # indicates that the `value` field contains a single value. # @return [String] # # @!attribute [rw] value # The current value of the slot. # @return [Types::SlotValue] # # @!attribute [rw] values # A list of one or more values that the user provided for the slot. # For example, for a slot that elicits pizza toppings, the values # might be "pepperoni" and "pineapple." # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueOverride AWS API Documentation # class SlotValueOverride < Struct.new( :shape, :value, :values) SENSITIVE = [] include Aws::Structure end # Provides a regular expression used to validate the value of a slot. # # @!attribute [rw] pattern # A regular expression used to validate the value of a slot. # # Use a standard regular expression. Amazon Lex supports the following # characters in the regular expression: # # * A-Z, a-z # # * 0-9 # # * Unicode characters ("\\⁠u<Unicode>") # # Represent Unicode characters with four digits, for example # "\\⁠u0041" or "\\⁠u005A". # # The following regular expression operators are not supported: # # * Infinite repeaters: *, +, or \\\{x,\\} with no upper bound. # # * Wild card (.) # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueRegexFilter AWS API Documentation # class SlotValueRegexFilter < Struct.new( :pattern) SENSITIVE = [] include Aws::Structure end # Contains settings used by Amazon Lex to select a slot value. # # @!attribute [rw] resolution_strategy # Determines the slot resolution strategy that Amazon Lex uses to # return slot type values. The field can be set to one of the # following values: # # * `ORIGINAL_VALUE` - Returns the value entered by the user, if the # user value is similar to the slot value. # # * `TOP_RESOLUTION` - If there is a resolution list for the slot, # return the first value in the resolution list as the slot type # value. If there is no resolution list, null is returned. # # If you don't specify the `valueSelectionStrategy`, the default is # `ORIGINAL_VALUE`. # @return [String] # # @!attribute [rw] regex_filter # A regular expression used to validate the value of a slot. # @return [Types::SlotValueRegexFilter] # # @!attribute [rw] advanced_recognition_setting # Provides settings that enable advanced recognition settings for slot # values. You can use this to enable using slot values as a custom # vocabulary for recognizing user utterances. # @return [Types::AdvancedRecognitionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SlotValueSelectionSetting AWS API Documentation # class SlotValueSelectionSetting < Struct.new( :resolution_strategy, :regex_filter, :advanced_recognition_setting) SENSITIVE = [] include Aws::Structure end # Subslot specifications. # # @!attribute [rw] slot_type_id # The unique identifier assigned to the slot type. # @return [String] # # @!attribute [rw] value_elicitation_setting # Specifies the elicitation setting details for constituent sub slots # of a composite slot. # @return [Types::SubSlotValueElicitationSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Specifications AWS API Documentation # class Specifications < Struct.new( :slot_type_id, :value_elicitation_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the bot recommendation. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to start. The string must match one of the supported locales. For # more information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] transcript_source_setting # The object representing the Amazon S3 bucket containing the # transcript, as well as the associated metadata. # @return [Types::TranscriptSourceSetting] # # @!attribute [rw] encryption_setting # The object representing the passwords that will be used to encrypt # the data related to the bot recommendation results, as well as the # KMS key ARN used to encrypt the associated metadata. # @return [Types::EncryptionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationRequest AWS API Documentation # class StartBotRecommendationRequest < Struct.new( :bot_id, :bot_version, :locale_id, :transcript_source_setting, :encryption_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the bot recommendation. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to start. The string must match one of the supported locales. For # more information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_status # The status of the bot recommendation. # # If the status is Failed, then the reasons for the failure are listed # in the failureReasons field. # @return [String] # # @!attribute [rw] bot_recommendation_id # The identifier of the bot recommendation that you have created. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot recommendation was # created. # @return [Time] # # @!attribute [rw] transcript_source_setting # The object representing the Amazon S3 bucket containing the # transcript, as well as the associated metadata. # @return [Types::TranscriptSourceSetting] # # @!attribute [rw] encryption_setting # The object representing the passwords that were used to encrypt the # data related to the bot recommendation results, as well as the KMS # key ARN used to encrypt the associated metadata. # @return [Types::EncryptionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationResponse AWS API Documentation # class StartBotRecommendationResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_status, :bot_recommendation_id, :creation_date_time, :transcript_source_setting, :encryption_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] generation_input_prompt # The prompt to generate intents and slot types for the bot locale. # Your description should be both *detailed* and *precise* to help # generate appropriate and sufficient intents for your bot. Include a # list of actions to improve the intent creation process. # @return [String] # # @!attribute [rw] bot_id # The unique identifier of the bot for which to generate intents and # slot types. # @return [String] # # @!attribute [rw] bot_version # The version of the bot for which to generate intents and slot types. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot for which to generate intents and slot types. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotResourceGenerationRequest AWS API Documentation # class StartBotResourceGenerationRequest < Struct.new( :generation_input_prompt, :bot_id, :bot_version, :locale_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] generation_input_prompt # The prompt that was used generate intents and slot types for the bot # locale. # @return [String] # # @!attribute [rw] generation_id # The unique identifier of the generation request. # @return [String] # # @!attribute [rw] bot_id # The unique identifier of the bot for which the generation request # was made. # @return [String] # # @!attribute [rw] bot_version # The version of the bot for which the generation request was made. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot for which the generation request was made. # @return [String] # # @!attribute [rw] generation_status # The status of the generation request. # @return [String] # # @!attribute [rw] creation_date_time # The date and time at which the generation request was made. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotResourceGenerationResponse AWS API Documentation # class StartBotResourceGenerationResponse < Struct.new( :generation_input_prompt, :generation_id, :bot_id, :bot_version, :locale_id, :generation_status, :creation_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] import_id # The unique identifier for the import. It is included in the response # from the [CreateUploadUrl][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateUploadUrl.html # @return [String] # # @!attribute [rw] resource_specification # Parameters for creating the bot, bot locale or custom vocabulary. # @return [Types::ImportResourceSpecification] # # @!attribute [rw] merge_strategy # The strategy to use when there is a name conflict between the # imported resource and an existing resource. When the merge strategy # is `FailOnConflict` existing resources are not overwritten and the # import fails. # @return [String] # # @!attribute [rw] file_password # The password used to encrypt the zip archive that contains the # resource definition. You should always encrypt the zip archive to # protect it during transit between your site and Amazon Lex. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportRequest AWS API Documentation # class StartImportRequest < Struct.new( :import_id, :resource_specification, :merge_strategy, :file_password) SENSITIVE = [:file_password] include Aws::Structure end # @!attribute [rw] import_id # A unique identifier for the import. # @return [String] # # @!attribute [rw] resource_specification # The parameters used when importing the resource. # @return [Types::ImportResourceSpecification] # # @!attribute [rw] merge_strategy # The strategy used when there was a name conflict between the # imported resource and an existing resource. When the merge strategy # is `FailOnConflict` existing resources are not overwritten and the # import fails. # @return [String] # # @!attribute [rw] import_status # The current status of the import. When the status is `Complete` the # bot, bot alias, or custom vocabulary is ready to use. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the import request was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportResponse AWS API Documentation # class StartImportResponse < Struct.new( :import_id, :resource_specification, :merge_strategy, :import_status, :creation_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for the test set execution. # @return [String] # # @!attribute [rw] target # The target bot for the test set execution. # @return [Types::TestExecutionTarget] # # @!attribute [rw] api_mode # Indicates whether we use streaming or non-streaming APIs for the # test set execution. For streaming, StartConversation Runtime API is # used. Whereas, for non-streaming, RecognizeUtterance and # RecognizeText Amazon Lex Runtime API are used. # @return [String] # # @!attribute [rw] test_execution_modality # Indicates whether audio or text is used. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartTestExecutionRequest AWS API Documentation # class StartTestExecutionRequest < Struct.new( :test_set_id, :target, :api_mode, :test_execution_modality) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_execution_id # The unique identifier of the test set execution. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time for the test set execution. # @return [Time] # # @!attribute [rw] test_set_id # The test set Id for the test set execution. # @return [String] # # @!attribute [rw] target # The target bot for the test set execution. # @return [Types::TestExecutionTarget] # # @!attribute [rw] api_mode # Indicates whether we use streaming or non-streaming APIs for the # test set execution. For streaming, StartConversation Amazon Lex # Runtime API is used. Whereas for non-streaming, RecognizeUtterance # and RecognizeText Amazon Lex Runtime API are used. # @return [String] # # @!attribute [rw] test_execution_modality # Indicates whether audio or text is used. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartTestExecutionResponse AWS API Documentation # class StartTestExecutionResponse < Struct.new( :test_execution_id, :creation_date_time, :test_set_id, :target, :api_mode, :test_execution_modality) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_name # The test set name for the test set generation request. # @return [String] # # @!attribute [rw] description # The test set description for the test set generation request. # @return [String] # # @!attribute [rw] storage_location # The Amazon S3 storage location for the test set generation. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] generation_data_source # The data source for the test set generation. # @return [Types::TestSetGenerationDataSource] # # @!attribute [rw] role_arn # The roleARN used for any operation in the test set to access # resources in the Amazon Web Services account. # @return [String] # # @!attribute [rw] test_set_tags # A list of tags to add to the test set. You can only add tags when # you import/generate a new test set. You can't use the # `UpdateTestSet` operation to update tags. To update tags, use the # `TagResource` operation. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartTestSetGenerationRequest AWS API Documentation # class StartTestSetGenerationRequest < Struct.new( :test_set_name, :description, :storage_location, :generation_data_source, :role_arn, :test_set_tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_generation_id # The unique identifier of the test set generation to describe. # @return [String] # # @!attribute [rw] creation_date_time # The creation date and time for the test set generation. # @return [Time] # # @!attribute [rw] test_set_generation_status # The status for the test set generation. # @return [String] # # @!attribute [rw] test_set_name # The test set name used for the test set generation. # @return [String] # # @!attribute [rw] description # The description used for the test set generation. # @return [String] # # @!attribute [rw] storage_location # The Amazon S3 storage location for the test set generation. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] generation_data_source # The data source for the test set generation. # @return [Types::TestSetGenerationDataSource] # # @!attribute [rw] role_arn # The roleARN used for any operation in the test set to access # resources in the Amazon Web Services account. # @return [String] # # @!attribute [rw] test_set_tags # A list of tags that was used for the test set that is being # generated. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartTestSetGenerationResponse AWS API Documentation # class StartTestSetGenerationResponse < Struct.new( :test_set_generation_id, :creation_date_time, :test_set_generation_status, :test_set_name, :description, :storage_location, :generation_data_source, :role_arn, :test_set_tags) SENSITIVE = [] include Aws::Structure end # Defines the messages that Amazon Lex sends to a user to remind them # that the bot is waiting for a response. # # @!attribute [rw] message_groups # One or more message groups, each containing one or more messages, # that define the prompts that Amazon Lex sends to the user. # @return [Array] # # @!attribute [rw] frequency_in_seconds # How often a message should be sent to the user. Minimum of 1 second, # maximum of 5 minutes. # @return [Integer] # # @!attribute [rw] timeout_in_seconds # If Amazon Lex waits longer than this length of time for a response, # it will stop sending messages. # @return [Integer] # # @!attribute [rw] allow_interrupt # Indicates that the user can interrupt the response by speaking while # the message is being played. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StillWaitingResponseSpecification AWS API Documentation # class StillWaitingResponseSpecification < Struct.new( :message_groups, :frequency_in_seconds, :timeout_in_seconds, :allow_interrupt) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation # to be stopped. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the bot recommendation. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to stop. The string must match one of the supported locales. For # more information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation to be stopped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationRequest AWS API Documentation # class StopBotRecommendationRequest < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation # that is being stopped. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the recommendation that is being # stopped. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot response to # stop. The string must match one of the supported locales. For more # information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_status # The status of the bot recommendation. If the status is Failed, then # the reasons for the failure are listed in the failureReasons field. # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation that is being # stopped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationResponse AWS API Documentation # class StopBotRecommendationResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_status, :bot_recommendation_id) SENSITIVE = [] include Aws::Structure end # Specifications for the constituent sub slots and the expression for # the composite slot. # # @!attribute [rw] expression # The expression text for defining the constituent sub slots in the # composite slot using logical AND and OR operators. # @return [String] # # @!attribute [rw] slot_specifications # Specifications for the constituent sub slots of a composite slot. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotSetting AWS API Documentation # class SubSlotSetting < Struct.new( :expression, :slot_specifications) SENSITIVE = [] include Aws::Structure end # Subslot type composition. # # @!attribute [rw] name # Name of a constituent sub slot inside a composite slot. # @return [String] # # @!attribute [rw] slot_type_id # The unique identifier assigned to a slot type. This refers to either # a built-in slot type or the unique slotTypeId of a custom slot type. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotTypeComposition AWS API Documentation # class SubSlotTypeComposition < Struct.new( :name, :slot_type_id) SENSITIVE = [] include Aws::Structure end # Subslot elicitation settings. # # `DefaultValueSpecification` is a list of default values for a # constituent sub slot in a composite slot. Default values are used when # Amazon Lex hasn't determined a value for a slot. You can specify # default values from context variables, session attributes, and defined # values. This is similar to `DefaultValueSpecification` for slots. # # `PromptSpecification` is the prompt that Amazon Lex uses to elicit the # sub slot value from the user. This is similar to `PromptSpecification` # for slots. # # @!attribute [rw] default_value_specification # Defines a list of values that Amazon Lex should use as the default # value for a slot. # @return [Types::SlotDefaultValueSpecification] # # @!attribute [rw] prompt_specification # Specifies a list of message groups that Amazon Lex sends to a user # to elicit a response. # @return [Types::PromptSpecification] # # @!attribute [rw] sample_utterances # If you know a specific pattern that users might respond to an Amazon # Lex request for a sub slot value, you can provide those utterances # to improve accuracy. This is optional. In most cases Amazon Lex is # capable of understanding user utterances. This is similar to # `SampleUtterances` for slots. # @return [Array] # # @!attribute [rw] wait_and_continue_specification # Specifies the prompts that Amazon Lex uses while a bot is waiting # for customer input. # @return [Types::WaitAndContinueSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotValueElicitationSetting AWS API Documentation # class SubSlotValueElicitationSetting < Struct.new( :default_value_specification, :prompt_specification, :sample_utterances, :wait_and_continue_specification) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel # to tag. # @return [String] # # @!attribute [rw] tags # A list of tag keys to add to the resource. If a tag key already # exists, the existing value is replaced with the new value. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # Contains information about the method by which to filter the results # of the test execution. # # @!attribute [rw] result_type_filter # Specifies which results to filter. See [Test result # details">Test results details][1] for details about different # types of results. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html # @return [String] # # @!attribute [rw] conversation_level_test_results_filter_by # Contains information about the method for filtering Conversation # level test results. # @return [Types::ConversationLevelTestResultsFilterBy] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestExecutionResultFilterBy AWS API Documentation # class TestExecutionResultFilterBy < Struct.new( :result_type_filter, :conversation_level_test_results_filter_by) SENSITIVE = [] include Aws::Structure end # Contains the results of the test execution, grouped by type of # results. See [Test result details">Test results details][1] for # details about different types of results. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html # # @!attribute [rw] overall_test_results # Overall results for the test execution, including the breakdown of # conversations and single-input utterances. # @return [Types::OverallTestResults] # # @!attribute [rw] conversation_level_test_results # Results related to conversations in the test set, including metrics # about success and failure of conversations and intent and slot # failures. # @return [Types::ConversationLevelTestResults] # # @!attribute [rw] intent_classification_test_results # Intent recognition results aggregated by intent name. The aggregated # results contain success and failure rates of intent recognition, # speech transcriptions, and end-to-end conversations. # @return [Types::IntentClassificationTestResults] # # @!attribute [rw] intent_level_slot_resolution_test_results # Slot resolution results aggregated by intent and slot name. The # aggregated results contain success and failure rates of slot # resolution, speech transcriptions, and end-to-end conversations # @return [Types::IntentLevelSlotResolutionTestResults] # # @!attribute [rw] utterance_level_test_results # Results related to utterances in the test set. # @return [Types::UtteranceLevelTestResults] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestExecutionResultItems AWS API Documentation # class TestExecutionResultItems < Struct.new( :overall_test_results, :conversation_level_test_results, :intent_classification_test_results, :intent_level_slot_resolution_test_results, :utterance_level_test_results) SENSITIVE = [] include Aws::Structure end # Contains information about the method by which to sort the instances # of test executions you have carried out. # # @!attribute [rw] attribute # Specifies whether to sort the test set executions by the date and # time at which the test sets were created. # @return [String] # # @!attribute [rw] order # Specifies whether to sort in ascending or descending order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestExecutionSortBy AWS API Documentation # class TestExecutionSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Summarizes metadata about the test execution. # # @!attribute [rw] test_execution_id # The unique identifier of the test execution. # @return [String] # # @!attribute [rw] creation_date_time # The date and time at which the test execution was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time at which the test execution was last updated. # @return [Time] # # @!attribute [rw] test_execution_status # The current status of the test execution. # @return [String] # # @!attribute [rw] test_set_id # The unique identifier of the test set used in the test execution. # @return [String] # # @!attribute [rw] test_set_name # The name of the test set used in the test execution. # @return [String] # # @!attribute [rw] target # Contains information about the bot used for the test execution.. # @return [Types::TestExecutionTarget] # # @!attribute [rw] api_mode # Specifies whether the API mode for the test execution is streaming # or non-streaming. # @return [String] # # @!attribute [rw] test_execution_modality # Specifies whether the data used for the test execution is written or # spoken. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestExecutionSummary AWS API Documentation # class TestExecutionSummary < Struct.new( :test_execution_id, :creation_date_time, :last_updated_date_time, :test_execution_status, :test_set_id, :test_set_name, :target, :api_mode, :test_execution_modality) SENSITIVE = [] include Aws::Structure end # Contains information about the bot used for the test execution. # # @!attribute [rw] bot_alias_target # Contains information about the bot alias used for the test # execution. # @return [Types::BotAliasTestExecutionTarget] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestExecutionTarget AWS API Documentation # class TestExecutionTarget < Struct.new( :bot_alias_target) SENSITIVE = [] include Aws::Structure end # Contains details about the errors in the test set discrepancy report # # @!attribute [rw] intent_discrepancies # Contains information about discrepancies found for intents between # the test set and the bot. # @return [Array] # # @!attribute [rw] slot_discrepancies # Contains information about discrepancies found for slots between the # test set and the bot. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetDiscrepancyErrors AWS API Documentation # class TestSetDiscrepancyErrors < Struct.new( :intent_discrepancies, :slot_discrepancies) SENSITIVE = [] include Aws::Structure end # Contains information about the bot alias used for the test set # discrepancy report. # # @!attribute [rw] bot_id # The unique identifier for the bot alias. # @return [String] # # @!attribute [rw] bot_alias_id # The unique identifier for the bot associated with the bot alias. # @return [String] # # @!attribute [rw] locale_id # The unique identifier of the locale associated with the bot alias. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetDiscrepancyReportBotAliasTarget AWS API Documentation # class TestSetDiscrepancyReportBotAliasTarget < Struct.new( :bot_id, :bot_alias_id, :locale_id) SENSITIVE = [] include Aws::Structure end # Contains information about the resource used for the test set # discrepancy report. # # @!attribute [rw] bot_alias_target # Contains information about the bot alias used as the resource for # the test set discrepancy report. # @return [Types::TestSetDiscrepancyReportBotAliasTarget] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetDiscrepancyReportResourceTarget AWS API Documentation # class TestSetDiscrepancyReportResourceTarget < Struct.new( :bot_alias_target) SENSITIVE = [] include Aws::Structure end # Contains information about the test set that is exported. # # @!attribute [rw] test_set_id # The unique identifier of the test set. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetExportSpecification AWS API Documentation # class TestSetExportSpecification < Struct.new( :test_set_id) SENSITIVE = [] include Aws::Structure end # Contains information about the data source from which the test set is # generated. # # @!attribute [rw] conversation_logs_data_source # Contains information about the bot from which the conversation logs # are sourced. # @return [Types::ConversationLogsDataSource] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetGenerationDataSource AWS API Documentation # class TestSetGenerationDataSource < Struct.new( :conversation_logs_data_source) SENSITIVE = [] include Aws::Structure end # Contains information about the Amazon S3 location from which the test # set is imported. # # @!attribute [rw] s3_bucket_name # The name of the Amazon S3 bucket. # @return [String] # # @!attribute [rw] s3_path # The path inside the Amazon S3 bucket pointing to the test-set CSV # file. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetImportInputLocation AWS API Documentation # class TestSetImportInputLocation < Struct.new( :s3_bucket_name, :s3_path) SENSITIVE = [] include Aws::Structure end # Contains information about the test set that is imported. # # @!attribute [rw] test_set_name # The name of the test set. # @return [String] # # @!attribute [rw] description # The description of the test set. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permission to # access the test set. # @return [String] # # @!attribute [rw] storage_location # Contains information about the location that Amazon Lex uses to # store the test-set. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] import_input_location # Contains information about the input location from where test-set # should be imported. # @return [Types::TestSetImportInputLocation] # # @!attribute [rw] modality # Specifies whether the test-set being imported contains written or # spoken data. # @return [String] # # @!attribute [rw] test_set_tags # A list of tags to add to the test set. You can only add tags when # you import/generate a new test set. You can't use the # `UpdateTestSet` operation to update tags. To update tags, use the # `TagResource` operation. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetImportResourceSpecification AWS API Documentation # class TestSetImportResourceSpecification < Struct.new( :test_set_name, :description, :role_arn, :storage_location, :import_input_location, :modality, :test_set_tags) SENSITIVE = [] include Aws::Structure end # Contains information about discrepancy in an intent information # between the test set and the bot. # # @!attribute [rw] intent_name # The name of the intent in the discrepancy report. # @return [String] # # @!attribute [rw] error_message # The error message for a discrepancy for an intent between the test # set and the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetIntentDiscrepancyItem AWS API Documentation # class TestSetIntentDiscrepancyItem < Struct.new( :intent_name, :error_message) SENSITIVE = [] include Aws::Structure end # Contains information about discrepancy in a slot information between # the test set and the bot. # # @!attribute [rw] intent_name # The name of the intent associated with the slot in the discrepancy # report. # @return [String] # # @!attribute [rw] slot_name # The name of the slot in the discrepancy report. # @return [String] # # @!attribute [rw] error_message # The error message for a discrepancy for an intent between the test # set and the bot. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetSlotDiscrepancyItem AWS API Documentation # class TestSetSlotDiscrepancyItem < Struct.new( :intent_name, :slot_name, :error_message) SENSITIVE = [] include Aws::Structure end # Contains information about the methods by which to sort the test set. # # @!attribute [rw] attribute # Specifies whether to sort the test sets by name or by the time they # were last updated. # @return [String] # # @!attribute [rw] order # Specifies whether to sort in ascending or descending order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetSortBy AWS API Documentation # class TestSetSortBy < Struct.new( :attribute, :order) SENSITIVE = [] include Aws::Structure end # Contains information about the location in which the test set is # stored. # # @!attribute [rw] s3_bucket_name # The name of the Amazon S3 bucket in which the test set is stored. # @return [String] # # @!attribute [rw] s3_path # The path inside the Amazon S3 bucket where the test set is stored. # @return [String] # # @!attribute [rw] kms_key_arn # The Amazon Resource Name (ARN) of an Amazon Web Services Key # Management Service (KMS) key for encrypting the test set. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetStorageLocation AWS API Documentation # class TestSetStorageLocation < Struct.new( :s3_bucket_name, :s3_path, :kms_key_arn) SENSITIVE = [] include Aws::Structure end # Contains summary information about the test set. # # @!attribute [rw] test_set_id # The unique identifier of the test set. # @return [String] # # @!attribute [rw] test_set_name # The name of the test set. # @return [String] # # @!attribute [rw] description # The description of the test set. # @return [String] # # @!attribute [rw] modality # Specifies whether the test set contains written or spoken data. # @return [String] # # @!attribute [rw] status # The status of the test set. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permission to # access the test set. # @return [String] # # @!attribute [rw] num_turns # The number of turns in the test set. # @return [Integer] # # @!attribute [rw] storage_location # Contains information about the location at which the test set is # stored. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] creation_date_time # The date and time at which the test set was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time at which the test set was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetSummary AWS API Documentation # class TestSetSummary < Struct.new( :test_set_id, :test_set_name, :description, :modality, :status, :role_arn, :num_turns, :storage_location, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Contains information about a turn in a test set. # # @!attribute [rw] record_number # The record number associated with the turn. # @return [Integer] # # @!attribute [rw] conversation_id # The unique identifier for the conversation associated with the turn. # @return [String] # # @!attribute [rw] turn_number # The number of turns that has elapsed up to that turn. # @return [Integer] # # @!attribute [rw] turn_specification # Contains information about the agent or user turn depending upon # type of turn. # @return [Types::TurnSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetTurnRecord AWS API Documentation # class TestSetTurnRecord < Struct.new( :record_number, :conversation_id, :turn_number, :turn_specification) SENSITIVE = [] include Aws::Structure end # Contains information about the results of the analysis of a turn in # the test set. # # @!attribute [rw] agent # Contains information about the agent messages in the turn. # @return [Types::AgentTurnResult] # # @!attribute [rw] user # Contains information about the user messages in the turn. # @return [Types::UserTurnResult] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TestSetTurnResult AWS API Documentation # class TestSetTurnResult < Struct.new( :agent, :user) SENSITIVE = [] include Aws::Structure end # Specifies the text input specifications. # # @!attribute [rw] start_timeout_ms # Time for which a bot waits before re-prompting a customer for text # input. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TextInputSpecification AWS API Documentation # class TextInputSpecification < Struct.new( :start_timeout_ms) SENSITIVE = [] include Aws::Structure end # Defines the Amazon CloudWatch Logs destination log group for # conversation text logs. # # @!attribute [rw] cloud_watch # Defines the Amazon CloudWatch Logs log group where text and metadata # logs are delivered. # @return [Types::CloudWatchLogGroupLogDestination] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TextLogDestination AWS API Documentation # class TextLogDestination < Struct.new( :cloud_watch) SENSITIVE = [] include Aws::Structure end # Defines settings to enable text conversation logs. # # @!attribute [rw] enabled # Determines whether conversation logs should be stored for an alias. # @return [Boolean] # # @!attribute [rw] destination # Defines the Amazon CloudWatch Logs destination log group for # conversation text logs. # @return [Types::TextLogDestination] # # @!attribute [rw] selective_logging_enabled # The option to enable selective conversation log capture for text. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TextLogSetting AWS API Documentation # class TextLogSetting < Struct.new( :enabled, :destination, :selective_logging_enabled) SENSITIVE = [] include Aws::Structure end # Your request rate is too high. Reduce the frequency of requests. # # @!attribute [rw] retry_after_seconds # The number of seconds after which the user can invoke the API again. # @return [Integer] # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :retry_after_seconds, :message) SENSITIVE = [] include Aws::Structure end # The object representing the filter that Amazon Lex will use to select # the appropriate transcript. # # @!attribute [rw] lex_transcript_filter # The object representing the filter that Amazon Lex will use to # select the appropriate transcript when the transcript format is the # Amazon Lex format. # @return [Types::LexTranscriptFilter] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TranscriptFilter AWS API Documentation # class TranscriptFilter < Struct.new( :lex_transcript_filter) SENSITIVE = [] include Aws::Structure end # Indicates the setting of the location where the transcript is stored. # # @!attribute [rw] s3_bucket_transcript_source # Indicates the setting of the Amazon S3 bucket where the transcript # is stored. # @return [Types::S3BucketTranscriptSource] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TranscriptSourceSetting AWS API Documentation # class TranscriptSourceSetting < Struct.new( :s3_bucket_transcript_source) SENSITIVE = [] include Aws::Structure end # Contains information about the messages in the turn. # # @!attribute [rw] agent_turn # Contains information about the agent messages in the turn. # @return [Types::AgentTurnSpecification] # # @!attribute [rw] user_turn # Contains information about the user messages in the turn. # @return [Types::UserTurnSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/TurnSpecification AWS API Documentation # class TurnSpecification < Struct.new( :agent_turn, :user_turn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to remove the tags # from. # @return [String] # # @!attribute [rw] tag_keys # A list of tag keys to remove from the resource. If a tag key does # not exist on the resource, it is ignored. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @!attribute [rw] bot_alias_id # The unique identifier of the bot alias. # @return [String] # # @!attribute [rw] bot_alias_name # The new name to assign to the bot alias. # @return [String] # # @!attribute [rw] description # The new description to assign to the bot alias. # @return [String] # # @!attribute [rw] bot_version # The new bot version to assign to the bot alias. # @return [String] # # @!attribute [rw] bot_alias_locale_settings # The new Lambda functions to use in each locale for the bot alias. # @return [Hash] # # @!attribute [rw] conversation_log_settings # The new settings for storing conversation logs in Amazon CloudWatch # Logs and Amazon S3 buckets. # @return [Types::ConversationLogSettings] # # @!attribute [rw] sentiment_analysis_settings # Determines whether Amazon Lex will use Amazon Comprehend to detect # the sentiment of user utterances. # @return [Types::SentimentAnalysisSettings] # # @!attribute [rw] bot_id # The identifier of the bot with the updated alias. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotAliasRequest AWS API Documentation # class UpdateBotAliasRequest < Struct.new( :bot_alias_id, :bot_alias_name, :description, :bot_version, :bot_alias_locale_settings, :conversation_log_settings, :sentiment_analysis_settings, :bot_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_alias_id # The identifier of the updated bot alias. # @return [String] # # @!attribute [rw] bot_alias_name # The updated name of the bot alias. # @return [String] # # @!attribute [rw] description # The updated description of the bot alias. # @return [String] # # @!attribute [rw] bot_version # The updated version of the bot that the alias points to. # @return [String] # # @!attribute [rw] bot_alias_locale_settings # The updated Lambda functions to use in each locale for the bot # alias. # @return [Hash] # # @!attribute [rw] conversation_log_settings # The updated settings for storing conversation logs in Amazon # CloudWatch Logs and Amazon S3 buckets. # @return [Types::ConversationLogSettings] # # @!attribute [rw] sentiment_analysis_settings # Determines whether Amazon Lex will use Amazon Comprehend to detect # the sentiment of user utterances. # @return [Types::SentimentAnalysisSettings] # # @!attribute [rw] bot_alias_status # The current status of the bot alias. When the status is `Available` # the alias is ready for use. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot with the updated alias. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotAliasResponse AWS API Documentation # class UpdateBotAliasResponse < Struct.new( :bot_alias_id, :bot_alias_name, :description, :bot_version, :bot_alias_locale_settings, :conversation_log_settings, :sentiment_analysis_settings, :bot_alias_status, :bot_id, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that contains the locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the locale to be updated. The # version can only be the `DRAFT` version. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale to update. The string must # match one of the supported locales. For more information, see # [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] description # The new description of the locale. # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # The new confidence threshold where Amazon Lex inserts the # `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in # the list of possible intents for an utterance. # @return [Float] # # @!attribute [rw] voice_settings # The new Amazon Polly voice Amazon Lex should use for voice # interaction with the user. # @return [Types::VoiceSettings] # # @!attribute [rw] generative_ai_settings # Contains settings for generative AI features powered by Amazon # Bedrock for your bot locale. Use this object to turn generative AI # features on and off. Pricing may differ if you turn a feature on. # For more information, see LINK. # @return [Types::GenerativeAISettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotLocaleRequest AWS API Documentation # class UpdateBotLocaleRequest < Struct.new( :bot_id, :bot_version, :locale_id, :description, :nlu_intent_confidence_threshold, :voice_settings, :generative_ai_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The identifier of the bot that contains the updated locale. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the updated locale. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the updated bot locale. # @return [String] # # @!attribute [rw] locale_name # The updated locale name for the locale. # @return [String] # # @!attribute [rw] description # The updated description of the locale. # @return [String] # # @!attribute [rw] nlu_intent_confidence_threshold # The updated confidence threshold for inserting the # `AMAZON.FallbackIntent` and `AMAZON.KendraSearchIntent` intents in # the list of possible intents for an utterance. # @return [Float] # # @!attribute [rw] voice_settings # The updated Amazon Polly voice to use for voice interaction with the # user. # @return [Types::VoiceSettings] # # @!attribute [rw] bot_locale_status # The current status of the locale. When the bot status is `Built` the # locale is ready for use. # @return [String] # # @!attribute [rw] failure_reasons # If the `botLocaleStatus` is `Failed`, the `failureReasons` field # lists the errors that occurred while building the bot. # @return [Array] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the locale was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the locale was last updated. # @return [Time] # # @!attribute [rw] recommended_actions # Recommended actions to take to resolve an error in the # `failureReasons` field. # @return [Array] # # @!attribute [rw] generative_ai_settings # Contains settings for generative AI features powered by Amazon # Bedrock for your bot locale. # @return [Types::GenerativeAISettings] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotLocaleResponse AWS API Documentation # class UpdateBotLocaleResponse < Struct.new( :bot_id, :bot_version, :locale_id, :locale_name, :description, :nlu_intent_confidence_threshold, :voice_settings, :bot_locale_status, :failure_reasons, :creation_date_time, :last_updated_date_time, :recommended_actions, :generative_ai_settings) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation # to be updated. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the bot recommendation to be # updated. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to update. The string must match one of the supported locales. For # more information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation to be updated. # @return [String] # # @!attribute [rw] encryption_setting # The object representing the passwords that will be used to encrypt # the data related to the bot recommendation results, as well as the # KMS key ARN used to encrypt the associated metadata. # @return [Types::EncryptionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendationRequest AWS API Documentation # class UpdateBotRecommendationRequest < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_id, :encryption_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot containing the bot recommendation # that has been updated. # @return [String] # # @!attribute [rw] bot_version # The version of the bot containing the bot recommendation that has # been updated. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale of the bot recommendation # to update. The string must match one of the supported locales. For # more information, see [Supported languages][1] # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] bot_recommendation_status # The status of the bot recommendation. # # If the status is Failed, then the reasons for the failure are listed # in the failureReasons field. # @return [String] # # @!attribute [rw] bot_recommendation_id # The unique identifier of the bot recommendation to be updated. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot recommendation was # created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot recommendation was # last updated. # @return [Time] # # @!attribute [rw] transcript_source_setting # The object representing the Amazon S3 bucket containing the # transcript, as well as the associated metadata. # @return [Types::TranscriptSourceSetting] # # @!attribute [rw] encryption_setting # The object representing the passwords that were used to encrypt the # data related to the bot recommendation results, as well as the KMS # key ARN used to encrypt the associated metadata. # @return [Types::EncryptionSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRecommendationResponse AWS API Documentation # class UpdateBotRecommendationResponse < Struct.new( :bot_id, :bot_version, :locale_id, :bot_recommendation_status, :bot_recommendation_id, :creation_date_time, :last_updated_date_time, :transcript_source_setting, :encryption_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot to update. This identifier is # returned by the [CreateBot][1] operation. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html # @return [String] # # @!attribute [rw] bot_name # The new name of the bot. The name must be unique in the account that # creates the bot. # @return [String] # # @!attribute [rw] description # A description of the bot. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM role that has permissions # to access the bot. # @return [String] # # @!attribute [rw] data_privacy # Provides information on additional privacy protections Amazon Lex # should use with the bot's data. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The time, in seconds, that Amazon Lex should keep information about # a user's conversation with the bot. # # A user interaction remains active for the amount of time specified. # If no conversation occurs during this time, the session expires and # Amazon Lex deletes any data provided before the timeout. # # You can specify between 60 (1 minute) and 86,400 (24 hours) seconds. # @return [Integer] # # @!attribute [rw] bot_type # The type of the bot to be updated. # @return [String] # # @!attribute [rw] bot_members # The list of bot members in the network associated with the update # action. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotRequest AWS API Documentation # class UpdateBotRequest < Struct.new( :bot_id, :bot_name, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_type, :bot_members) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] bot_id # The unique identifier of the bot that was updated. # @return [String] # # @!attribute [rw] bot_name # The name of the bot after the update. # @return [String] # # @!attribute [rw] description # The description of the bot after the update. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the IAM role used by the bot after # the update. # @return [String] # # @!attribute [rw] data_privacy # The data privacy settings for the bot after the update. # @return [Types::DataPrivacy] # # @!attribute [rw] idle_session_ttl_in_seconds # The session timeout, in seconds, for the bot after the update. # @return [Integer] # # @!attribute [rw] bot_status # Shows the current status of the bot. The bot is first in the # `Creating` status. Once the bot is read for use, it changes to the # `Available` status. After the bot is created, you can use the # `DRAFT` version of the bot. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of the date and time that the bot was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the bot was last updated. # @return [Time] # # @!attribute [rw] bot_type # The type of the bot that was updated. # @return [String] # # @!attribute [rw] bot_members # The list of bot members in the network that was updated. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateBotResponse AWS API Documentation # class UpdateBotResponse < Struct.new( :bot_id, :bot_name, :description, :role_arn, :data_privacy, :idle_session_ttl_in_seconds, :bot_status, :creation_date_time, :last_updated_date_time, :bot_type, :bot_members) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier Amazon Lex assigned to the export. # @return [String] # # @!attribute [rw] file_password # The new password to use to encrypt the export zip archive. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateExportRequest AWS API Documentation # class UpdateExportRequest < Struct.new( :export_id, :file_password) SENSITIVE = [:file_password] include Aws::Structure end # @!attribute [rw] export_id # The unique identifier Amazon Lex assigned to the export. # @return [String] # # @!attribute [rw] resource_specification # A description of the type of resource that was exported, either a # bot or a bot locale. # @return [Types::ExportResourceSpecification] # # @!attribute [rw] file_format # The file format used for the files that define the resource. The # `TSV` format is required to export a custom vocabulary only; # otherwise use `LexJson` format. # @return [String] # # @!attribute [rw] export_status # The status of the export. When the status is `Completed` the export # archive is available for download. # @return [String] # # @!attribute [rw] creation_date_time # The date and time that the export was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time that the export was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateExportResponse AWS API Documentation # class UpdateExportResponse < Struct.new( :export_id, :resource_specification, :file_format, :export_status, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The unique identifier of the intent to update. # @return [String] # # @!attribute [rw] intent_name # The new name for the intent. # @return [String] # # @!attribute [rw] description # The new description of the intent. # @return [String] # # @!attribute [rw] parent_intent_signature # The signature of the new built-in intent to use as the parent of # this intent. # @return [String] # # @!attribute [rw] sample_utterances # New utterances used to invoke the intent. # @return [Array] # # @!attribute [rw] dialog_code_hook # The new Lambda function to use between each turn of the conversation # with the bot. # @return [Types::DialogCodeHookSettings] # # @!attribute [rw] fulfillment_code_hook # The new Lambda function to call when all of the intents required # slots are provided and the intent is ready for fulfillment. # @return [Types::FulfillmentCodeHookSettings] # # @!attribute [rw] slot_priorities # A new list of slots and their priorities that are contained by the # intent. # @return [Array] # # @!attribute [rw] intent_confirmation_setting # New prompts that Amazon Lex sends to the user to confirm the # completion of an intent. # @return [Types::IntentConfirmationSetting] # # @!attribute [rw] intent_closing_setting # The new response that Amazon Lex sends the user when the intent is # closed. # @return [Types::IntentClosingSetting] # # @!attribute [rw] input_contexts # A new list of contexts that must be active in order for Amazon Lex # to consider the intent. # @return [Array] # # @!attribute [rw] output_contexts # A new list of contexts that Amazon Lex activates when the intent is # fulfilled. # @return [Array] # # @!attribute [rw] kendra_configuration # New configuration settings for connecting to an Amazon Kendra index. # @return [Types::KendraConfiguration] # # @!attribute [rw] bot_id # The identifier of the bot that contains the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the intent. Must be `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale where this intent is used. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] initial_response_setting # Configuration settings for a response sent to the user before Amazon # Lex starts eliciting slots. # @return [Types::InitialResponseSetting] # # @!attribute [rw] qn_a_intent_configuration # Specifies the configuration of the built-in `Amazon.QnAIntent`. The # `AMAZON.QnAIntent` intent is called when Amazon Lex can't determine # another intent to invoke. If you specify this field, you can't # specify the `kendraConfiguration` field. # @return [Types::QnAIntentConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateIntentRequest AWS API Documentation # class UpdateIntentRequest < Struct.new( :intent_id, :intent_name, :description, :parent_intent_signature, :sample_utterances, :dialog_code_hook, :fulfillment_code_hook, :slot_priorities, :intent_confirmation_setting, :intent_closing_setting, :input_contexts, :output_contexts, :kendra_configuration, :bot_id, :bot_version, :locale_id, :initial_response_setting, :qn_a_intent_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] intent_id # The identifier of the intent that was updated. # @return [String] # # @!attribute [rw] intent_name # The updated name of the intent. # @return [String] # # @!attribute [rw] description # The updated description of the intent. # @return [String] # # @!attribute [rw] parent_intent_signature # The updated built-in intent that is the parent of this intent. # @return [String] # # @!attribute [rw] sample_utterances # The updated list of sample utterances for the intent. # @return [Array] # # @!attribute [rw] dialog_code_hook # The updated Lambda function called during each turn of the # conversation with the user. # @return [Types::DialogCodeHookSettings] # # @!attribute [rw] fulfillment_code_hook # The updated Lambda function called when the intent is ready for # fulfillment. # @return [Types::FulfillmentCodeHookSettings] # # @!attribute [rw] slot_priorities # The updated list of slots and their priorities that are elicited # from the user for the intent. # @return [Array] # # @!attribute [rw] intent_confirmation_setting # The updated prompts that Amazon Lex sends to the user to confirm the # completion of an intent. # @return [Types::IntentConfirmationSetting] # # @!attribute [rw] intent_closing_setting # The updated response that Amazon Lex sends the user when the intent # is closed. # @return [Types::IntentClosingSetting] # # @!attribute [rw] input_contexts # The updated list of contexts that must be active for the intent to # be considered by Amazon Lex. # @return [Array] # # @!attribute [rw] output_contexts # The updated list of contexts that Amazon Lex activates when the # intent is fulfilled. # @return [Array] # # @!attribute [rw] kendra_configuration # The updated configuration for connecting to an Amazon Kendra index # with the `AMAZON.KendraSearchIntent` intent. # @return [Types::KendraConfiguration] # # @!attribute [rw] bot_id # The identifier of the bot that contains the intent. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the intent. Will always be # `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The updated language and locale of the intent. # @return [String] # # @!attribute [rw] creation_date_time # A timestamp of when the intent was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the last time that the intent was modified. # @return [Time] # # @!attribute [rw] initial_response_setting # Configuration settings for a response sent to the user before Amazon # Lex starts eliciting slots. # @return [Types::InitialResponseSetting] # # @!attribute [rw] qn_a_intent_configuration # Details about the configuration of the built-in `Amazon.QnAIntent`. # @return [Types::QnAIntentConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateIntentResponse AWS API Documentation # class UpdateIntentResponse < Struct.new( :intent_id, :intent_name, :description, :parent_intent_signature, :sample_utterances, :dialog_code_hook, :fulfillment_code_hook, :slot_priorities, :intent_confirmation_setting, :intent_closing_setting, :input_contexts, :output_contexts, :kendra_configuration, :bot_id, :bot_version, :locale_id, :creation_date_time, :last_updated_date_time, :initial_response_setting, :qn_a_intent_configuration) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] policy # A resource policy to add to the resource. The policy is a JSON # structure that contains one or more statements that define the # policy. The policy must follow the IAM syntax. For more information # about the contents of a JSON policy document, see [ IAM JSON policy # reference ][1]. # # If the policy isn't valid, Amazon Lex returns a validation # exception. # # # # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html # @return [String] # # @!attribute [rw] expected_revision_id # The identifier of the revision of the policy to update. If this # revision ID doesn't match the current revision ID, Amazon Lex # throws an exception. # # If you don't specify a revision, Amazon Lex overwrites the contents # of the policy with the new values. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateResourcePolicyRequest AWS API Documentation # class UpdateResourcePolicyRequest < Struct.new( :resource_arn, :policy, :expected_revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the bot or bot alias that the # resource policy is attached to. # @return [String] # # @!attribute [rw] revision_id # The current revision of the resource policy. Use the revision ID to # make sure that you are updating the most current version of a # resource policy when you add a policy statement to a resource, # delete a resource, or update a resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateResourcePolicyResponse AWS API Documentation # class UpdateResourcePolicyResponse < Struct.new( :resource_arn, :revision_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The unique identifier for the slot to update. # @return [String] # # @!attribute [rw] slot_name # The new name for the slot. # @return [String] # # @!attribute [rw] description # The new description for the slot. # @return [String] # # @!attribute [rw] slot_type_id # The unique identifier of the new slot type to associate with this # slot. # @return [String] # # @!attribute [rw] value_elicitation_setting # A new set of prompts that Amazon Lex sends to the user to elicit a # response the provides a value for the slot. # @return [Types::SlotValueElicitationSetting] # # @!attribute [rw] obfuscation_setting # New settings that determine how slot values are formatted in Amazon # CloudWatch logs. # @return [Types::ObfuscationSetting] # # @!attribute [rw] bot_id # The unique identifier of the bot that contains the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot. Must always be # `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that contains the slot. # The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] intent_id # The identifier of the intent that contains the slot. # @return [String] # # @!attribute [rw] multiple_values_setting # Determines whether the slot accepts multiple values in one response. # Multiple value slots are only available in the en-US locale. If you # set this value to `true` in any other locale, Amazon Lex throws a # `ValidationException`. # # If the `multipleValuesSetting` is not set, the default value is # `false`. # @return [Types::MultipleValuesSetting] # # @!attribute [rw] sub_slot_setting # Specifications for the constituent sub slots and the expression for # the composite slot. # @return [Types::SubSlotSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotRequest AWS API Documentation # class UpdateSlotRequest < Struct.new( :slot_id, :slot_name, :description, :slot_type_id, :value_elicitation_setting, :obfuscation_setting, :bot_id, :bot_version, :locale_id, :intent_id, :multiple_values_setting, :sub_slot_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_id # The unique identifier of the slot that was updated. # @return [String] # # @!attribute [rw] slot_name # The updated name of the slot. # @return [String] # # @!attribute [rw] description # The updated description of the bot. # @return [String] # # @!attribute [rw] slot_type_id # The updated identifier of the slot type that provides values for the # slot. # @return [String] # # @!attribute [rw] value_elicitation_setting # The updated prompts that Amazon Lex sends to the user to elicit a # response that provides a value for the slot. # @return [Types::SlotValueElicitationSetting] # # @!attribute [rw] obfuscation_setting # The updated setting that determines whether the slot value is # obfuscated in the Amazon CloudWatch logs. # @return [Types::ObfuscationSetting] # # @!attribute [rw] bot_id # The identifier of the bot that contains the slot. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot. Will always be # `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The locale that contains the slot. # @return [String] # # @!attribute [rw] intent_id # The intent that contains the slot. # @return [String] # # @!attribute [rw] creation_date_time # The timestamp of the date and time that the slot was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # The timestamp of the date and time that the slot was last updated. # @return [Time] # # @!attribute [rw] multiple_values_setting # Indicates whether the slot accepts multiple values in one response. # @return [Types::MultipleValuesSetting] # # @!attribute [rw] sub_slot_setting # Specifications for the constituent sub slots and the expression for # the composite slot. # @return [Types::SubSlotSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotResponse AWS API Documentation # class UpdateSlotResponse < Struct.new( :slot_id, :slot_name, :description, :slot_type_id, :value_elicitation_setting, :obfuscation_setting, :bot_id, :bot_version, :locale_id, :intent_id, :creation_date_time, :last_updated_date_time, :multiple_values_setting, :sub_slot_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The unique identifier of the slot type to update. # @return [String] # # @!attribute [rw] slot_type_name # The new name of the slot type. # @return [String] # # @!attribute [rw] description # The new description of the slot type. # @return [String] # # @!attribute [rw] slot_type_values # A new list of values and their optional synonyms that define the # values that the slot type can take. # @return [Array] # # @!attribute [rw] value_selection_setting # The strategy that Amazon Lex should use when deciding on a value # from the list of slot type values. # @return [Types::SlotValueSelectionSetting] # # @!attribute [rw] parent_slot_type_signature # The new built-in slot type that should be used as the parent of this # slot type. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot that contains the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot type. Must be `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The identifier of the language and locale that contains the slot # type. The string must match one of the supported locales. For more # information, see [Supported languages][1]. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html # @return [String] # # @!attribute [rw] external_source_setting # Provides information about the external source of the slot type's # definition. # @return [Types::ExternalSourceSetting] # # @!attribute [rw] composite_slot_type_setting # Specifications for a composite slot type. # @return [Types::CompositeSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotTypeRequest AWS API Documentation # class UpdateSlotTypeRequest < Struct.new( :slot_type_id, :slot_type_name, :description, :slot_type_values, :value_selection_setting, :parent_slot_type_signature, :bot_id, :bot_version, :locale_id, :external_source_setting, :composite_slot_type_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] slot_type_id # The unique identifier of the updated slot type. # @return [String] # # @!attribute [rw] slot_type_name # The updated name of the slot type. # @return [String] # # @!attribute [rw] description # The updated description of the slot type. # @return [String] # # @!attribute [rw] slot_type_values # The updated values that the slot type provides. # @return [Array] # # @!attribute [rw] value_selection_setting # The updated strategy that Amazon Lex uses to determine which value # to select from the slot type. # @return [Types::SlotValueSelectionSetting] # # @!attribute [rw] parent_slot_type_signature # The updated signature of the built-in slot type that is the parent # of this slot type. # @return [String] # # @!attribute [rw] bot_id # The identifier of the bot that contains the slot type. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that contains the slot type. This is always # `DRAFT`. # @return [String] # # @!attribute [rw] locale_id # The language and locale of the updated slot type. # @return [String] # # @!attribute [rw] creation_date_time # The timestamp of the date and time that the slot type was created. # @return [Time] # # @!attribute [rw] last_updated_date_time # A timestamp of the date and time that the slot type was last # updated. # @return [Time] # # @!attribute [rw] external_source_setting # Provides information about the external source of the slot type's # definition. # @return [Types::ExternalSourceSetting] # # @!attribute [rw] composite_slot_type_setting # Specifications for a composite slot type. # @return [Types::CompositeSlotTypeSetting] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotTypeResponse AWS API Documentation # class UpdateSlotTypeResponse < Struct.new( :slot_type_id, :slot_type_name, :description, :slot_type_values, :value_selection_setting, :parent_slot_type_signature, :bot_id, :bot_version, :locale_id, :creation_date_time, :last_updated_date_time, :external_source_setting, :composite_slot_type_setting) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for which update test operation to be performed. # @return [String] # # @!attribute [rw] test_set_name # The new test set name. # @return [String] # # @!attribute [rw] description # The new test set description. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateTestSetRequest AWS API Documentation # class UpdateTestSetRequest < Struct.new( :test_set_id, :test_set_name, :description) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] test_set_id # The test set Id for which update test operation to be performed. # @return [String] # # @!attribute [rw] test_set_name # The test set name for the updated test set. # @return [String] # # @!attribute [rw] description # The test set description for the updated test set. # @return [String] # # @!attribute [rw] modality # Indicates whether audio or text is used for the updated test set. # @return [String] # # @!attribute [rw] status # The status for the updated test set. # @return [String] # # @!attribute [rw] role_arn # The roleARN used for any operation in the test set to access # resources in the Amazon Web Services account. # @return [String] # # @!attribute [rw] num_turns # The number of conversation turns from the updated test set. # @return [Integer] # # @!attribute [rw] storage_location # The Amazon S3 storage location for the updated test set. # @return [Types::TestSetStorageLocation] # # @!attribute [rw] creation_date_time # The creation date and time for the updated test set. # @return [Time] # # @!attribute [rw] last_updated_date_time # The date and time of the last update for the updated test set. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateTestSetResponse AWS API Documentation # class UpdateTestSetResponse < Struct.new( :test_set_id, :test_set_name, :description, :modality, :status, :role_arn, :num_turns, :storage_location, :creation_date_time, :last_updated_date_time) SENSITIVE = [] include Aws::Structure end # Contains information about the user messages in the turn in the input. # # @!attribute [rw] utterance_input # The utterance input in the user turn. # @return [Types::UtteranceInputSpecification] # # @!attribute [rw] request_attributes # Request attributes of the user turn. # @return [Hash] # # @!attribute [rw] session_state # Contains information about the session state in the input. # @return [Types::InputSessionStateSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnInputSpecification AWS API Documentation # class UserTurnInputSpecification < Struct.new( :utterance_input, :request_attributes, :session_state) SENSITIVE = [] include Aws::Structure end # Contains information about the intent that is output for the turn by # the test execution. # # @!attribute [rw] name # The name of the intent. # @return [String] # # @!attribute [rw] slots # The slots associated with the intent. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnIntentOutput AWS API Documentation # class UserTurnIntentOutput < Struct.new( :name, :slots) SENSITIVE = [] include Aws::Structure end # Contains results that are output for the user turn by the test # execution. # # @!attribute [rw] intent # Contains information about the intent. # @return [Types::UserTurnIntentOutput] # # @!attribute [rw] active_contexts # The contexts that are active in the turn. # @return [Array] # # @!attribute [rw] transcript # The transcript that is output for the user turn by the test # execution. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnOutputSpecification AWS API Documentation # class UserTurnOutputSpecification < Struct.new( :intent, :active_contexts, :transcript) SENSITIVE = [] include Aws::Structure end # Contains the results for the user turn by the test execution. # # @!attribute [rw] input # Contains information about the user messages in the turn in the # input. # @return [Types::UserTurnInputSpecification] # # @!attribute [rw] expected_output # Contains information about the expected output for the user turn. # @return [Types::UserTurnOutputSpecification] # # @!attribute [rw] actual_output # Contains information about the actual output for the user turn. # @return [Types::UserTurnOutputSpecification] # # @!attribute [rw] error_details # Details about an error in an execution of a test set. # @return [Types::ExecutionErrorDetails] # # @!attribute [rw] end_to_end_result # Specifies whether the expected and actual outputs match or not, or # if there is an error in execution. # @return [String] # # @!attribute [rw] intent_match_result # Specifies whether the expected and actual intents match or not. # @return [String] # # @!attribute [rw] slot_match_result # Specifies whether the expected and actual slots match or not. # @return [String] # # @!attribute [rw] speech_transcription_result # Specifies whether the expected and actual speech transcriptions # match or not, or if there is an error in execution. # @return [String] # # @!attribute [rw] conversation_level_result # Contains information about the results related to the conversation # associated with the user turn. # @return [Types::ConversationLevelResultDetail] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnResult AWS API Documentation # class UserTurnResult < Struct.new( :input, :expected_output, :actual_output, :error_details, :end_to_end_result, :intent_match_result, :slot_match_result, :speech_transcription_result, :conversation_level_result) SENSITIVE = [] include Aws::Structure end # Contains information about a slot output by the test set execution. # # @!attribute [rw] value # The value output by the slot recognition. # @return [String] # # @!attribute [rw] values # Values that are output by the slot recognition. # @return [Array] # # @!attribute [rw] sub_slots # A list of items mapping the name of the subslots to information # about those subslots. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnSlotOutput AWS API Documentation # class UserTurnSlotOutput < Struct.new( :value, :values, :sub_slots) SENSITIVE = [] include Aws::Structure end # Contains information about the expected and input values for the user # turn. # # @!attribute [rw] input # Contains information about the user messages in the turn in the # input. # @return [Types::UserTurnInputSpecification] # # @!attribute [rw] expected # Contains results about the expected output for the user turn. # @return [Types::UserTurnOutputSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UserTurnSpecification AWS API Documentation # class UserTurnSpecification < Struct.new( :input, :expected) SENSITIVE = [] include Aws::Structure end # Provides parameters for setting the time window and duration for # aggregating utterance data. # # @!attribute [rw] relative_aggregation_duration # The desired time window for aggregating utterances. # @return [Types::RelativeAggregationDuration] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceAggregationDuration AWS API Documentation # class UtteranceAggregationDuration < Struct.new( :relative_aggregation_duration) SENSITIVE = [] include Aws::Structure end # Contains information about the audio for an utterance. # # @!attribute [rw] audio_file_s3_location # Amazon S3 file pointing to the audio. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceAudioInputSpecification AWS API Documentation # class UtteranceAudioInputSpecification < Struct.new( :audio_file_s3_location) SENSITIVE = [] include Aws::Structure end # An object that contains a response to the utterance from the bot. # # @!attribute [rw] content # The text of the response to the utterance from the bot. # @return [String] # # @!attribute [rw] content_type # The type of the response. The following values are possible: # # * `PlainText` – A plain text string. # # * `CustomPayload` – A response string that you can customize to # include data or metadata for your application. # # * `SSML` – A string that includes Speech Synthesis Markup Language # to customize the audio response. # # * `ImageResponseCard` – An image with buttons that the customer can # select. See [ImageResponseCard][1] for more information. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html # @return [String] # # @!attribute [rw] image_response_card # A card that is shown to the user by a messaging platform. You define # the contents of the card, the card is displayed by the platform. # # When you use a response card, the response from the user is # constrained to the text associated with a button on the card. # @return [Types::ImageResponseCard] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceBotResponse AWS API Documentation # class UtteranceBotResponse < Struct.new( :content, :content_type, :image_response_card) SENSITIVE = [] include Aws::Structure end # An object specifying the measure and method by which to sort the # utterance data. # # @!attribute [rw] name # The measure by which to sort the utterance analytics data. # # * `Count` – The number of utterances. # # * `UtteranceTimestamp` – The date and time of the utterance. # @return [String] # # @!attribute [rw] order # Specifies whether to sort the results in ascending or descending # order. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceDataSortBy AWS API Documentation # class UtteranceDataSortBy < Struct.new( :name, :order) SENSITIVE = [] include Aws::Structure end # Contains information about input of an utterance. # # @!attribute [rw] text_input # A text input transcription of the utterance. It is only applicable # for test-sets containing text data. # @return [String] # # @!attribute [rw] audio_input # Contains information about the audio input for an utterance. # @return [Types::UtteranceAudioInputSpecification] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceInputSpecification AWS API Documentation # class UtteranceInputSpecification < Struct.new( :text_input, :audio_input) SENSITIVE = [] include Aws::Structure end # Contains information about multiple utterances in the results of a # test set execution. # # @!attribute [rw] record_number # The record number of the result. # @return [Integer] # # @!attribute [rw] conversation_id # The unique identifier for the conversation associated with the # result. # @return [String] # # @!attribute [rw] turn_result # Contains information about the turn associated with the result. # @return [Types::TestSetTurnResult] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceLevelTestResultItem AWS API Documentation # class UtteranceLevelTestResultItem < Struct.new( :record_number, :conversation_id, :turn_result) SENSITIVE = [] include Aws::Structure end # Contains information about the utterances in the results of the test # set execution. # # @!attribute [rw] items # Contains information about an utterance in the results of the test # set execution. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceLevelTestResults AWS API Documentation # class UtteranceLevelTestResults < Struct.new( :items) SENSITIVE = [] include Aws::Structure end # An object containing information about a specific utterance. # # @!attribute [rw] bot_alias_id # The identifier of the alias of the bot that the utterance was made # to. # @return [String] # # @!attribute [rw] bot_version # The version of the bot that the utterance was made to. # @return [String] # # @!attribute [rw] locale_id # The locale of the bot that the utterance was made to. # @return [String] # # @!attribute [rw] session_id # The identifier of the session that the utterance was made in. # @return [String] # # @!attribute [rw] channel # The channel that is integrated with the bot that the utterance was # made to. # @return [String] # # @!attribute [rw] mode # The mode of the session. The possible values are as follows: # # * `Speech` – The session consisted of spoken dialogue. # # * `Text` – The session consisted of written dialogue. # # * `DTMF` – The session consisted of touch-tone keypad (Dual Tone # Multi-Frequency) key presses. # # * `MultiMode` – The session consisted of multiple modes. # @return [String] # # @!attribute [rw] conversation_start_time # The date and time when the conversation in which the utterance took # place began. A conversation is defined as a unique combination of a # `sessionId` and an `originatingRequestId`. # @return [Time] # # @!attribute [rw] conversation_end_time # The date and time when the conversation in which the utterance took # place ended. A conversation is defined as a unique combination of a # `sessionId` and an `originatingRequestId`. # @return [Time] # # @!attribute [rw] utterance # The text of the utterance. # @return [String] # # @!attribute [rw] utterance_timestamp # The date and time when the utterance took place. # @return [Time] # # @!attribute [rw] audio_voice_duration_millis # The duration in milliseconds of the audio associated with the # utterance. # @return [Integer] # # @!attribute [rw] utterance_understood # Specifies whether the bot understood the utterance or not. # @return [Boolean] # # @!attribute [rw] input_type # The input type of the utterance. The possible values are as follows: # # * PCM format: audio data must be in little-endian byte order. # # * `audio/l16; rate=16000; channels=1` # # * `audio/x-l16; sample-rate=16000; channel-count=1` # # * `audio/lpcm; sample-rate=8000; sample-size-bits=16; # channel-count=1; is-big-endian=false` # # * Opus format # # * `audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4` # # ^ # # * Text format # # * `text/plain; charset=utf-8` # # ^ # @return [String] # # @!attribute [rw] output_type # The output type of the utterance. The possible values are as # follows: # # * `audio/mpeg` # # * `audio/ogg` # # * `audio/pcm (16 KHz)` # # * `audio/` (defaults to `mpeg`) # # * `text/plain; charset=utf-8` # @return [String] # # @!attribute [rw] associated_intent_name # The name of the intent that the utterance is associated to. # @return [String] # # @!attribute [rw] associated_slot_name # The name of the slot that the utterance is associated to. # @return [String] # # @!attribute [rw] intent_state # The state of the intent that the utterance is associated to. # @return [String] # # @!attribute [rw] dialog_action_type # The type of dialog action that the utterance is associated to. See # the `type` field in [DialogAction][1] for more information. # # # # [1]: https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html # @return [String] # # @!attribute [rw] bot_response_audio_voice_id # The identifier for the audio of the bot response. # @return [String] # # @!attribute [rw] slots_filled_in_session # The slots that have been filled in the session by the time of the # utterance. # @return [String] # # @!attribute [rw] utterance_request_id # The identifier of the request associated with the utterance. # @return [String] # # @!attribute [rw] bot_responses # A list of objects containing information about the bot response to # the utterance. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UtteranceSpecification AWS API Documentation # class UtteranceSpecification < Struct.new( :bot_alias_id, :bot_version, :locale_id, :session_id, :channel, :mode, :conversation_start_time, :conversation_end_time, :utterance, :utterance_timestamp, :audio_voice_duration_millis, :utterance_understood, :input_type, :output_type, :associated_intent_name, :associated_slot_name, :intent_state, :dialog_action_type, :bot_response_audio_voice_id, :slots_filled_in_session, :utterance_request_id, :bot_responses) SENSITIVE = [] include Aws::Structure end # One of the input parameters in your request isn't valid. Check the # parameters and try your request again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Defines settings for using an Amazon Polly voice to communicate with a # user. # # Valid values include: # # * `standard` # # * `neural` # # * `long-form` # # * `generative` # # @!attribute [rw] voice_id # The identifier of the Amazon Polly voice to use. # @return [String] # # @!attribute [rw] engine # Indicates the type of Amazon Polly voice that Amazon Lex should use # for voice interaction with the user. For more information, see the [ # `engine` parameter of the `SynthesizeSpeech` operation][1] in the # *Amazon Polly developer guide*. # # If you do not specify a value, the default is `standard`. # # # # [1]: https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/VoiceSettings AWS API Documentation # class VoiceSettings < Struct.new( :voice_id, :engine) SENSITIVE = [] include Aws::Structure end # Specifies the prompts that Amazon Lex uses while a bot is waiting for # customer input. # # @!attribute [rw] waiting_response # The response that Amazon Lex sends to indicate that the bot is # waiting for the conversation to continue. # @return [Types::ResponseSpecification] # # @!attribute [rw] continue_response # The response that Amazon Lex sends to indicate that the bot is ready # to continue the conversation. # @return [Types::ResponseSpecification] # # @!attribute [rw] still_waiting_response # A response that Amazon Lex sends periodically to the user to # indicate that the bot is still waiting for input from the user. # @return [Types::StillWaitingResponseSpecification] # # @!attribute [rw] active # Specifies whether the bot will wait for a user to respond. When this # field is false, wait and continue responses for a slot aren't used. # If the `active` field isn't specified, the default is true. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/WaitAndContinueSpecification AWS API Documentation # class WaitAndContinueSpecification < Struct.new( :waiting_response, :continue_response, :still_waiting_response, :active) SENSITIVE = [] include Aws::Structure end end end