types

package
v1.43.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveContext added in v1.29.0 

type ActiveContext struct {

	// The name of active context.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The active context used in the test execution.

type AdvancedRecognitionSetting added in v1.17.0 

type AdvancedRecognitionSetting struct {

	// Enables using the slot values as a custom vocabulary for recognizing user
	// utterances.
	AudioRecognitionStrategy AudioRecognitionStrategy
	// contains filtered or unexported fields
}

Provides settings that enable advanced recognition settings for slot values.

type AgentTurnResult added in v1.29.0 

type AgentTurnResult struct {

	// The expected agent prompt for the agent turn in a test set execution.
	//
	// This member is required.
	ExpectedAgentPrompt *string

	// The actual agent prompt for the agent turn in a test set execution.
	ActualAgentPrompt *string

	// The actual elicited slot for the agent turn in a test set execution.
	ActualElicitedSlot *string

	// The actual intent for the agent turn in a test set execution.
	ActualIntent *string

	// Details about an error in an execution of a test set.
	ErrorDetails *ExecutionErrorDetails
	// contains filtered or unexported fields
}

The information about the agent turn in a test set execution.

type AgentTurnSpecification added in v1.29.0 

type AgentTurnSpecification struct {

	// The agent prompt for the agent turn in a test set.
	//
	// This member is required.
	AgentPrompt *string
	// contains filtered or unexported fields
}

The specification of an agent turn.

type AggregatedUtterancesFilter added in v1.8.0 

type AggregatedUtterancesFilter struct {

	// The name of the field to filter the utterance list.
	//
	// This member is required.
	Name AggregatedUtterancesFilterName

	// 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.
	//
	// This member is required.
	Operator AggregatedUtterancesFilterOperator

	// The value to use for filtering the list of bots.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters responses returned by the ListAggregatedUtterances operation.

type AggregatedUtterancesFilterName added in v1.8.0 

type AggregatedUtterancesFilterName string
const (
	AggregatedUtterancesFilterNameUtterance AggregatedUtterancesFilterName = "Utterance"
)

Enum values for AggregatedUtterancesFilterName

func (AggregatedUtterancesFilterName) Values added in v1.8.0 

func (AggregatedUtterancesFilterName) Values() []AggregatedUtterancesFilterName

Values returns all known values for AggregatedUtterancesFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AggregatedUtterancesFilterOperator added in v1.8.0 

type AggregatedUtterancesFilterOperator string
const (
	AggregatedUtterancesFilterOperatorContains AggregatedUtterancesFilterOperator = "CO"
	AggregatedUtterancesFilterOperatorEquals   AggregatedUtterancesFilterOperator = "EQ"
)

Enum values for AggregatedUtterancesFilterOperator

func (AggregatedUtterancesFilterOperator) Values added in v1.8.0 

func (AggregatedUtterancesFilterOperator) Values() []AggregatedUtterancesFilterOperator

Values returns all known values for AggregatedUtterancesFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AggregatedUtterancesSortAttribute added in v1.8.0 

type AggregatedUtterancesSortAttribute string
const (
	AggregatedUtterancesSortAttributeHitCount    AggregatedUtterancesSortAttribute = "HitCount"
	AggregatedUtterancesSortAttributeMissedCount AggregatedUtterancesSortAttribute = "MissedCount"
)

Enum values for AggregatedUtterancesSortAttribute

func (AggregatedUtterancesSortAttribute) Values added in v1.8.0 

func (AggregatedUtterancesSortAttribute) Values() []AggregatedUtterancesSortAttribute

Values returns all known values for AggregatedUtterancesSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AggregatedUtterancesSortBy added in v1.8.0 

type AggregatedUtterancesSortBy struct {

	// The utterance attribute to sort by.
	//
	// This member is required.
	Attribute AggregatedUtterancesSortAttribute

	// Specifies whether to sort the aggregated utterances in ascending or descending
	// order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of utterances.

type AggregatedUtterancesSummary added in v1.8.0 

type AggregatedUtterancesSummary struct {

	// 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.
	ContainsDataFromDeletedResources *bool

	// 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.
	HitCount *int32

	// 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.
	MissedCount *int32

	// The text of the utterance. If the utterance was used with the RecognizeUtterance
	// operation, the text is the transcription of the audio utterance.
	Utterance *string

	// 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.
	UtteranceFirstRecordedInAggregationDuration *time.Time

	// 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.
	UtteranceLastRecordedInAggregationDuration *time.Time
	// contains filtered or unexported fields
}

Provides summary information for aggregated utterances. The ListAggregatedUtterances operations combines all instances of the same utterance into a single aggregated summary.

type AllowedInputTypes added in v1.25.0 

type AllowedInputTypes struct {

	// Indicates whether audio input is allowed.
	//
	// This member is required.
	AllowAudioInput *bool

	// Indicates whether DTMF input is allowed.
	//
	// This member is required.
	AllowDTMFInput *bool
	// contains filtered or unexported fields
}

Specifies the allowed input types.

type AnalyticsBinByName added in v1.30.0 

type AnalyticsBinByName string
const (
	AnalyticsBinByNameConversationStartTime AnalyticsBinByName = "ConversationStartTime"
	AnalyticsBinByNameUtteranceTimestamp    AnalyticsBinByName = "UtteranceTimestamp"
)

Enum values for AnalyticsBinByName

func (AnalyticsBinByName) Values added in v1.30.0 

func (AnalyticsBinByName) Values() []AnalyticsBinByName

Values returns all known values for AnalyticsBinByName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsBinBySpecification added in v1.30.0 

type AnalyticsBinBySpecification struct {

	// Specifies the interval of time by which to bin the analytics data.
	//
	// This member is required.
	Interval AnalyticsInterval

	// Specifies the time metric by which to bin the analytics data.
	//
	// This member is required.
	Name AnalyticsBinByName

	// 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.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

Contains the time metric, interval, and method by which to bin the analytics data.

type AnalyticsBinKey added in v1.30.0 

type AnalyticsBinKey struct {

	// The criterion by which to bin the results.
	Name AnalyticsBinByName

	// The value of the criterion that defines the bin.
	Value *int64
	// contains filtered or unexported fields
}

An object containing the criterion by which to bin the results and the value that defines that bin.

type AnalyticsCommonFilterName added in v1.30.0 

type AnalyticsCommonFilterName string
const (
	AnalyticsCommonFilterNameBotAliasId AnalyticsCommonFilterName = "BotAliasId"
	AnalyticsCommonFilterNameBotVersion AnalyticsCommonFilterName = "BotVersion"
	AnalyticsCommonFilterNameLocaleId   AnalyticsCommonFilterName = "LocaleId"
	AnalyticsCommonFilterNameModality   AnalyticsCommonFilterName = "Modality"
	AnalyticsCommonFilterNameChannel    AnalyticsCommonFilterName = "Channel"
)

Enum values for AnalyticsCommonFilterName

func (AnalyticsCommonFilterName) Values added in v1.30.0 

func (AnalyticsCommonFilterName) Values() []AnalyticsCommonFilterName

Values returns all known values for AnalyticsCommonFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsFilterOperator added in v1.30.0 

type AnalyticsFilterOperator string
const (
	AnalyticsFilterOperatorEquals      AnalyticsFilterOperator = "EQ"
	AnalyticsFilterOperatorGreaterThan AnalyticsFilterOperator = "GT"
	AnalyticsFilterOperatorLessThan    AnalyticsFilterOperator = "LT"
)

Enum values for AnalyticsFilterOperator

func (AnalyticsFilterOperator) Values added in v1.30.0 

func (AnalyticsFilterOperator) Values() []AnalyticsFilterOperator

Values returns all known values for AnalyticsFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentField added in v1.30.0 

type AnalyticsIntentField string
const (
	AnalyticsIntentFieldIntentName     AnalyticsIntentField = "IntentName"
	AnalyticsIntentFieldIntentEndState AnalyticsIntentField = "IntentEndState"
	AnalyticsIntentFieldIntentLevel    AnalyticsIntentField = "IntentLevel"
)

Enum values for AnalyticsIntentField

func (AnalyticsIntentField) Values added in v1.30.0 

func (AnalyticsIntentField) Values() []AnalyticsIntentField

Values returns all known values for AnalyticsIntentField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentFilter added in v1.30.0 

type AnalyticsIntentFilter struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsIntentFilterName

	// 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 .
	//
	// This member is required.
	Operator AnalyticsFilterOperator

	// 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 .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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 .

type AnalyticsIntentFilterName added in v1.30.0 

type AnalyticsIntentFilterName string
const (
	AnalyticsIntentFilterNameBotAliasId           AnalyticsIntentFilterName = "BotAliasId"
	AnalyticsIntentFilterNameBotVersion           AnalyticsIntentFilterName = "BotVersion"
	AnalyticsIntentFilterNameLocaleId             AnalyticsIntentFilterName = "LocaleId"
	AnalyticsIntentFilterNameModality             AnalyticsIntentFilterName = "Modality"
	AnalyticsIntentFilterNameChannel              AnalyticsIntentFilterName = "Channel"
	AnalyticsIntentFilterNameSessionId            AnalyticsIntentFilterName = "SessionId"
	AnalyticsIntentFilterNameOriginatingRequestId AnalyticsIntentFilterName = "OriginatingRequestId"
	AnalyticsIntentFilterNameIntentName           AnalyticsIntentFilterName = "IntentName"
	AnalyticsIntentFilterNameIntentEndState       AnalyticsIntentFilterName = "IntentEndState"
)

Enum values for AnalyticsIntentFilterName

func (AnalyticsIntentFilterName) Values added in v1.30.0 

func (AnalyticsIntentFilterName) Values() []AnalyticsIntentFilterName

Values returns all known values for AnalyticsIntentFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentGroupByKey added in v1.30.0 

type AnalyticsIntentGroupByKey struct {

	// A category by which the intent analytics were grouped.
	Name AnalyticsIntentField

	// A member of the category by which the intent analytics were grouped.
	Value *string
	// contains filtered or unexported fields
}

Contains the category by which the intent analytics were grouped and a member of that category.

type AnalyticsIntentGroupBySpecification added in v1.30.0 

type AnalyticsIntentGroupBySpecification struct {

	// Specifies whether to group the intent stages by their name or their end state.
	//
	// This member is required.
	Name AnalyticsIntentField
	// contains filtered or unexported fields
}

Contains the category by which to group the intents.

type AnalyticsIntentMetric added in v1.30.0 

type AnalyticsIntentMetric struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsIntentMetricName

	// 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 .
	//
	// This member is required.
	Statistic AnalyticsMetricStatistic

	// Specifies whether to sort the results in ascending or descending order.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

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.

type AnalyticsIntentMetricName added in v1.30.0 

type AnalyticsIntentMetricName string
const (
	AnalyticsIntentMetricNameCount    AnalyticsIntentMetricName = "Count"
	AnalyticsIntentMetricNameSuccess  AnalyticsIntentMetricName = "Success"
	AnalyticsIntentMetricNameFailure  AnalyticsIntentMetricName = "Failure"
	AnalyticsIntentMetricNameSwitched AnalyticsIntentMetricName = "Switched"
	AnalyticsIntentMetricNameDropped  AnalyticsIntentMetricName = "Dropped"
)

Enum values for AnalyticsIntentMetricName

func (AnalyticsIntentMetricName) Values added in v1.30.0 

func (AnalyticsIntentMetricName) Values() []AnalyticsIntentMetricName

Values returns all known values for AnalyticsIntentMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentMetricResult added in v1.30.0 

type AnalyticsIntentMetricResult struct {

	// The metric that you requested. See Key definitions (https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html)
	// 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.
	Name AnalyticsIntentMetricName

	// 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 .
	Statistic AnalyticsMetricStatistic

	// The value of the summary statistic for the metric that you requested.
	Value *float64
	// contains filtered or unexported fields
}

An object containing the results for the intent metric you requested.

type AnalyticsIntentNodeSummary added in v1.30.0 

type AnalyticsIntentNodeSummary struct {

	// The total number of sessions that follow the given path to the given intent.
	IntentCount *int32

	// The number of intents up to and including the requested path.
	IntentLevel *int32

	// The name of the intent at the end of the requested path.
	IntentName *string

	// The path.
	IntentPath *string

	// Specifies whether the node is the end of a path ( Exit ) or not ( Inner ).
	NodeType AnalyticsNodeType
	// contains filtered or unexported fields
}

An object containing information about the requested path.

type AnalyticsIntentResult added in v1.30.0 

type AnalyticsIntentResult struct {

	// A list of objects containing the criteria you requested for binning results and
	// the values of the bins.
	BinKeys []AnalyticsBinKey

	// A list of objects containing the criteria you requested for grouping results
	// and the values of the groups.
	GroupByKeys []AnalyticsIntentGroupByKey

	// 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.
	MetricsResults []AnalyticsIntentMetricResult
	// contains filtered or unexported fields
}

An object containing the results for the intent metrics you requested and the bin and/or group(s) they refer to, if applicable.

type AnalyticsIntentStageField added in v1.30.0 

type AnalyticsIntentStageField string
const (
	AnalyticsIntentStageFieldIntentStageName  AnalyticsIntentStageField = "IntentStageName"
	AnalyticsIntentStageFieldSwitchedToIntent AnalyticsIntentStageField = "SwitchedToIntent"
)

Enum values for AnalyticsIntentStageField

func (AnalyticsIntentStageField) Values added in v1.30.0 

func (AnalyticsIntentStageField) Values() []AnalyticsIntentStageField

Values returns all known values for AnalyticsIntentStageField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentStageFilter added in v1.30.0 

type AnalyticsIntentStageFilter struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsIntentStageFilterName

	// 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 .
	//
	// This member is required.
	Operator AnalyticsFilterOperator

	// 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 .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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 .

type AnalyticsIntentStageFilterName added in v1.30.0 

type AnalyticsIntentStageFilterName string
const (
	AnalyticsIntentStageFilterNameBotAliasId           AnalyticsIntentStageFilterName = "BotAliasId"
	AnalyticsIntentStageFilterNameBotVersion           AnalyticsIntentStageFilterName = "BotVersion"
	AnalyticsIntentStageFilterNameLocaleId             AnalyticsIntentStageFilterName = "LocaleId"
	AnalyticsIntentStageFilterNameModality             AnalyticsIntentStageFilterName = "Modality"
	AnalyticsIntentStageFilterNameChannel              AnalyticsIntentStageFilterName = "Channel"
	AnalyticsIntentStageFilterNameSessionId            AnalyticsIntentStageFilterName = "SessionId"
	AnalyticsIntentStageFilterNameOriginatingRequestId AnalyticsIntentStageFilterName = "OriginatingRequestId"
	AnalyticsIntentStageFilterNameIntentName           AnalyticsIntentStageFilterName = "IntentName"
	AnalyticsIntentStageFilterNameIntentStageName      AnalyticsIntentStageFilterName = "IntentStageName"
)

Enum values for AnalyticsIntentStageFilterName

func (AnalyticsIntentStageFilterName) Values added in v1.30.0 

func (AnalyticsIntentStageFilterName) Values() []AnalyticsIntentStageFilterName

Values returns all known values for AnalyticsIntentStageFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentStageGroupByKey added in v1.30.0 

type AnalyticsIntentStageGroupByKey struct {

	// A category by which the intent stage analytics were grouped.
	Name AnalyticsIntentStageField

	// A member of the category by which the intent stage analytics were grouped.
	Value *string
	// contains filtered or unexported fields
}

Contains the category by which the intent stage analytics and the values for that category were grouped.

type AnalyticsIntentStageGroupBySpecification added in v1.30.0 

type AnalyticsIntentStageGroupBySpecification struct {

	// Specifies whether to group the intent stages by their name or the intent to
	// which the session was switched.
	//
	// This member is required.
	Name AnalyticsIntentStageField
	// contains filtered or unexported fields
}

Contains the category by which to group the intent stages.

type AnalyticsIntentStageMetric added in v1.30.0 

type AnalyticsIntentStageMetric struct {

	// The metric for which you want to get intent stage summary statistics. See Key
	// definitions (https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html)
	// 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.
	//
	// This member is required.
	Name AnalyticsIntentStageMetricName

	// 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 .
	//
	// This member is required.
	Statistic AnalyticsMetricStatistic

	// Specifies whether to sort the results in ascending or descending order of the
	// summary statistic ( value in the response).
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

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.

type AnalyticsIntentStageMetricName added in v1.30.0 

type AnalyticsIntentStageMetricName string
const (
	AnalyticsIntentStageMetricNameCount   AnalyticsIntentStageMetricName = "Count"
	AnalyticsIntentStageMetricNameSuccess AnalyticsIntentStageMetricName = "Success"
	AnalyticsIntentStageMetricNameFailed  AnalyticsIntentStageMetricName = "Failed"
	AnalyticsIntentStageMetricNameDropped AnalyticsIntentStageMetricName = "Dropped"
	AnalyticsIntentStageMetricNameRetry   AnalyticsIntentStageMetricName = "Retry"
)

Enum values for AnalyticsIntentStageMetricName

func (AnalyticsIntentStageMetricName) Values added in v1.30.0 

func (AnalyticsIntentStageMetricName) Values() []AnalyticsIntentStageMetricName

Values returns all known values for AnalyticsIntentStageMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsIntentStageMetricResult added in v1.30.0 

type AnalyticsIntentStageMetricResult struct {

	// 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.
	Name AnalyticsIntentStageMetricName

	// 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 .
	Statistic AnalyticsMetricStatistic

	// The value of the summary statistic for the metric that you requested.
	Value *float64
	// contains filtered or unexported fields
}

An object containing the results for an intent stage metric you requested.

type AnalyticsIntentStageResult added in v1.30.0 

type AnalyticsIntentStageResult struct {

	// A list of objects containing the criteria you requested for binning results and
	// the values of the bins.
	BinKeys []AnalyticsBinKey

	// A list of objects containing the criteria you requested for grouping results
	// and the values of the bins.
	GroupByKeys []AnalyticsIntentStageGroupByKey

	// 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.
	MetricsResults []AnalyticsIntentStageMetricResult
	// contains filtered or unexported fields
}

An object containing the results for the intent stage metrics you requested and the bin and/or group they refer to, if applicable.

type AnalyticsInterval added in v1.30.0 

type AnalyticsInterval string
const (
	AnalyticsIntervalOneHour AnalyticsInterval = "OneHour"
	AnalyticsIntervalOneDay  AnalyticsInterval = "OneDay"
)

Enum values for AnalyticsInterval

func (AnalyticsInterval) Values added in v1.30.0 

func (AnalyticsInterval) Values() []AnalyticsInterval

Values returns all known values for AnalyticsInterval. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsMetricStatistic added in v1.30.0 

type AnalyticsMetricStatistic string
const (
	AnalyticsMetricStatisticSum AnalyticsMetricStatistic = "Sum"
	AnalyticsMetricStatisticAvg AnalyticsMetricStatistic = "Avg"
	AnalyticsMetricStatisticMax AnalyticsMetricStatistic = "Max"
)

Enum values for AnalyticsMetricStatistic

func (AnalyticsMetricStatistic) Values added in v1.30.0 

func (AnalyticsMetricStatistic) Values() []AnalyticsMetricStatistic

Values returns all known values for AnalyticsMetricStatistic. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsModality added in v1.30.0 

type AnalyticsModality string
const (
	AnalyticsModalitySpeech    AnalyticsModality = "Speech"
	AnalyticsModalityText      AnalyticsModality = "Text"
	AnalyticsModalityDtmf      AnalyticsModality = "DTMF"
	AnalyticsModalityMultiMode AnalyticsModality = "MultiMode"
)

Enum values for AnalyticsModality

func (AnalyticsModality) Values added in v1.30.0 

func (AnalyticsModality) Values() []AnalyticsModality

Values returns all known values for AnalyticsModality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsNodeType added in v1.30.0 

type AnalyticsNodeType string
const (
	AnalyticsNodeTypeInner AnalyticsNodeType = "Inner"
	AnalyticsNodeTypeExit  AnalyticsNodeType = "Exit"
)

Enum values for AnalyticsNodeType

func (AnalyticsNodeType) Values added in v1.30.0 

func (AnalyticsNodeType) Values() []AnalyticsNodeType

Values returns all known values for AnalyticsNodeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsPathFilter added in v1.30.0 

type AnalyticsPathFilter struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsCommonFilterName

	// 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 .
	//
	// This member is required.
	Operator AnalyticsFilterOperator

	// 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 .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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 .

type AnalyticsSessionField added in v1.30.0 

type AnalyticsSessionField string
const (
	AnalyticsSessionFieldConversationEndState AnalyticsSessionField = "ConversationEndState"
	AnalyticsSessionFieldLocaleId             AnalyticsSessionField = "LocaleId"
)

Enum values for AnalyticsSessionField

func (AnalyticsSessionField) Values added in v1.30.0 

func (AnalyticsSessionField) Values() []AnalyticsSessionField

Values returns all known values for AnalyticsSessionField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsSessionFilter added in v1.30.0 

type AnalyticsSessionFilter struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsSessionFilterName

	// 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 .
	//
	// This member is required.
	Operator AnalyticsFilterOperator

	// 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 .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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 .

type AnalyticsSessionFilterName added in v1.30.0 

type AnalyticsSessionFilterName string
const (
	AnalyticsSessionFilterNameBotAliasId           AnalyticsSessionFilterName = "BotAliasId"
	AnalyticsSessionFilterNameBotVersion           AnalyticsSessionFilterName = "BotVersion"
	AnalyticsSessionFilterNameLocaleId             AnalyticsSessionFilterName = "LocaleId"
	AnalyticsSessionFilterNameModality             AnalyticsSessionFilterName = "Modality"
	AnalyticsSessionFilterNameChannel              AnalyticsSessionFilterName = "Channel"
	AnalyticsSessionFilterNameDuration             AnalyticsSessionFilterName = "Duration"
	AnalyticsSessionFilterNameConversationEndState AnalyticsSessionFilterName = "ConversationEndState"
	AnalyticsSessionFilterNameSessionId            AnalyticsSessionFilterName = "SessionId"
	AnalyticsSessionFilterNameOriginatingRequestId AnalyticsSessionFilterName = "OriginatingRequestId"
	AnalyticsSessionFilterNameIntentPath           AnalyticsSessionFilterName = "IntentPath"
)

Enum values for AnalyticsSessionFilterName

func (AnalyticsSessionFilterName) Values added in v1.30.0 

func (AnalyticsSessionFilterName) Values() []AnalyticsSessionFilterName

Values returns all known values for AnalyticsSessionFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsSessionGroupByKey added in v1.30.0 

type AnalyticsSessionGroupByKey struct {

	// The category by which the session analytics were grouped.
	Name AnalyticsSessionField

	// A member of the category by which the session analytics were grouped.
	Value *string
	// contains filtered or unexported fields
}

Contains the category by which the session analytics were grouped and a member of that category.

type AnalyticsSessionGroupBySpecification added in v1.30.0 

type AnalyticsSessionGroupBySpecification struct {

	// Specifies whether to group the session by their end state or their locale.
	//
	// This member is required.
	Name AnalyticsSessionField
	// contains filtered or unexported fields
}

Contains the category by which to group the sessions.

type AnalyticsSessionMetric added in v1.30.0 

type AnalyticsSessionMetric struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsSessionMetricName

	// 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 .
	//
	// This member is required.
	Statistic AnalyticsMetricStatistic

	// Specifies whether to sort the results in ascending or descending order.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

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.

type AnalyticsSessionMetricName added in v1.30.0 

type AnalyticsSessionMetricName string
const (
	AnalyticsSessionMetricNameCount                AnalyticsSessionMetricName = "Count"
	AnalyticsSessionMetricNameSuccess              AnalyticsSessionMetricName = "Success"
	AnalyticsSessionMetricNameFailure              AnalyticsSessionMetricName = "Failure"
	AnalyticsSessionMetricNameDropped              AnalyticsSessionMetricName = "Dropped"
	AnalyticsSessionMetricNameDuration             AnalyticsSessionMetricName = "Duration"
	AnalyticsSessionMetricNameTurnsPerConversation AnalyticsSessionMetricName = "TurnsPerConversation"
	AnalyticsSessionMetricNameConcurrency          AnalyticsSessionMetricName = "Concurrency"
)

Enum values for AnalyticsSessionMetricName

func (AnalyticsSessionMetricName) Values added in v1.30.0 

func (AnalyticsSessionMetricName) Values() []AnalyticsSessionMetricName

Values returns all known values for AnalyticsSessionMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsSessionMetricResult added in v1.30.0 

type AnalyticsSessionMetricResult struct {

	// 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.
	Name AnalyticsSessionMetricName

	// 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 .
	Statistic AnalyticsMetricStatistic

	// The value of the summary statistic for the metric that you requested.
	Value *float64
	// contains filtered or unexported fields
}

An object containing the results for a session metric you requested.

type AnalyticsSessionResult added in v1.30.0 

type AnalyticsSessionResult struct {

	// A list of objects containing the criteria you requested for binning results and
	// the values of the bins.
	BinKeys []AnalyticsBinKey

	// A list of objects containing the criteria you requested for grouping results
	// and the values of the bins.
	GroupByKeys []AnalyticsSessionGroupByKey

	// 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.
	MetricsResults []AnalyticsSessionMetricResult
	// contains filtered or unexported fields
}

An object containing the results for the session metrics you requested and the bin and/or group(s) they refer to, if applicable.

type AnalyticsSessionSortByName added in v1.30.0 

type AnalyticsSessionSortByName string
const (
	AnalyticsSessionSortByNameConversationStartTime AnalyticsSessionSortByName = "ConversationStartTime"
	AnalyticsSessionSortByNameNumberOfTurns         AnalyticsSessionSortByName = "NumberOfTurns"
	AnalyticsSessionSortByNameDuration              AnalyticsSessionSortByName = "Duration"
)

Enum values for AnalyticsSessionSortByName

func (AnalyticsSessionSortByName) Values added in v1.30.0 

func (AnalyticsSessionSortByName) Values() []AnalyticsSessionSortByName

Values returns all known values for AnalyticsSessionSortByName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsSortOrder added in v1.30.0 

type AnalyticsSortOrder string
const (
	AnalyticsSortOrderAscending  AnalyticsSortOrder = "Ascending"
	AnalyticsSortOrderDescending AnalyticsSortOrder = "Descending"
)

Enum values for AnalyticsSortOrder

func (AnalyticsSortOrder) Values added in v1.30.0 

func (AnalyticsSortOrder) Values() []AnalyticsSortOrder

Values returns all known values for AnalyticsSortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsUtteranceAttribute added in v1.30.0 

type AnalyticsUtteranceAttribute struct {

	// An attribute to return. The only available attribute is the intent that the bot
	// mapped the utterance to.
	//
	// This member is required.
	Name AnalyticsUtteranceAttributeName
	// contains filtered or unexported fields
}

An object that specifies the last used intent at the time of the utterance as an attribute to return.

type AnalyticsUtteranceAttributeName added in v1.30.0 

type AnalyticsUtteranceAttributeName string
const (
	AnalyticsUtteranceAttributeNameLastUsedIntent AnalyticsUtteranceAttributeName = "LastUsedIntent"
)

Enum values for AnalyticsUtteranceAttributeName

func (AnalyticsUtteranceAttributeName) Values added in v1.30.0 

func (AnalyticsUtteranceAttributeName) Values() []AnalyticsUtteranceAttributeName

Values returns all known values for AnalyticsUtteranceAttributeName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsUtteranceAttributeResult added in v1.30.0 

type AnalyticsUtteranceAttributeResult struct {

	// The intent that the bot mapped the utterance to.
	LastUsedIntent *string
	// contains filtered or unexported fields
}

An object containing the intent that the bot mapped the utterance to.

type AnalyticsUtteranceField added in v1.30.0 

type AnalyticsUtteranceField string
const (
	AnalyticsUtteranceFieldUtteranceText  AnalyticsUtteranceField = "UtteranceText"
	AnalyticsUtteranceFieldUtteranceState AnalyticsUtteranceField = "UtteranceState"
)

Enum values for AnalyticsUtteranceField

func (AnalyticsUtteranceField) Values added in v1.30.0 

func (AnalyticsUtteranceField) Values() []AnalyticsUtteranceField

Values returns all known values for AnalyticsUtteranceField. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsUtteranceFilter added in v1.30.0 

type AnalyticsUtteranceFilter struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsUtteranceFilterName

	// 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 .
	//
	// This member is required.
	Operator AnalyticsFilterOperator

	// 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 .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

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 .

type AnalyticsUtteranceFilterName added in v1.30.0 

type AnalyticsUtteranceFilterName string
const (
	AnalyticsUtteranceFilterNameBotAliasId           AnalyticsUtteranceFilterName = "BotAliasId"
	AnalyticsUtteranceFilterNameBotVersion           AnalyticsUtteranceFilterName = "BotVersion"
	AnalyticsUtteranceFilterNameLocaleId             AnalyticsUtteranceFilterName = "LocaleId"
	AnalyticsUtteranceFilterNameModality             AnalyticsUtteranceFilterName = "Modality"
	AnalyticsUtteranceFilterNameChannel              AnalyticsUtteranceFilterName = "Channel"
	AnalyticsUtteranceFilterNameSessionId            AnalyticsUtteranceFilterName = "SessionId"
	AnalyticsUtteranceFilterNameOriginatingRequestId AnalyticsUtteranceFilterName = "OriginatingRequestId"
	AnalyticsUtteranceFilterNameUtteranceState       AnalyticsUtteranceFilterName = "UtteranceState"
	AnalyticsUtteranceFilterNameUtteranceText        AnalyticsUtteranceFilterName = "UtteranceText"
)

Enum values for AnalyticsUtteranceFilterName

func (AnalyticsUtteranceFilterName) Values added in v1.30.0 

func (AnalyticsUtteranceFilterName) Values() []AnalyticsUtteranceFilterName

Values returns all known values for AnalyticsUtteranceFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsUtteranceGroupByKey added in v1.30.0 

type AnalyticsUtteranceGroupByKey struct {

	// The category by which the utterance analytics were grouped.
	Name AnalyticsUtteranceField

	// A member of the category by which the utterance analytics were grouped.
	Value *string
	// contains filtered or unexported fields
}

Contains the category by which the utterance analytics were grouped and the values for that category.

type AnalyticsUtteranceGroupBySpecification added in v1.30.0 

type AnalyticsUtteranceGroupBySpecification struct {

	// Specifies whether to group the utterances by their text or their state.
	//
	// This member is required.
	Name AnalyticsUtteranceField
	// contains filtered or unexported fields
}

Contains the category by which to group the utterances.

type AnalyticsUtteranceMetric added in v1.30.0 

type AnalyticsUtteranceMetric struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsUtteranceMetricName

	// 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 .
	//
	// This member is required.
	Statistic AnalyticsMetricStatistic

	// Specifies whether to sort the results in ascending or descending order.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

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.

type AnalyticsUtteranceMetricName added in v1.30.0 

type AnalyticsUtteranceMetricName string
const (
	AnalyticsUtteranceMetricNameCount              AnalyticsUtteranceMetricName = "Count"
	AnalyticsUtteranceMetricNameMissed             AnalyticsUtteranceMetricName = "Missed"
	AnalyticsUtteranceMetricNameDetected           AnalyticsUtteranceMetricName = "Detected"
	AnalyticsUtteranceMetricNameUtteranceTimestamp AnalyticsUtteranceMetricName = "UtteranceTimestamp"
)

Enum values for AnalyticsUtteranceMetricName

func (AnalyticsUtteranceMetricName) Values added in v1.30.0 

func (AnalyticsUtteranceMetricName) Values() []AnalyticsUtteranceMetricName

Values returns all known values for AnalyticsUtteranceMetricName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AnalyticsUtteranceMetricResult added in v1.30.0 

type AnalyticsUtteranceMetricResult struct {

	// 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.
	Name AnalyticsUtteranceMetricName

	// 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 .
	Statistic AnalyticsMetricStatistic

	// The value of the summary statistic for the metric that you requested.
	Value *float64
	// contains filtered or unexported fields
}

An object containing the results for the utterance metric you requested.

type AnalyticsUtteranceResult added in v1.30.0 

type AnalyticsUtteranceResult struct {

	// A list of objects containing information about the last used intent at the time
	// of an utterance.
	AttributeResults []AnalyticsUtteranceAttributeResult

	// A list of objects containing the criteria you requested for binning results and
	// the values of the bins.
	BinKeys []AnalyticsBinKey

	// A list of objects containing the criteria you requested for grouping results
	// and the values of the bins.
	GroupByKeys []AnalyticsUtteranceGroupByKey

	// 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.
	MetricsResults []AnalyticsUtteranceMetricResult
	// contains filtered or unexported fields
}

An object containing the results for the utterance metrics you requested and the bin and/or group(s) they refer to, if applicable.

type AnalyticsUtteranceSortByName added in v1.30.0 

type AnalyticsUtteranceSortByName string
const (
	AnalyticsUtteranceSortByNameUtteranceTimestamp AnalyticsUtteranceSortByName = "UtteranceTimestamp"
)

Enum values for AnalyticsUtteranceSortByName

func (AnalyticsUtteranceSortByName) Values added in v1.30.0 

func (AnalyticsUtteranceSortByName) Values() []AnalyticsUtteranceSortByName

Values returns all known values for AnalyticsUtteranceSortByName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssociatedTranscript added in v1.14.0 

type AssociatedTranscript struct {

	// The content of the transcript that meets the search filter criteria. For the
	// JSON format of the transcript, see Output transcript format (https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html)
	// .
	Transcript *string
	// contains filtered or unexported fields
}

The object containing information that associates the recommended intent/slot type with a conversation.

type AssociatedTranscriptFilter added in v1.14.0 

type AssociatedTranscriptFilter struct {

	// The name of the field to use for filtering. The allowed names are IntentId and
	// SlotTypeId.
	//
	// This member is required.
	Name AssociatedTranscriptFilterName

	// The values to use to filter the transcript.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters to search for the associated transcript.

type AssociatedTranscriptFilterName added in v1.14.0 

type AssociatedTranscriptFilterName string
const (
	AssociatedTranscriptFilterNameIntentId   AssociatedTranscriptFilterName = "IntentId"
	AssociatedTranscriptFilterNameSlotTypeId AssociatedTranscriptFilterName = "SlotTypeId"
)

Enum values for AssociatedTranscriptFilterName

func (AssociatedTranscriptFilterName) Values added in v1.14.0 

func (AssociatedTranscriptFilterName) Values() []AssociatedTranscriptFilterName

Values returns all known values for AssociatedTranscriptFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AudioAndDTMFInputSpecification added in v1.25.0 

type AudioAndDTMFInputSpecification struct {

	// 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.
	//
	// This member is required.
	StartTimeoutMs *int32

	// Specifies the settings on audio input.
	AudioSpecification *AudioSpecification

	// Specifies the settings on DTMF input.
	DtmfSpecification *DTMFSpecification
	// contains filtered or unexported fields
}

Specifies the audio and DTMF input specification.

type AudioLogDestination 

type AudioLogDestination struct {

	// The Amazon S3 bucket where the audio log files are stored. The IAM role
	// specified in the roleArn parameter of the CreateBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html)
	// operation must have permission to write to this bucket.
	//
	// This member is required.
	S3Bucket *S3BucketLogDestination
	// contains filtered or unexported fields
}

The location of audio log files collected when conversation logging is enabled for a bot.

type AudioLogSetting 

type AudioLogSetting struct {

	// The location of audio log files collected when conversation logging is enabled
	// for a bot.
	//
	// This member is required.
	Destination *AudioLogDestination

	// Determines whether audio logging in enabled for the bot.
	//
	// This member is required.
	Enabled bool

	// The option to enable selective conversation log capture for audio.
	SelectiveLoggingEnabled *bool
	// contains filtered or unexported fields
}

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.

type AudioRecognitionStrategy added in v1.17.0 

type AudioRecognitionStrategy string
const (
	AudioRecognitionStrategyUseSlotValuesAsCustomVocabulary AudioRecognitionStrategy = "UseSlotValuesAsCustomVocabulary"
)

Enum values for AudioRecognitionStrategy

func (AudioRecognitionStrategy) Values added in v1.17.0 

func (AudioRecognitionStrategy) Values() []AudioRecognitionStrategy

Values returns all known values for AudioRecognitionStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AudioSpecification added in v1.25.0 

type AudioSpecification struct {

	// Time for which a bot waits after the customer stops speaking to assume the
	// utterance is finished.
	//
	// This member is required.
	EndTimeoutMs *int32

	// Time for how long Amazon Lex waits before speech input is truncated and the
	// speech is returned to application.
	//
	// This member is required.
	MaxLengthMs *int32
	// contains filtered or unexported fields
}

Specifies the audio input specifications.

type BedrockKnowledgeStoreConfiguration added in v1.43.0 

type BedrockKnowledgeStoreConfiguration struct {

	// The ARN of the knowledge base used.
	//
	// This member is required.
	BedrockKnowledgeBaseArn *string
	// contains filtered or unexported fields
}

Contains details about the configuration of a Amazon Bedrock knowledge base.

type BedrockModelSpecification added in v1.37.0 

type BedrockModelSpecification struct {

	// The ARN of the foundation model used in descriptive bot building.
	//
	// This member is required.
	ModelArn *string
	// contains filtered or unexported fields
}

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

type BotAliasHistoryEvent 

type BotAliasHistoryEvent struct {

	// The version of the bot that was used in the event.
	BotVersion *string

	// The date and time that the event ended.
	EndDate *time.Time

	// The date and time that the event started.
	StartDate *time.Time
	// contains filtered or unexported fields
}

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.

type BotAliasLocaleSettings 

type BotAliasLocaleSettings struct {

	// Determines whether the locale is enabled for the bot. If the value is false ,
	// the locale isn't available for use.
	//
	// This member is required.
	Enabled bool

	// Specifies the Lambda function that should be used in the locale.
	CodeHookSpecification *CodeHookSpecification
	// contains filtered or unexported fields
}

Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

type BotAliasReplicaSummary added in v1.39.0 

type BotAliasReplicaSummary struct {

	// The bot alias ID for all the alias bot replications.
	BotAliasId *string

	// The replication statuses for all the alias bot replications.
	BotAliasReplicationStatus BotAliasReplicationStatus

	// The bot version for all the alias bot replications.
	BotVersion *string

	// The creation time and date for all the alias bot replications.
	CreationDateTime *time.Time

	// The reasons for failure for the aliases bot replications.
	FailureReasons []string

	// The last time and date updated for all the alias bot replications.
	LastUpdatedDateTime *time.Time
	// contains filtered or unexported fields
}

Contains information about all the aliases replication statuses applicable for global resiliency.

type BotAliasReplicationStatus added in v1.39.0 

type BotAliasReplicationStatus string
const (
	BotAliasReplicationStatusCreating  BotAliasReplicationStatus = "Creating"
	BotAliasReplicationStatusUpdating  BotAliasReplicationStatus = "Updating"
	BotAliasReplicationStatusAvailable BotAliasReplicationStatus = "Available"
	BotAliasReplicationStatusDeleting  BotAliasReplicationStatus = "Deleting"
	BotAliasReplicationStatusFailed    BotAliasReplicationStatus = "Failed"
)

Enum values for BotAliasReplicationStatus

func (BotAliasReplicationStatus) Values added in v1.39.0 

func (BotAliasReplicationStatus) Values() []BotAliasReplicationStatus

Values returns all known values for BotAliasReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotAliasStatus 

type BotAliasStatus string
const (
	BotAliasStatusCreating  BotAliasStatus = "Creating"
	BotAliasStatusAvailable BotAliasStatus = "Available"
	BotAliasStatusDeleting  BotAliasStatus = "Deleting"
	BotAliasStatusFailed    BotAliasStatus = "Failed"
)

Enum values for BotAliasStatus

func (BotAliasStatus) Values 

func (BotAliasStatus) Values() []BotAliasStatus

Values returns all known values for BotAliasStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotAliasSummary 

type BotAliasSummary struct {

	// The unique identifier assigned to the bot alias. You can use this ID to get
	// detailed information about the alias using the DescribeBotAlias (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html)
	// operation.
	BotAliasId *string

	// The name of the bot alias.
	BotAliasName *string

	// The current state of the bot alias. If the status is Available , the alias is
	// ready for use.
	BotAliasStatus BotAliasStatus

	// The version of the bot that the bot alias references.
	BotVersion *string

	// A timestamp of the date and time that the bot alias was created.
	CreationDateTime *time.Time

	// The description of the bot alias.
	Description *string

	// A timestamp of the date and time that the bot alias was last updated.
	LastUpdatedDateTime *time.Time
	// contains filtered or unexported fields
}

Summary information about bot aliases returned from the ListBotAliases (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) operation.

type BotAliasTestExecutionTarget added in v1.29.0 

type BotAliasTestExecutionTarget struct {

	// The bot alias Id of the bot alias used in the test set execution.
	//
	// This member is required.
	BotAliasId *string

	// The bot Id of the bot alias used in the test set execution.
	//
	// This member is required.
	BotId *string

	// The locale Id of the bot alias used in the test set execution.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

The target Amazon S3 location for the test set execution using a bot alias.

type BotExportSpecification added in v1.2.0 

type BotExportSpecification struct {

	// The identifier of the bot assigned by Amazon Lex.
	//
	// This member is required.
	BotId *string

	// The version of the bot that was exported. This will be either DRAFT or the
	// version number.
	//
	// This member is required.
	BotVersion *string
	// contains filtered or unexported fields
}

Provides the identity of a the bot that was exported.

type BotFilter 

type BotFilter struct {

	// The name of the field to filter the list of bots.
	//
	// This member is required.
	Name BotFilterName

	// 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.
	//
	// This member is required.
	Operator BotFilterOperator

	// The value to use for filtering the list of bots.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the responses returned by the ListBots operation.

type BotFilterName 

type BotFilterName string
const (
	BotFilterNameBotName BotFilterName = "BotName"
	BotFilterNameBotType BotFilterName = "BotType"
)

Enum values for BotFilterName

func (BotFilterName) Values 

func (BotFilterName) Values() []BotFilterName

Values returns all known values for BotFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotFilterOperator 

type BotFilterOperator string
const (
	BotFilterOperatorContains  BotFilterOperator = "CO"
	BotFilterOperatorEquals    BotFilterOperator = "EQ"
	BotFilterOperatorNotEquals BotFilterOperator = "NE"
)

Enum values for BotFilterOperator

func (BotFilterOperator) Values 

func (BotFilterOperator) Values() []BotFilterOperator

Values returns all known values for BotFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotImportSpecification added in v1.2.0 

type BotImportSpecification struct {

	// The name that Amazon Lex should use for the bot.
	//
	// This member is required.
	BotName *string

	// 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.
	//
	// This member is required.
	DataPrivacy *DataPrivacy

	// The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.
	//
	// This member is required.
	RoleArn *string

	// 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.
	BotTags map[string]string

	// 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.
	IdleSessionTTLInSeconds *int32

	// 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.
	TestBotAliasTags map[string]string
	// contains filtered or unexported fields
}

Provides the bot parameters required for importing a bot.

type BotLocaleExportSpecification added in v1.2.0 

type BotLocaleExportSpecification struct {

	// The identifier of the bot to create the locale for.
	//
	// This member is required.
	BotId *string

	// The version of the bot to export.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the language and locale to export. The string must match one
	// of the locales in the bot.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

Provides the bot locale parameters required for exporting a bot locale.

type BotLocaleFilter 

type BotLocaleFilter struct {

	// The name of the field to filter the list of bots.
	//
	// This member is required.
	Name BotLocaleFilterName

	// 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.
	//
	// This member is required.
	Operator BotLocaleFilterOperator

	// The value to use for filtering the list of bots.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters responses returned by the ListBotLocales operation.

type BotLocaleFilterName 

type BotLocaleFilterName string
const (
	BotLocaleFilterNameBotLocaleName BotLocaleFilterName = "BotLocaleName"
)

Enum values for BotLocaleFilterName

func (BotLocaleFilterName) Values 

func (BotLocaleFilterName) Values() []BotLocaleFilterName

Values returns all known values for BotLocaleFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotLocaleFilterOperator 

type BotLocaleFilterOperator string
const (
	BotLocaleFilterOperatorContains BotLocaleFilterOperator = "CO"
	BotLocaleFilterOperatorEquals   BotLocaleFilterOperator = "EQ"
)

Enum values for BotLocaleFilterOperator

func (BotLocaleFilterOperator) Values 

func (BotLocaleFilterOperator) Values() []BotLocaleFilterOperator

Values returns all known values for BotLocaleFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotLocaleHistoryEvent 

type BotLocaleHistoryEvent struct {

	// A description of the event that occurred.
	//
	// This member is required.
	Event *string

	// A timestamp of the date and time that the event occurred.
	//
	// This member is required.
	EventDate *time.Time
	// contains filtered or unexported fields
}

Provides information about an event that occurred affecting the bot locale.

type BotLocaleImportSpecification added in v1.2.0 

type BotLocaleImportSpecification struct {

	// The identifier of the bot to import the locale to.
	//
	// This member is required.
	BotId *string

	// The version of the bot to import the locale to. This can only be the DRAFT
	// version of the bot.
	//
	// This member is required.
	BotVersion *string

	// 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 (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html)
	// .
	//
	// This member is required.
	LocaleId *string

	// 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
	NluIntentConfidenceThreshold *float64

	// Defines settings for using an Amazon Polly voice to communicate with a user.
	VoiceSettings *VoiceSettings
	// contains filtered or unexported fields
}

Provides the bot locale parameters required for importing a bot locale.

type BotLocaleSortAttribute 

type BotLocaleSortAttribute string
const (
	BotLocaleSortAttributeBotLocaleName BotLocaleSortAttribute = "BotLocaleName"
)

Enum values for BotLocaleSortAttribute

func (BotLocaleSortAttribute) Values 

func (BotLocaleSortAttribute) Values() []BotLocaleSortAttribute

Values returns all known values for BotLocaleSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotLocaleSortBy 

type BotLocaleSortBy struct {

	// The bot locale attribute to sort by.
	//
	// This member is required.
	Attribute BotLocaleSortAttribute

	// Specifies whether to sort the bot locales in ascending or descending order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of bot locales.

type BotLocaleStatus 

type BotLocaleStatus string
const (
	BotLocaleStatusCreating            BotLocaleStatus = "Creating"
	BotLocaleStatusBuilding            BotLocaleStatus = "Building"
	BotLocaleStatusBuilt               BotLocaleStatus = "Built"
	BotLocaleStatusReadyExpressTesting BotLocaleStatus = "ReadyExpressTesting"
	BotLocaleStatusFailed              BotLocaleStatus = "Failed"
	BotLocaleStatusDeleting            BotLocaleStatus = "Deleting"
	BotLocaleStatusNotBuilt            BotLocaleStatus = "NotBuilt"
	BotLocaleStatusImporting           BotLocaleStatus = "Importing"
	BotLocaleStatusProcessing          BotLocaleStatus = "Processing"
)

Enum values for BotLocaleStatus

func (BotLocaleStatus) Values 

func (BotLocaleStatus) Values() []BotLocaleStatus

Values returns all known values for BotLocaleStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotLocaleSummary 

type BotLocaleSummary struct {

	// The current status of the bot locale. When the status is Built the locale is
	// ready for use.
	BotLocaleStatus BotLocaleStatus

	// The description of the bot locale.
	Description *string

	// A timestamp of the date and time that the bot locale was last built.
	LastBuildSubmittedDateTime *time.Time

	// A timestamp of the date and time that the bot locale was last updated.
	LastUpdatedDateTime *time.Time

	// The language and locale of the bot locale.
	LocaleId *string

	// The name of the bot locale.
	LocaleName *string
	// contains filtered or unexported fields
}

Summary information about bot locales returned by the ListBotLocales (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) operation.

type BotMember added in v1.28.0 

type BotMember struct {

	// The alias ID of a bot that is a member of this network of bots.
	//
	// This member is required.
	BotMemberAliasId *string

	// The alias name of a bot that is a member of this network of bots.
	//
	// This member is required.
	BotMemberAliasName *string

	// The unique ID of a bot that is a member of this network of bots.
	//
	// This member is required.
	BotMemberId *string

	// The unique name of a bot that is a member of this network of bots.
	//
	// This member is required.
	BotMemberName *string

	// The version of a bot that is a member of this network of bots.
	//
	// This member is required.
	BotMemberVersion *string
	// contains filtered or unexported fields
}

A bot that is a member of a network of bots.

type BotRecommendationResultStatistics added in v1.14.0 

type BotRecommendationResultStatistics struct {

	// Statistical information about about the intents associated with the bot
	// recommendation results.
	Intents *IntentStatistics

	// Statistical information about the slot types associated with the bot
	// recommendation results.
	SlotTypes *SlotTypeStatistics
	// contains filtered or unexported fields
}

A statistical summary of the bot recommendation results.

type BotRecommendationResults added in v1.14.0 

type BotRecommendationResults struct {

	// The presigned url link of the associated transcript.
	AssociatedTranscriptsUrl *string

	// The presigned URL link of the recommended bot definition.
	BotLocaleExportUrl *string

	// The statistical summary of the bot recommendation results.
	Statistics *BotRecommendationResultStatistics
	// contains filtered or unexported fields
}

The object representing the URL of the bot definition, the URL of the associated transcript, and a statistical summary of the bot recommendation results.

type BotRecommendationStatus added in v1.14.0 

type BotRecommendationStatus string
const (
	BotRecommendationStatusProcessing  BotRecommendationStatus = "Processing"
	BotRecommendationStatusDeleting    BotRecommendationStatus = "Deleting"
	BotRecommendationStatusDeleted     BotRecommendationStatus = "Deleted"
	BotRecommendationStatusDownloading BotRecommendationStatus = "Downloading"
	BotRecommendationStatusUpdating    BotRecommendationStatus = "Updating"
	BotRecommendationStatusAvailable   BotRecommendationStatus = "Available"
	BotRecommendationStatusFailed      BotRecommendationStatus = "Failed"
	BotRecommendationStatusStopping    BotRecommendationStatus = "Stopping"
	BotRecommendationStatusStopped     BotRecommendationStatus = "Stopped"
)

Enum values for BotRecommendationStatus

func (BotRecommendationStatus) Values added in v1.14.0 

func (BotRecommendationStatus) Values() []BotRecommendationStatus

Values returns all known values for BotRecommendationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotRecommendationSummary added in v1.14.0 

type BotRecommendationSummary struct {

	// The unique identifier of the bot recommendation to be updated.
	//
	// This member is required.
	BotRecommendationId *string

	// The status of the bot recommendation. If the status is Failed, then the reasons
	// for the failure are listed in the failureReasons field.
	//
	// This member is required.
	BotRecommendationStatus BotRecommendationStatus

	// A timestamp of the date and time that the bot recommendation was created.
	CreationDateTime *time.Time

	// A timestamp of the date and time that the bot recommendation was last updated.
	LastUpdatedDateTime *time.Time
	// contains filtered or unexported fields
}

A summary of the bot recommendation.

type BotReplicaStatus added in v1.39.0 

type BotReplicaStatus string
const (
	BotReplicaStatusEnabling BotReplicaStatus = "Enabling"
	BotReplicaStatusEnabled  BotReplicaStatus = "Enabled"
	BotReplicaStatusDeleting BotReplicaStatus = "Deleting"
	BotReplicaStatusFailed   BotReplicaStatus = "Failed"
)

Enum values for BotReplicaStatus

func (BotReplicaStatus) Values added in v1.39.0 

func (BotReplicaStatus) Values() []BotReplicaStatus

Values returns all known values for BotReplicaStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotReplicaSummary added in v1.39.0 

type BotReplicaSummary struct {

	// The operation status for the replicated bot applicable.
	BotReplicaStatus BotReplicaStatus

	// The creation time and date for the replicated bots.
	CreationDateTime *time.Time

	// The reasons for the failure for the replicated bot.
	FailureReasons []string

	// The replica region used in the replication statuses summary.
	ReplicaRegion *string
	// contains filtered or unexported fields
}

Contains summary information about all the replication statuses applicable for global resiliency.

type BotSortAttribute 

type BotSortAttribute string
const (
	BotSortAttributeBotName BotSortAttribute = "BotName"
)

Enum values for BotSortAttribute

func (BotSortAttribute) Values 

func (BotSortAttribute) Values() []BotSortAttribute

Values returns all known values for BotSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotSortBy 

type BotSortBy struct {

	// The attribute to use to sort the list of bots.
	//
	// This member is required.
	Attribute BotSortAttribute

	// The order to sort the list. You can choose ascending or descending.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of bots.

type BotStatus 

type BotStatus string
const (
	BotStatusCreating   BotStatus = "Creating"
	BotStatusAvailable  BotStatus = "Available"
	BotStatusInactive   BotStatus = "Inactive"
	BotStatusDeleting   BotStatus = "Deleting"
	BotStatusFailed     BotStatus = "Failed"
	BotStatusVersioning BotStatus = "Versioning"
	BotStatusImporting  BotStatus = "Importing"
	BotStatusUpdating   BotStatus = "Updating"
)

Enum values for BotStatus

func (BotStatus) Values 

func (BotStatus) Values() []BotStatus

Values returns all known values for BotStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotSummary 

type BotSummary struct {

	// The unique identifier assigned to the bot. Use this ID to get detailed
	// information about the bot with the DescribeBot (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html)
	// operation.
	BotId *string

	// The name of the bot.
	BotName *string

	// The current status of the bot. When the status is Available the bot is ready
	// for use.
	BotStatus BotStatus

	// The type of the bot.
	BotType BotType

	// The description of the bot.
	Description *string

	// The date and time that the bot was last updated.
	LastUpdatedDateTime *time.Time

	// The latest numerical version in use for the bot.
	LatestBotVersion *string
	// contains filtered or unexported fields
}

Summary information about a bot returned by the ListBots (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) operation.

type BotType added in v1.28.0 

type BotType string
const (
	BotTypeBot        BotType = "Bot"
	BotTypeBotNetwork BotType = "BotNetwork"
)

Enum values for BotType

func (BotType) Values added in v1.28.0 

func (BotType) Values() []BotType

Values returns all known values for BotType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotVersionLocaleDetails 

type BotVersionLocaleDetails struct {

	// The version of a bot used for a bot locale.
	//
	// This member is required.
	SourceBotVersion *string
	// contains filtered or unexported fields
}

The version of a bot used for a bot locale.

type BotVersionReplicaSortAttribute added in v1.39.0 

type BotVersionReplicaSortAttribute string
const (
	BotVersionReplicaSortAttributeBotVersion BotVersionReplicaSortAttribute = "BotVersion"
)

Enum values for BotVersionReplicaSortAttribute

func (BotVersionReplicaSortAttribute) Values added in v1.39.0 

func (BotVersionReplicaSortAttribute) Values() []BotVersionReplicaSortAttribute

Values returns all known values for BotVersionReplicaSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotVersionReplicaSortBy added in v1.39.0 

type BotVersionReplicaSortBy struct {

	// The attribute of the sort category for the version replicated bots.
	//
	// This member is required.
	Attribute BotVersionReplicaSortAttribute

	// The order of the sort category for the version replicated bots.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

The sort category for the version replicated bots.

type BotVersionReplicaSummary added in v1.39.0 

type BotVersionReplicaSummary struct {

	// The bot version for the summary information for all the version replication
	// statuses.
	BotVersion *string

	// The version replication status for all the replicated bots.
	BotVersionReplicationStatus BotVersionReplicationStatus

	// The creation date and time of the replication status for all the replicated
	// bots.
	CreationDateTime *time.Time

	// The reasons for replication failure for all the replicated bots.
	FailureReasons []string
	// contains filtered or unexported fields
}

Contains summary information for all the version replication statuses applicable for Global resiliency.

type BotVersionReplicationStatus added in v1.39.0 

type BotVersionReplicationStatus string
const (
	BotVersionReplicationStatusCreating  BotVersionReplicationStatus = "Creating"
	BotVersionReplicationStatusAvailable BotVersionReplicationStatus = "Available"
	BotVersionReplicationStatusDeleting  BotVersionReplicationStatus = "Deleting"
	BotVersionReplicationStatusFailed    BotVersionReplicationStatus = "Failed"
)

Enum values for BotVersionReplicationStatus

func (BotVersionReplicationStatus) Values added in v1.39.0 

func (BotVersionReplicationStatus) Values() []BotVersionReplicationStatus

Values returns all known values for BotVersionReplicationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotVersionSortAttribute 

type BotVersionSortAttribute string
const (
	BotVersionSortAttributeBotVersion BotVersionSortAttribute = "BotVersion"
)

Enum values for BotVersionSortAttribute

func (BotVersionSortAttribute) Values 

func (BotVersionSortAttribute) Values() []BotVersionSortAttribute

Values returns all known values for BotVersionSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BotVersionSortBy 

type BotVersionSortBy struct {

	// The attribute to use to sort the list of versions.
	//
	// This member is required.
	Attribute BotVersionSortAttribute

	// The order to sort the list. You can specify ascending or descending order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of bot versions.

type BotVersionSummary 

type BotVersionSummary struct {

	// The name of the bot associated with the version.
	BotName *string

	// The status of the bot. When the status is available, the version of the bot is
	// ready for use.
	BotStatus BotStatus

	// The numeric version of the bot, or DRAFT to indicate that this is the version
	// of the bot that can be updated..
	BotVersion *string

	// A timestamp of the date and time that the version was created.
	CreationDateTime *time.Time

	// The description of the version.
	Description *string
	// contains filtered or unexported fields
}

Summary information about a bot version returned by the ListBotVersions (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html) operation.

type BuildtimeSettings added in v1.37.0 

type BuildtimeSettings struct {

	// An object containing specifications for the descriptive bot building feature.
	DescriptiveBotBuilder *DescriptiveBotBuilderSpecification

	// Contains specifications for the sample utterance generation feature.
	SampleUtteranceGeneration *SampleUtteranceGenerationSpecification
	// contains filtered or unexported fields
}

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

type BuiltInIntentSortAttribute 

type BuiltInIntentSortAttribute string
const (
	BuiltInIntentSortAttributeIntentSignature BuiltInIntentSortAttribute = "IntentSignature"
)

Enum values for BuiltInIntentSortAttribute

func (BuiltInIntentSortAttribute) Values 

func (BuiltInIntentSortAttribute) Values() []BuiltInIntentSortAttribute

Values returns all known values for BuiltInIntentSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BuiltInIntentSortBy 

type BuiltInIntentSortBy struct {

	// The attribute to use to sort the list of built-in intents.
	//
	// This member is required.
	Attribute BuiltInIntentSortAttribute

	// The order to sort the list. You can specify ascending or descending order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of built-in intents.

type BuiltInIntentSummary 

type BuiltInIntentSummary struct {

	// The description of the intent.
	Description *string

	// The signature of the built-in intent. Use this to specify the parent intent of
	// a derived intent.
	IntentSignature *string
	// contains filtered or unexported fields
}

Provides summary information about a built-in intent for the ListBuiltInIntents (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html) operation.

type BuiltInSlotTypeSortAttribute 

type BuiltInSlotTypeSortAttribute string
const (
	BuiltInSlotTypeSortAttributeSlotTypeSignature BuiltInSlotTypeSortAttribute = "SlotTypeSignature"
)

Enum values for BuiltInSlotTypeSortAttribute

func (BuiltInSlotTypeSortAttribute) Values 

func (BuiltInSlotTypeSortAttribute) Values() []BuiltInSlotTypeSortAttribute

Values returns all known values for BuiltInSlotTypeSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BuiltInSlotTypeSortBy 

type BuiltInSlotTypeSortBy struct {

	// The attribute to use to sort the list of built-in intents.
	//
	// This member is required.
	Attribute BuiltInSlotTypeSortAttribute

	// The order to sort the list. You can choose ascending or descending.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of built-in slot types.

type BuiltInSlotTypeSummary 

type BuiltInSlotTypeSummary struct {

	// The description of the built-in slot type.
	Description *string

	// The signature of the built-in slot type. Use this to specify the parent slot
	// type of a derived slot type.
	SlotTypeSignature *string
	// contains filtered or unexported fields
}

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) operation.

type Button 

type Button struct {

	// The text that appears on the button. Use this to tell the user what value is
	// returned when they choose this button.
	//
	// This member is required.
	Text *string

	// The value returned to Amazon Lex when the user chooses this button. This must
	// be one of the slot values configured for the slot.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a button to use on a response card used to gather slot values from a user.

type CloudWatchLogGroupLogDestination 

type CloudWatchLogGroupLogDestination struct {

	// The Amazon Resource Name (ARN) of the log group where text and metadata logs
	// are delivered.
	//
	// This member is required.
	CloudWatchLogGroupArn *string

	// The prefix of the log stream name within the log group that you specified
	//
	// This member is required.
	LogPrefix *string
	// contains filtered or unexported fields
}

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.

type CodeHookSpecification 

type CodeHookSpecification struct {

	// Specifies a Lambda function that verifies requests to a bot or fulfills the
	// user's request to a bot.
	//
	// This member is required.
	LambdaCodeHook *LambdaCodeHook
	// contains filtered or unexported fields
}

Contains information about code hooks that Amazon Lex calls during a conversation.

type CompositeSlotTypeSetting added in v1.24.0 

type CompositeSlotTypeSetting struct {

	// Subslots in the composite slot.
	SubSlots []SubSlotTypeComposition
	// contains filtered or unexported fields
}

A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.

type Condition added in v1.22.0 

type Condition struct {

	// The expression string that is evaluated.
	//
	// This member is required.
	ExpressionString *string
	// contains filtered or unexported fields
}

Provides an expression that evaluates to true or false.

type ConditionalBranch added in v1.22.0 

type ConditionalBranch struct {

	// Contains the expression to evaluate. If the condition is true, the branch's
	// actions are taken.
	//
	// This member is required.
	Condition *Condition

	// The name of the branch.
	//
	// This member is required.
	Name *string

	// The next step in the conversation.
	//
	// This member is required.
	NextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	Response *ResponseSpecification
	// contains filtered or unexported fields
}

A set of actions that Amazon Lex should run if the condition is matched.

type ConditionalSpecification added in v1.22.0 

type ConditionalSpecification struct {

	// Determines whether a conditional branch is active. When active is false, the
	// conditions are not evaluated.
	//
	// This member is required.
	Active *bool

	// 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.
	//
	// This member is required.
	ConditionalBranches []ConditionalBranch

	// 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.
	//
	// This member is required.
	DefaultBranch *DefaultConditionalBranch
	// contains filtered or unexported fields
}

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.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConversationEndState added in v1.30.0 

type ConversationEndState string
const (
	ConversationEndStateSuccess ConversationEndState = "Success"
	ConversationEndStateFailure ConversationEndState = "Failure"
	ConversationEndStateDropped ConversationEndState = "Dropped"
)

Enum values for ConversationEndState

func (ConversationEndState) Values added in v1.30.0 

func (ConversationEndState) Values() []ConversationEndState

Values returns all known values for ConversationEndState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConversationLevelIntentClassificationResultItem added in v1.29.0 

type ConversationLevelIntentClassificationResultItem struct {

	// The intent name used in the evaluation of intent level success or failure.
	//
	// This member is required.
	IntentName *string

	// The number of times the specific intent is used in the evaluation of intent
	// level success or failure.
	//
	// This member is required.
	MatchResult TestResultMatchStatus
	// contains filtered or unexported fields
}

The item listing the evaluation of intent level success or failure.

type ConversationLevelResultDetail added in v1.29.0 

type ConversationLevelResultDetail struct {

	// The success or failure of the streaming of the conversation.
	//
	// This member is required.
	EndToEndResult TestResultMatchStatus

	// The speech transcription success or failure details of the conversation.
	SpeechTranscriptionResult TestResultMatchStatus
	// contains filtered or unexported fields
}

The conversation level details of the conversation used in the test set.

type ConversationLevelSlotResolutionResultItem added in v1.29.0 

type ConversationLevelSlotResolutionResultItem struct {

	// The intents used in the slots list for the slot resolution details.
	//
	// This member is required.
	IntentName *string

	// The number of matching slots used in the slots listings for the slot resolution
	// evaluation.
	//
	// This member is required.
	MatchResult TestResultMatchStatus

	// The slot name in the slots list for the slot resolution details.
	//
	// This member is required.
	SlotName *string
	// contains filtered or unexported fields
}

The slots used for the slot resolution in the conversation.

type ConversationLevelTestResultItem added in v1.29.0 

type ConversationLevelTestResultItem struct {

	// The conversation Id of the test result evaluation item.
	//
	// This member is required.
	ConversationId *string

	// The end-to-end success or failure of the test result evaluation item.
	//
	// This member is required.
	EndToEndResult TestResultMatchStatus

	// The intent classification of the test result evaluation item.
	//
	// This member is required.
	IntentClassificationResults []ConversationLevelIntentClassificationResultItem

	// The slot success or failure of the test result evaluation item.
	//
	// This member is required.
	SlotResolutionResults []ConversationLevelSlotResolutionResultItem

	// The speech transcription success or failure of the test result evaluation item.
	SpeechTranscriptionResult TestResultMatchStatus
	// contains filtered or unexported fields
}

The test result evaluation item at the conversation level.

type ConversationLevelTestResults added in v1.29.0 

type ConversationLevelTestResults struct {

	// The item list in the test set results data at the conversation level.
	//
	// This member is required.
	Items []ConversationLevelTestResultItem
	// contains filtered or unexported fields
}

The test set results data at the conversation level.

type ConversationLevelTestResultsFilterBy added in v1.29.0 

type ConversationLevelTestResultsFilterBy struct {

	// The selection of matched or mismatched end-to-end status to filter test set
	// results data at the conversation level.
	EndToEndResult TestResultMatchStatus
	// contains filtered or unexported fields
}

The selection to filter the test set results data at the conversation level.

type ConversationLogSettings 

type ConversationLogSettings struct {

	// The Amazon S3 settings for logging audio to an S3 bucket.
	AudioLogSettings []AudioLogSetting

	// The Amazon CloudWatch Logs settings for logging text and metadata.
	TextLogSettings []TextLogSetting
	// contains filtered or unexported fields
}

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

type ConversationLogsDataSource added in v1.29.0 

type ConversationLogsDataSource struct {

	// The bot alias Id from the conversation logs.
	//
	// This member is required.
	BotAliasId *string

	// The bot Id from the conversation logs.
	//
	// This member is required.
	BotId *string

	// The filter for the data source of the conversation log.
	//
	// This member is required.
	Filter *ConversationLogsDataSourceFilterBy

	// The locale Id of the conversation log.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

The data source that uses conversation logs.

type ConversationLogsDataSourceFilterBy added in v1.29.0 

type ConversationLogsDataSourceFilterBy struct {

	// The end time for the conversation log.
	//
	// This member is required.
	EndTime *time.Time

	// The selection to filter by input mode for the conversation logs.
	//
	// This member is required.
	InputMode ConversationLogsInputModeFilter

	// The start time for the conversation log.
	//
	// This member is required.
	StartTime *time.Time
	// contains filtered or unexported fields
}

The selected data source to filter the conversation log.

type ConversationLogsInputModeFilter added in v1.29.0 

type ConversationLogsInputModeFilter string
const (
	ConversationLogsInputModeFilterSpeech ConversationLogsInputModeFilter = "Speech"
	ConversationLogsInputModeFilterText   ConversationLogsInputModeFilter = "Text"
)

Enum values for ConversationLogsInputModeFilter

func (ConversationLogsInputModeFilter) Values added in v1.29.0 

func (ConversationLogsInputModeFilter) Values() []ConversationLogsInputModeFilter

Values returns all known values for ConversationLogsInputModeFilter. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type CustomPayload 

type CustomPayload struct {

	// The string that is sent to your application.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A custom response string that Amazon Lex sends to your application. You define the content and structure the string.

type CustomVocabularyEntryId added in v1.26.0 

type CustomVocabularyEntryId struct {

	// The unique item identifier for the custom vocabulary items.
	//
	// This member is required.
	ItemId *string
	// contains filtered or unexported fields
}

The unique entry identifier for the custom vocabulary items.

type CustomVocabularyExportSpecification added in v1.17.0 

type CustomVocabularyExportSpecification struct {

	// The identifier of the bot that contains the custom vocabulary to export.
	//
	// This member is required.
	BotId *string

	// The version of the bot that contains the custom vocabulary to export.
	//
	// This member is required.
	BotVersion *string

	// The locale of the bot that contains the custom vocabulary to export.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

Provides the parameters required for exporting a custom vocabulary.

type CustomVocabularyImportSpecification added in v1.17.0 

type CustomVocabularyImportSpecification struct {

	// The identifier of the bot to import the custom vocabulary to.
	//
	// This member is required.
	BotId *string

	// The version of the bot to import the custom vocabulary to.
	//
	// This member is required.
	BotVersion *string

	// The identifier of the local to import the custom vocabulary to. The value must
	// be en_GB .
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

Provides the parameters required for importing a custom vocabulary.

type CustomVocabularyItem added in v1.26.0 

type CustomVocabularyItem struct {

	// The unique item identifer for the custom vocabulary item from the custom
	// vocabulary list.
	//
	// This member is required.
	ItemId *string

	// The unique phrase for the custom vocabulary item from the custom vocabulary
	// list.
	//
	// This member is required.
	Phrase *string

	// The DisplayAs value for the custom vocabulary item from the custom vocabulary
	// list.
	DisplayAs *string

	// The weight assigned for the custom vocabulary item from the custom vocabulary
	// list.
	Weight *int32
	// contains filtered or unexported fields
}

The unique custom vocabulary item from the custom vocabulary list.

type CustomVocabularyStatus added in v1.17.0 

type CustomVocabularyStatus string
const (
	CustomVocabularyStatusReady     CustomVocabularyStatus = "Ready"
	CustomVocabularyStatusDeleting  CustomVocabularyStatus = "Deleting"
	CustomVocabularyStatusExporting CustomVocabularyStatus = "Exporting"
	CustomVocabularyStatusImporting CustomVocabularyStatus = "Importing"
	CustomVocabularyStatusCreating  CustomVocabularyStatus = "Creating"
)

Enum values for CustomVocabularyStatus

func (CustomVocabularyStatus) Values added in v1.17.0 

func (CustomVocabularyStatus) Values() []CustomVocabularyStatus

Values returns all known values for CustomVocabularyStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DTMFSpecification added in v1.25.0 

type DTMFSpecification struct {

	// The DTMF character that clears the accumulated DTMF digits and immediately ends
	// the input.
	//
	// This member is required.
	DeletionCharacter *string

	// The DTMF character that immediately ends input. If the user does not press this
	// character, the input ends after the end timeout.
	//
	// This member is required.
	EndCharacter *string

	// How long the bot should wait after the last DTMF character input before
	// assuming that the input has concluded.
	//
	// This member is required.
	EndTimeoutMs *int32

	// The maximum number of DTMF digits allowed in an utterance.
	//
	// This member is required.
	MaxLength *int32
	// contains filtered or unexported fields
}

Specifies the DTMF input specifications.

type DataPrivacy 

type DataPrivacy struct {

	// 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 (http://aws.amazon.com/lex/faqs#data-security)
	// .
	//
	// This member is required.
	ChildDirected bool
	// contains filtered or unexported fields
}

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.

type DataSourceConfiguration added in v1.43.0 

type DataSourceConfiguration struct {

	// 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html)
	// .
	BedrockKnowledgeStoreConfiguration *BedrockKnowledgeStoreConfiguration

	// 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 (https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)
	// .
	KendraConfiguration *QnAKendraConfiguration

	// 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 (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html)
	// .
	OpensearchConfiguration *OpensearchConfiguration
	// contains filtered or unexported fields
}

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.

type DateRangeFilter added in v1.14.0 

type DateRangeFilter struct {

	// A timestamp indicating the end date for the date range filter.
	//
	// This member is required.
	EndDateTime *time.Time

	// A timestamp indicating the start date for the date range filter.
	//
	// This member is required.
	StartDateTime *time.Time
	// contains filtered or unexported fields
}

The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.

type DefaultConditionalBranch added in v1.22.0 

type DefaultConditionalBranch struct {

	// The next step in the conversation.
	NextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	Response *ResponseSpecification
	// contains filtered or unexported fields
}

A set of actions that Amazon Lex should run if none of the other conditions are met.

type DescriptiveBotBuilderSpecification added in v1.37.0 

type DescriptiveBotBuilderSpecification struct {

	// Specifies whether the descriptive bot building feature is activated or not.
	//
	// This member is required.
	Enabled bool

	// An object containing information about the Amazon Bedrock model used to
	// interpret the prompt used in descriptive bot building.
	BedrockModelSpecification *BedrockModelSpecification
	// contains filtered or unexported fields
}

Contains specifications for the descriptive bot building feature.

type DialogAction added in v1.22.0 

type DialogAction struct {

	// The action that the bot should execute.
	//
	// This member is required.
	Type DialogActionType

	// If the dialog action is ElicitSlot , defines the slot to elicit from the user.
	SlotToElicit *string

	// When true the next message for the intent is not used.
	SuppressNextMessage *bool
	// contains filtered or unexported fields
}

Defines the action that the bot executes at runtime when the conversation reaches this step.

type DialogActionType added in v1.22.0 

type DialogActionType string
const (
	DialogActionTypeElicitIntent         DialogActionType = "ElicitIntent"
	DialogActionTypeStartIntent          DialogActionType = "StartIntent"
	DialogActionTypeElicitSlot           DialogActionType = "ElicitSlot"
	DialogActionTypeEvaluateConditional  DialogActionType = "EvaluateConditional"
	DialogActionTypeInvokeDialogCodeHook DialogActionType = "InvokeDialogCodeHook"
	DialogActionTypeConfirmIntent        DialogActionType = "ConfirmIntent"
	DialogActionTypeFulfillIntent        DialogActionType = "FulfillIntent"
	DialogActionTypeCloseIntent          DialogActionType = "CloseIntent"
	DialogActionTypeEndConversation      DialogActionType = "EndConversation"
)

Enum values for DialogActionType

func (DialogActionType) Values added in v1.22.0 

func (DialogActionType) Values() []DialogActionType

Values returns all known values for DialogActionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DialogCodeHookInvocationSetting added in v1.22.0 

type DialogCodeHookInvocationSetting struct {

	// Determines whether a dialog code hook is used when the intent is activated.
	//
	// This member is required.
	Active *bool

	// Indicates whether a Lambda function should be invoked for the dialog.
	//
	// This member is required.
	EnableCodeHookInvocation *bool

	// Contains the responses and actions that Amazon Lex takes after the Lambda
	// function is complete.
	//
	// This member is required.
	PostCodeHookSpecification *PostDialogCodeHookInvocationSpecification

	// A label that indicates the dialog step from which the dialog code hook is
	// happening.
	InvocationLabel *string
	// contains filtered or unexported fields
}

Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.

type DialogCodeHookSettings 

type DialogCodeHookSettings struct {

	// Enables the dialog code hook so that it processes user requests.
	//
	// This member is required.
	Enabled bool
	// contains filtered or unexported fields
}

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

type DialogState added in v1.22.0 

type DialogState struct {

	// Defines the action that the bot executes at runtime when the conversation
	// reaches this step.
	DialogAction *DialogAction

	// Override settings to configure the intent state.
	Intent *IntentOverride

	// Map of key/value pairs representing session-specific context information. It
	// contains application information passed between Amazon Lex and a client
	// application.
	SessionAttributes map[string]string
	// contains filtered or unexported fields
}

The current state of the conversation with the user.

type Effect added in v1.2.0 

type Effect string
const (
	EffectAllow Effect = "Allow"
	EffectDeny  Effect = "Deny"
)

Enum values for Effect

func (Effect) Values added in v1.2.0 

func (Effect) Values() []Effect

Values returns all known values for Effect. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ElicitationCodeHookInvocationSetting added in v1.22.0 

type ElicitationCodeHookInvocationSetting struct {

	// Indicates whether a Lambda function should be invoked for the dialog.
	//
	// This member is required.
	EnableCodeHookInvocation *bool

	// A label that indicates the dialog step from which the dialog code hook is
	// happening.
	InvocationLabel *string
	// contains filtered or unexported fields
}

Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.

type EncryptionSetting added in v1.14.0 

type EncryptionSetting struct {

	// The password used to encrypt the associated transcript file.
	AssociatedTranscriptsPassword *string

	// The password used to encrypt the recommended bot recommendation file.
	BotLocaleExportPassword *string

	// The KMS key ARN used to encrypt the metadata associated with the bot
	// recommendation.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

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.

type ErrorCode added in v1.26.0 

type ErrorCode string
const (
	ErrorCodeDuplicateInput        ErrorCode = "DUPLICATE_INPUT"
	ErrorCodeResourceDoesNotExist  ErrorCode = "RESOURCE_DOES_NOT_EXIST"
	ErrorCodeResourceAlreadyExists ErrorCode = "RESOURCE_ALREADY_EXISTS"
	ErrorCodeInternalServerFailure ErrorCode = "INTERNAL_SERVER_FAILURE"
)

Enum values for ErrorCode

func (ErrorCode) Values added in v1.26.0 

func (ErrorCode) Values() []ErrorCode

Values returns all known values for ErrorCode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExactResponseFields added in v1.43.0 

type ExactResponseFields struct {

	// The name of the field that contains the answer to the query made to the
	// OpenSearch Service database.
	//
	// This member is required.
	AnswerField *string

	// The name of the field that contains the query made to the OpenSearch Service
	// database.
	//
	// This member is required.
	QuestionField *string
	// contains filtered or unexported fields
}

Contains the names of the fields used for an exact response to the user.

type ExecutionErrorDetails added in v1.29.0 

type ExecutionErrorDetails struct {

	// The error code for the error.
	//
	// This member is required.
	ErrorCode *string

	// The message describing the error.
	//
	// This member is required.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Details about an error in an execution of a test set.

type ExportFilter added in v1.2.0 

type ExportFilter struct {

	// The name of the field to use for filtering.
	//
	// This member is required.
	Name ExportFilterName

	// 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.
	//
	// This member is required.
	Operator ExportFilterOperator

	// The values to use to filter the response. The values must be Bot , BotLocale ,
	// or CustomVocabulary .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response form the ListExports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) operation

type ExportFilterName added in v1.2.0 

type ExportFilterName string
const (
	ExportFilterNameExportResourceType ExportFilterName = "ExportResourceType"
)

Enum values for ExportFilterName

func (ExportFilterName) Values added in v1.2.0 

func (ExportFilterName) Values() []ExportFilterName

Values returns all known values for ExportFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportFilterOperator added in v1.2.0 

type ExportFilterOperator string
const (
	ExportFilterOperatorContains ExportFilterOperator = "CO"
	ExportFilterOperatorEquals   ExportFilterOperator = "EQ"
)

Enum values for ExportFilterOperator

func (ExportFilterOperator) Values added in v1.2.0 

func (ExportFilterOperator) Values() []ExportFilterOperator

Values returns all known values for ExportFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportResourceSpecification added in v1.2.0 

type ExportResourceSpecification struct {

	// Parameters for exporting a bot.
	BotExportSpecification *BotExportSpecification

	// Parameters for exporting a bot locale.
	BotLocaleExportSpecification *BotLocaleExportSpecification

	// The parameters required to export a custom vocabulary.
	CustomVocabularyExportSpecification *CustomVocabularyExportSpecification

	// Specifications for the test set that is exported as a resource.
	TestSetExportSpecification *TestSetExportSpecification
	// contains filtered or unexported fields
}

Provides information about the bot or bot locale that you want to export. You can specify the botExportSpecification or the botLocaleExportSpecification , but not both.

type ExportSortAttribute added in v1.2.0 

type ExportSortAttribute string
const (
	ExportSortAttributeLastUpdatedDateTime ExportSortAttribute = "LastUpdatedDateTime"
)

Enum values for ExportSortAttribute

func (ExportSortAttribute) Values added in v1.2.0 

func (ExportSortAttribute) Values() []ExportSortAttribute

Values returns all known values for ExportSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportSortBy added in v1.2.0 

type ExportSortBy struct {

	// The export field to use for sorting.
	//
	// This member is required.
	Attribute ExportSortAttribute

	// The order to sort the list.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Provides information about sorting a list of exports.

type ExportStatus added in v1.2.0 

type ExportStatus string
const (
	ExportStatusInProgress ExportStatus = "InProgress"
	ExportStatusCompleted  ExportStatus = "Completed"
	ExportStatusFailed     ExportStatus = "Failed"
	ExportStatusDeleting   ExportStatus = "Deleting"
)

Enum values for ExportStatus

func (ExportStatus) Values added in v1.2.0 

func (ExportStatus) Values() []ExportStatus

Values returns all known values for ExportStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ExportSummary added in v1.2.0 

type ExportSummary struct {

	// The date and time that the export was created.
	CreationDateTime *time.Time

	// The unique identifier that Amazon Lex assigned to the export.
	ExportId *string

	// The status of the export. When the status is Completed the export is ready to
	// download.
	ExportStatus ExportStatus

	// The file format used in the export files.
	FileFormat ImportExportFileFormat

	// The date and time that the export was last updated.
	LastUpdatedDateTime *time.Time

	// Information about the bot or bot locale that was exported.
	ResourceSpecification *ExportResourceSpecification
	// contains filtered or unexported fields
}

Provides summary information about an export in an export list.

type ExternalSourceSetting added in v1.15.0 

type ExternalSourceSetting struct {

	// Settings required for a slot type based on a grammar that you provide.
	GrammarSlotTypeSetting *GrammarSlotTypeSetting
	// contains filtered or unexported fields
}

Provides information about the external source of the slot type's definition.

type FailedCustomVocabularyItem added in v1.26.0 

type FailedCustomVocabularyItem struct {

	// The unique error code for the failed custom vocabulary item from the custom
	// vocabulary list.
	ErrorCode ErrorCode

	// The error message for the failed custom vocabulary item from the custom
	// vocabulary list.
	ErrorMessage *string

	// The unique item identifer for the failed custom vocabulary item from the custom
	// vocabulary list.
	ItemId *string
	// contains filtered or unexported fields
}

The unique failed custom vocabulary item from the custom vocabulary list.

type FulfillmentCodeHookSettings 

type FulfillmentCodeHookSettings struct {

	// Indicates whether a Lambda function should be invoked to fulfill a specific
	// intent.
	//
	// This member is required.
	Enabled bool

	// Determines whether the fulfillment code hook is used. When active is false, the
	// code hook doesn't run.
	Active *bool

	// Provides settings for update messages sent to the user for long-running Lambda
	// fulfillment functions. Fulfillment updates can be used only with streaming
	// conversations.
	FulfillmentUpdatesSpecification *FulfillmentUpdatesSpecification

	// 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.
	PostFulfillmentStatusSpecification *PostFulfillmentStatusSpecification
	// contains filtered or unexported fields
}

Determines if a Lambda function should be invoked for a specific intent.

type FulfillmentStartResponseSpecification added in v1.9.0 

type FulfillmentStartResponseSpecification struct {

	// 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.
	//
	// This member is required.
	DelayInSeconds *int32

	// 1 - 5 message groups that contain start messages. Amazon Lex chooses one of the
	// messages to play to the user.
	//
	// This member is required.
	MessageGroups []MessageGroup

	// Determines whether the user can interrupt the start message while it is playing.
	AllowInterrupt *bool
	// contains filtered or unexported fields
}

Provides settings for a message that is sent to the user when a fulfillment Lambda function starts running.

type FulfillmentUpdateResponseSpecification added in v1.9.0 

type FulfillmentUpdateResponseSpecification struct {

	// 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.
	//
	// This member is required.
	FrequencyInSeconds *int32

	// 1 - 5 message groups that contain update messages. Amazon Lex chooses one of
	// the messages to play to the user.
	//
	// This member is required.
	MessageGroups []MessageGroup

	// Determines whether the user can interrupt an update message while it is playing.
	AllowInterrupt *bool
	// contains filtered or unexported fields
}

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

type FulfillmentUpdatesSpecification added in v1.9.0 

type FulfillmentUpdatesSpecification struct {

	// 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.
	//
	// This member is required.
	Active *bool

	// Provides configuration information for the message sent to users when the
	// fulfillment Lambda functions starts running.
	StartResponse *FulfillmentStartResponseSpecification

	// The length of time that the fulfillment Lambda function should run before it
	// times out.
	TimeoutInSeconds *int32

	// Provides configuration information for messages sent periodically to the user
	// while the fulfillment Lambda function is running.
	UpdateResponse *FulfillmentUpdateResponseSpecification
	// contains filtered or unexported fields
}

Provides information for updating the user on the progress of fulfilling an intent.

type GenerationSortBy added in v1.37.0 

type GenerationSortBy struct {

	// 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.
	//
	// This member is required.
	Attribute GenerationSortByAttribute

	// The order by which to sort the generation request information.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies the attribute and method by which to sort the generation request information.

type GenerationSortByAttribute added in v1.37.0 

type GenerationSortByAttribute string
const (
	GenerationSortByAttributeCreationStartTime GenerationSortByAttribute = "creationStartTime"
	GenerationSortByAttributeLastUpdatedTime   GenerationSortByAttribute = "lastUpdatedTime"
)

Enum values for GenerationSortByAttribute

func (GenerationSortByAttribute) Values added in v1.37.0 

func (GenerationSortByAttribute) Values() []GenerationSortByAttribute

Values returns all known values for GenerationSortByAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GenerationStatus added in v1.37.0 

type GenerationStatus string
const (
	GenerationStatusFailed     GenerationStatus = "Failed"
	GenerationStatusComplete   GenerationStatus = "Complete"
	GenerationStatusInProgress GenerationStatus = "InProgress"
)

Enum values for GenerationStatus

func (GenerationStatus) Values added in v1.37.0 

func (GenerationStatus) Values() []GenerationStatus

Values returns all known values for GenerationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type GenerationSummary added in v1.37.0 

type GenerationSummary struct {

	// The date and time at which the generation request was made.
	CreationDateTime *time.Time

	// The unique identifier of the generation request.
	GenerationId *string

	// The status of the generation request.
	GenerationStatus GenerationStatus

	// The date and time at which the generation request was last updated.
	LastUpdatedDateTime *time.Time
	// contains filtered or unexported fields
}

Contains information about a generation request made for the bot locale.

type GenerativeAISettings added in v1.37.0 

type GenerativeAISettings struct {

	// Contains specifications about the Amazon Lex build time generative AI
	// capabilities from Amazon Bedrock that you can turn on for your bot.
	BuildtimeSettings *BuildtimeSettings

	// Contains specifications about the Amazon Lex runtime generative AI capabilities
	// from Amazon Bedrock that you can turn on for your bot.
	RuntimeSettings *RuntimeSettings
	// contains filtered or unexported fields
}

Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

type GrammarSlotTypeSetting added in v1.15.0 

type GrammarSlotTypeSetting struct {

	// The source of the grammar used to create the slot type.
	Source *GrammarSlotTypeSource
	// contains filtered or unexported fields
}

Settings requried for a slot type based on a grammar that you provide.

type GrammarSlotTypeSource added in v1.15.0 

type GrammarSlotTypeSource struct {

	// The name of the Amazon S3 bucket that contains the grammar source.
	//
	// This member is required.
	S3BucketName *string

	// The path to the grammar in the Amazon S3 bucket.
	//
	// This member is required.
	S3ObjectKey *string

	// The KMS key required to decrypt the contents of the grammar, if any.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Describes the Amazon S3 bucket name and location for the grammar that is the source for the slot type.

type ImageResponseCard 

type ImageResponseCard struct {

	// The title to display on the response card. The format of the title is
	// determined by the platform displaying the response card.
	//
	// This member is required.
	Title *string

	// 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.
	Buttons []Button

	// 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.
	ImageUrl *string

	// The subtitle to display on the response card. The format of the subtitle is
	// determined by the platform displaying the response card.
	Subtitle *string
	// contains filtered or unexported fields
}

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.

type ImportExportFileFormat added in v1.2.0 

type ImportExportFileFormat string
const (
	ImportExportFileFormatLexJson ImportExportFileFormat = "LexJson"
	ImportExportFileFormatTsv     ImportExportFileFormat = "TSV"
	ImportExportFileFormatCsv     ImportExportFileFormat = "CSV"
)

Enum values for ImportExportFileFormat

func (ImportExportFileFormat) Values added in v1.2.0 

func (ImportExportFileFormat) Values() []ImportExportFileFormat

Values returns all known values for ImportExportFileFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportFilter added in v1.2.0 

type ImportFilter struct {

	// The name of the field to use for filtering.
	//
	// This member is required.
	Name ImportFilterName

	// 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.
	//
	// This member is required.
	Operator ImportFilterOperator

	// The values to use to filter the response. The values must be Bot , BotLocale ,
	// or CustomVocabulary .
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response from the ListImports (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) operation.

type ImportFilterName added in v1.2.0 

type ImportFilterName string
const (
	ImportFilterNameImportResourceType ImportFilterName = "ImportResourceType"
)

Enum values for ImportFilterName

func (ImportFilterName) Values added in v1.2.0 

func (ImportFilterName) Values() []ImportFilterName

Values returns all known values for ImportFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportFilterOperator added in v1.2.0 

type ImportFilterOperator string
const (
	ImportFilterOperatorContains ImportFilterOperator = "CO"
	ImportFilterOperatorEquals   ImportFilterOperator = "EQ"
)

Enum values for ImportFilterOperator

func (ImportFilterOperator) Values added in v1.2.0 

func (ImportFilterOperator) Values() []ImportFilterOperator

Values returns all known values for ImportFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportResourceSpecification added in v1.2.0 

type ImportResourceSpecification struct {

	// Parameters for importing a bot.
	BotImportSpecification *BotImportSpecification

	// Parameters for importing a bot locale.
	BotLocaleImportSpecification *BotLocaleImportSpecification

	// Provides the parameters required for importing a custom vocabulary.
	CustomVocabularyImportSpecification *CustomVocabularyImportSpecification

	// Specifications for the test set that is imported.
	TestSetImportResourceSpecification *TestSetImportResourceSpecification
	// contains filtered or unexported fields
}

Provides information about the bot or bot locale that you want to import. You can specify the botImportSpecification or the botLocaleImportSpecification , but not both.

type ImportResourceType added in v1.17.0 

type ImportResourceType string
const (
	ImportResourceTypeBot              ImportResourceType = "Bot"
	ImportResourceTypeBotLocale        ImportResourceType = "BotLocale"
	ImportResourceTypeCustomVocabulary ImportResourceType = "CustomVocabulary"
	ImportResourceTypeTestSet          ImportResourceType = "TestSet"
)

Enum values for ImportResourceType

func (ImportResourceType) Values added in v1.17.0 

func (ImportResourceType) Values() []ImportResourceType

Values returns all known values for ImportResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportSortAttribute added in v1.2.0 

type ImportSortAttribute string
const (
	ImportSortAttributeLastUpdatedDateTime ImportSortAttribute = "LastUpdatedDateTime"
)

Enum values for ImportSortAttribute

func (ImportSortAttribute) Values added in v1.2.0 

func (ImportSortAttribute) Values() []ImportSortAttribute

Values returns all known values for ImportSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportSortBy added in v1.2.0 

type ImportSortBy struct {

	// The export field to use for sorting.
	//
	// This member is required.
	Attribute ImportSortAttribute

	// The order to sort the list.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Provides information for sorting a list of imports.

type ImportStatus added in v1.2.0 

type ImportStatus string
const (
	ImportStatusInProgress ImportStatus = "InProgress"
	ImportStatusCompleted  ImportStatus = "Completed"
	ImportStatusFailed     ImportStatus = "Failed"
	ImportStatusDeleting   ImportStatus = "Deleting"
)

Enum values for ImportStatus

func (ImportStatus) Values added in v1.2.0 

func (ImportStatus) Values() []ImportStatus

Values returns all known values for ImportStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ImportSummary added in v1.2.0 

type ImportSummary struct {

	// The date and time that the import was created.
	CreationDateTime *time.Time

	// The unique identifier that Amazon Lex assigned to the import.
	ImportId *string

	// The status of the resource. When the status is Completed the resource is ready
	// to build.
	ImportStatus ImportStatus

	// The unique identifier that Amazon Lex assigned to the imported resource.
	ImportedResourceId *string

	// The name that you gave the imported resource.
	ImportedResourceName *string

	// The type of resource that was imported.
	ImportedResourceType ImportResourceType

	// The date and time that the import was last updated.
	LastUpdatedDateTime *time.Time

	// The strategy used to merge existing bot or bot locale definitions with the
	// imported definition.
	MergeStrategy MergeStrategy
	// contains filtered or unexported fields
}

Provides summary information about an import in an import list.

type InitialResponseSetting added in v1.22.0 

type InitialResponseSetting struct {

	// Settings that specify the dialog code hook that is called by Amazon Lex at a
	// step of the conversation.
	CodeHook *DialogCodeHookInvocationSetting

	// 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.
	Conditional *ConditionalSpecification

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	InitialResponse *ResponseSpecification

	// The next step in the conversation.
	NextStep *DialogState
	// contains filtered or unexported fields
}

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

type InputContext 

type InputContext struct {

	// The name of the context.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A context that must be active for an intent to be selected by Amazon Lex.

type InputSessionStateSpecification added in v1.29.0 

type InputSessionStateSpecification struct {

	// Active contexts for the session state.
	ActiveContexts []ActiveContext

	// Runtime hints for the session state.
	RuntimeHints *RuntimeHints

	// Session attributes for the session state.
	SessionAttributes map[string]string
	// contains filtered or unexported fields
}

Specifications for the current state of the dialog between the user and the bot in the test set.

type IntentClassificationTestResultItem added in v1.29.0 

type IntentClassificationTestResultItem struct {

	// The name of the intent.
	//
	// This member is required.
	IntentName *string

	// Indicates whether the conversation involves multiple turns or not.
	//
	// This member is required.
	MultiTurnConversation bool

	// The result of the intent classification test.
	//
	// This member is required.
	ResultCounts *IntentClassificationTestResultItemCounts
	// contains filtered or unexported fields
}

Information for an intent that is classified by the test workbench.

type IntentClassificationTestResultItemCounts added in v1.29.0 

type IntentClassificationTestResultItemCounts struct {

	// The number of matched and mismatched results for intent recognition for the
	// intent.
	//
	// This member is required.
	IntentMatchResultCounts map[string]int32

	// The total number of results in the intent classification test.
	//
	// This member is required.
	TotalResultCount *int32

	// The number of matched, mismatched, and execution error results for speech
	// transcription for the intent.
	SpeechTranscriptionResultCounts map[string]int32
	// contains filtered or unexported fields
}

The number of items in the intent classification test.

type IntentClassificationTestResults added in v1.29.0 

type IntentClassificationTestResults struct {

	// A list of the results for the intent classification test.
	//
	// This member is required.
	Items []IntentClassificationTestResultItem
	// contains filtered or unexported fields
}

Information for the results of the intent classification test.

type IntentClosingSetting 

type IntentClosingSetting struct {

	// 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.
	Active *bool

	// The response that Amazon Lex sends to the user when the intent is complete.
	ClosingResponse *ResponseSpecification

	// A list of conditional branches associated with the intent's closing response.
	// These branches are executed when the nextStep attribute is set to
	// EvalutateConditional .
	Conditional *ConditionalSpecification

	// Specifies the next step that the bot executes after playing the intent's
	// closing response.
	NextStep *DialogState
	// contains filtered or unexported fields
}

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

type IntentConfirmationSetting 

type IntentConfirmationSetting struct {

	// 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.
	//
	// This member is required.
	PromptSpecification *PromptSpecification

	// 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.
	Active *bool

	// 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 .
	CodeHook *DialogCodeHookInvocationSetting

	// A list of conditional branches to evaluate after the intent is closed.
	ConfirmationConditional *ConditionalSpecification

	// Specifies the next step that the bot executes when the customer confirms the
	// intent.
	ConfirmationNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	ConfirmationResponse *ResponseSpecification

	// A list of conditional branches to evaluate after the intent is declined.
	DeclinationConditional *ConditionalSpecification

	// Specifies the next step that the bot executes when the customer declines the
	// intent.
	DeclinationNextStep *DialogState

	// When the user answers "no" to the question defined in promptSpecification ,
	// Amazon Lex responds with this response to acknowledge that the intent was
	// canceled.
	DeclinationResponse *ResponseSpecification

	// The DialogCodeHookInvocationSetting used when the code hook is invoked during
	// confirmation prompt retries.
	ElicitationCodeHook *ElicitationCodeHookInvocationSetting

	// 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.
	FailureConditional *ConditionalSpecification

	// The next step to take in the conversation if the confirmation step fails.
	FailureNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	FailureResponse *ResponseSpecification
	// contains filtered or unexported fields
}

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

type IntentFilter 

type IntentFilter struct {

	// The name of the field to use for the filter.
	//
	// This member is required.
	Name IntentFilterName

	// 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.
	//
	// This member is required.
	Operator IntentFilterOperator

	// The value to use for the filter.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response from the ListIntents operation.

type IntentFilterName 

type IntentFilterName string
const (
	IntentFilterNameIntentName IntentFilterName = "IntentName"
)

Enum values for IntentFilterName

func (IntentFilterName) Values 

func (IntentFilterName) Values() []IntentFilterName

Values returns all known values for IntentFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IntentFilterOperator 

type IntentFilterOperator string
const (
	IntentFilterOperatorContains IntentFilterOperator = "CO"
	IntentFilterOperatorEquals   IntentFilterOperator = "EQ"
)

Enum values for IntentFilterOperator

func (IntentFilterOperator) Values 

func (IntentFilterOperator) Values() []IntentFilterOperator

Values returns all known values for IntentFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IntentLevelSlotResolutionTestResultItem added in v1.29.0 

type IntentLevelSlotResolutionTestResultItem struct {

	// The name of the intent that was recognized.
	//
	// This member is required.
	IntentName *string

	// Indicates whether the conversation involves multiple turns or not.
	//
	// This member is required.
	MultiTurnConversation bool

	// The results for the slot resolution in the test execution result.
	//
	// This member is required.
	SlotResolutionResults []SlotResolutionTestResultItem
	// contains filtered or unexported fields
}

Information about intent-level slot resolution in a test result.

type IntentLevelSlotResolutionTestResults added in v1.29.0 

type IntentLevelSlotResolutionTestResults struct {

	// Indicates the items for the slot level resolution for the intents.
	//
	// This member is required.
	Items []IntentLevelSlotResolutionTestResultItem
	// contains filtered or unexported fields
}

Indicates the success or failure of slots at the intent level.

type IntentOverride added in v1.22.0 

type IntentOverride struct {

	// The name of the intent. Only required when you're switching intents.
	Name *string

	// 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.
	Slots map[string]SlotValueOverride
	// contains filtered or unexported fields
}

Override settings to configure the intent state.

type IntentSortAttribute 

type IntentSortAttribute string
const (
	IntentSortAttributeIntentName          IntentSortAttribute = "IntentName"
	IntentSortAttributeLastUpdatedDateTime IntentSortAttribute = "LastUpdatedDateTime"
)

Enum values for IntentSortAttribute

func (IntentSortAttribute) Values 

func (IntentSortAttribute) Values() []IntentSortAttribute

Values returns all known values for IntentSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IntentSortBy 

type IntentSortBy struct {

	// The attribute to use to sort the list of intents.
	//
	// This member is required.
	Attribute IntentSortAttribute

	// The order to sort the list. You can choose ascending or descending.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of intents.

type IntentState added in v1.30.0 

type IntentState string
const (
	IntentStateFailed                IntentState = "Failed"
	IntentStateFulfilled             IntentState = "Fulfilled"
	IntentStateInProgress            IntentState = "InProgress"
	IntentStateReadyForFulfillment   IntentState = "ReadyForFulfillment"
	IntentStateWaiting               IntentState = "Waiting"
	IntentStateFulfillmentInProgress IntentState = "FulfillmentInProgress"
)

Enum values for IntentState

func (IntentState) Values added in v1.30.0 

func (IntentState) Values() []IntentState

Values returns all known values for IntentState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type IntentStatistics added in v1.14.0 

type IntentStatistics struct {

	// The number of recommended intents associated with the bot recommendation.
	DiscoveredIntentCount *int32
	// contains filtered or unexported fields
}

The object that contains the statistical summary of recommended intents associated with the bot recommendation.

type IntentSummary 

type IntentSummary struct {

	// The description of the intent.
	Description *string

	// The input contexts that must be active for this intent to be considered for
	// recognition.
	InputContexts []InputContext

	// The unique identifier assigned to the intent. Use this ID to get detailed
	// information about the intent with the DescribeIntent operation.
	IntentId *string

	// The name of the intent.
	IntentName *string

	// The timestamp of the date and time that the intent was last updated.
	LastUpdatedDateTime *time.Time

	// The output contexts that are activated when this intent is fulfilled.
	OutputContexts []OutputContext

	// If this intent is derived from a built-in intent, the name of the parent intent.
	ParentIntentSignature *string
	// contains filtered or unexported fields
}

Summary information about an intent returned by the ListIntents operation.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service encountered an unexpected condition. Try your request again.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvokedIntentSample added in v1.30.0 

type InvokedIntentSample struct {

	// The name of an intent that was invoked.
	IntentName *string
	// contains filtered or unexported fields
}

An object containing the name of an intent that was invoked.

type KendraConfiguration 

type KendraConfiguration struct {

	// 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.
	//
	// This member is required.
	KendraIndex *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 (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html)
	// .
	QueryFilterString *string

	// Determines whether the AMAZON.KendraSearchIntent intent uses a custom query
	// string to query the Amazon Kendra index.
	QueryFilterStringEnabled bool
	// contains filtered or unexported fields
}

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.

type LambdaCodeHook 

type LambdaCodeHook struct {

	// The version of the request-response that you want Amazon Lex to use to invoke
	// your Lambda function.
	//
	// This member is required.
	CodeHookInterfaceVersion *string

	// The Amazon Resource Name (ARN) of the Lambda function.
	//
	// This member is required.
	LambdaARN *string
	// contains filtered or unexported fields
}

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

type LexTranscriptFilter added in v1.14.0 

type LexTranscriptFilter struct {

	// 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.
	DateRangeFilter *DateRangeFilter
	// contains filtered or unexported fields
}

The object that contains transcript filter details that are associated with a bot recommendation.

type MergeStrategy added in v1.2.0 

type MergeStrategy string
const (
	MergeStrategyOverwrite      MergeStrategy = "Overwrite"
	MergeStrategyFailOnConflict MergeStrategy = "FailOnConflict"
	MergeStrategyAppend         MergeStrategy = "Append"
)

Enum values for MergeStrategy

func (MergeStrategy) Values added in v1.2.0 

func (MergeStrategy) Values() []MergeStrategy

Values returns all known values for MergeStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Message 

type Message struct {

	// A message in a custom format defined by the client application.
	CustomPayload *CustomPayload

	// A message that defines a response card that the client application can show to
	// the user.
	ImageResponseCard *ImageResponseCard

	// A message in plain text format.
	PlainTextMessage *PlainTextMessage

	// A message in Speech Synthesis Markup Language (SSML).
	SsmlMessage *SSMLMessage
	// contains filtered or unexported fields
}

The object that provides message text and its type.

type MessageGroup 

type MessageGroup struct {

	// The primary message that Amazon Lex should send to the user.
	//
	// This member is required.
	Message *Message

	// 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.
	Variations []Message
	// contains filtered or unexported fields
}

Provides one or more messages that Amazon Lex should send to the user.

type MessageSelectionStrategy added in v1.21.0 

type MessageSelectionStrategy string
const (
	MessageSelectionStrategyRandom  MessageSelectionStrategy = "Random"
	MessageSelectionStrategyOrdered MessageSelectionStrategy = "Ordered"
)

Enum values for MessageSelectionStrategy

func (MessageSelectionStrategy) Values added in v1.21.0 

func (MessageSelectionStrategy) Values() []MessageSelectionStrategy

Values returns all known values for MessageSelectionStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type MultipleValuesSetting added in v1.3.0 

type MultipleValuesSetting struct {

	// 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 .
	AllowMultipleValues bool
	// contains filtered or unexported fields
}

Indicates whether a slot can return multiple values.

type NewCustomVocabularyItem added in v1.26.0 

type NewCustomVocabularyItem struct {

	// The unique phrase for the new custom vocabulary item from the custom vocabulary
	// list.
	//
	// This member is required.
	Phrase *string

	// The display as value assigned to the new custom vocabulary item from the custom
	// vocabulary list.
	DisplayAs *string

	// The weight assigned to the new custom vocabulary item from the custom
	// vocabulary list.
	Weight *int32
	// contains filtered or unexported fields
}

The new custom vocabulary item from the custom vocabulary list.

type ObfuscationSetting 

type ObfuscationSetting struct {

	// Value that determines whether Amazon Lex obscures slot values in conversation
	// logs. The default is to obscure the values.
	//
	// This member is required.
	ObfuscationSettingType ObfuscationSettingType
	// contains filtered or unexported fields
}

Determines whether Amazon Lex obscures slot values in conversation logs.

type ObfuscationSettingType 

type ObfuscationSettingType string
const (
	ObfuscationSettingTypeNone               ObfuscationSettingType = "None"
	ObfuscationSettingTypeDefaultObfuscation ObfuscationSettingType = "DefaultObfuscation"
)

Enum values for ObfuscationSettingType

func (ObfuscationSettingType) Values 

func (ObfuscationSettingType) Values() []ObfuscationSettingType

Values returns all known values for ObfuscationSettingType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OpensearchConfiguration added in v1.43.0 

type OpensearchConfiguration struct {

	// The endpoint of the Amazon OpenSearch Service domain.
	//
	// This member is required.
	DomainEndpoint *string

	// The name of the Amazon OpenSearch Service index.
	//
	// This member is required.
	IndexName *string

	// Specifies whether to return an exact response or to return an answer generated
	// by the model using the fields you specify from the database.
	ExactResponse bool

	// Contains the names of the fields used for an exact response to the user.
	ExactResponseFields *ExactResponseFields

	// Contains a list of fields from the Amazon OpenSearch Service that the model can
	// use to generate the answer to the query.
	IncludeFields []string
	// contains filtered or unexported fields
}

Contains details about the configuration of the Amazon OpenSearch Service database used for the AMAZON.QnAIntent .

type OutputContext 

type OutputContext struct {

	// The name of the output context.
	//
	// This member is required.
	Name *string

	// 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.
	//
	// This member is required.
	TimeToLiveInSeconds *int32

	// 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.
	//
	// This member is required.
	TurnsToLive *int32
	// contains filtered or unexported fields
}

Describes a session context that is activated when an intent is fulfilled.

type OverallTestResultItem added in v1.29.0 

type OverallTestResultItem struct {

	// The number of results that succeeded.
	//
	// This member is required.
	EndToEndResultCounts map[string]int32

	// Indicates whether the conversation contains multiple turns or not.
	//
	// This member is required.
	MultiTurnConversation bool

	// The total number of overall results in the result of the test execution.
	//
	// This member is required.
	TotalResultCount *int32

	// The number of speech transcription results in the overall test.
	SpeechTranscriptionResultCounts map[string]int32
	// contains filtered or unexported fields
}

Information about the overall results for a test execution result.

type OverallTestResults added in v1.29.0 

type OverallTestResults struct {

	// A list of the overall test results.
	//
	// This member is required.
	Items []OverallTestResultItem
	// contains filtered or unexported fields
}

Information about the overall test results.

type ParentBotNetwork added in v1.28.0 

type ParentBotNetwork struct {

	// The identifier of the network of bots assigned by Amazon Lex.
	//
	// This member is required.
	BotId *string

	// The version of the network of bots.
	//
	// This member is required.
	BotVersion *string
	// contains filtered or unexported fields
}

A network of bots.

type PathFormat added in v1.14.0 

type PathFormat struct {

	// 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.
	ObjectPrefixes []string
	// contains filtered or unexported fields
}

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.

type PlainTextMessage 

type PlainTextMessage struct {

	// The message to send to the user.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Defines an ASCII text message to send to the user.

type PostDialogCodeHookInvocationSpecification added in v1.22.0 

type PostDialogCodeHookInvocationSpecification struct {

	// 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 .
	FailureConditional *ConditionalSpecification

	// 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 .
	FailureNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	FailureResponse *ResponseSpecification

	// A list of conditional branches to evaluate after the dialog code hook finishes
	// successfully.
	SuccessConditional *ConditionalSpecification

	// Specifics the next step the bot runs after the dialog code hook finishes
	// successfully.
	SuccessNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	SuccessResponse *ResponseSpecification

	// A list of conditional branches to evaluate if the code hook times out.
	TimeoutConditional *ConditionalSpecification

	// Specifies the next step that the bot runs when the code hook times out.
	TimeoutNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	TimeoutResponse *ResponseSpecification
	// contains filtered or unexported fields
}

Specifies next steps to run after the dialog code hook finishes.

type PostFulfillmentStatusSpecification added in v1.9.0 

type PostFulfillmentStatusSpecification struct {

	// 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 .
	FailureConditional *ConditionalSpecification

	// 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 .
	FailureNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	FailureResponse *ResponseSpecification

	// A list of conditional branches to evaluate after the fulfillment code hook
	// finishes successfully.
	SuccessConditional *ConditionalSpecification

	// Specifies the next step in the conversation that Amazon Lex invokes when the
	// fulfillment code hook completes successfully.
	SuccessNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	SuccessResponse *ResponseSpecification

	// A list of conditional branches to evaluate if the fulfillment code hook times
	// out.
	TimeoutConditional *ConditionalSpecification

	// Specifies the next step that the bot runs when the fulfillment code hook times
	// out.
	TimeoutNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	TimeoutResponse *ResponseSpecification
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete)

type PreconditionFailedException 

type PreconditionFailedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

func (*PreconditionFailedException) Error 

func (e *PreconditionFailedException) Error() string

func (*PreconditionFailedException) ErrorCode 

func (e *PreconditionFailedException) ErrorCode() string

func (*PreconditionFailedException) ErrorFault 

func (e *PreconditionFailedException) ErrorFault() smithy.ErrorFault

func (*PreconditionFailedException) ErrorMessage 

func (e *PreconditionFailedException) ErrorMessage() string

type Principal added in v1.2.0 

type Principal struct {

	// The Amazon Resource Name (ARN) of the principal.
	Arn *string

	// The name of the Amazon Web Services service that should allowed or denied
	// access to an Amazon Lex action.
	Service *string
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html) .

type PromptAttempt added in v1.25.0 

type PromptAttempt string
const (
	PromptAttemptInitial PromptAttempt = "Initial"
	PromptAttemptRetry1  PromptAttempt = "Retry1"
	PromptAttemptRetry2  PromptAttempt = "Retry2"
	PromptAttemptRetry3  PromptAttempt = "Retry3"
	PromptAttemptRetry4  PromptAttempt = "Retry4"
	PromptAttemptRetry5  PromptAttempt = "Retry5"
)

Enum values for PromptAttempt

func (PromptAttempt) Values added in v1.25.0 

func (PromptAttempt) Values() []PromptAttempt

Values returns all known values for PromptAttempt. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PromptAttemptSpecification added in v1.25.0 

type PromptAttemptSpecification struct {

	// Indicates the allowed input types of the prompt attempt.
	//
	// This member is required.
	AllowedInputTypes *AllowedInputTypes

	// Indicates whether the user can interrupt a speech prompt attempt from the bot.
	AllowInterrupt *bool

	// Specifies the settings on audio and DTMF input.
	AudioAndDTMFInputSpecification *AudioAndDTMFInputSpecification

	// Specifies the settings on text input.
	TextInputSpecification *TextInputSpecification
	// contains filtered or unexported fields
}

Specifies the settings on a prompt attempt.

type PromptSpecification 

type PromptSpecification struct {

	// The maximum number of times the bot tries to elicit a response from the user
	// using this prompt.
	//
	// This member is required.
	MaxRetries *int32

	// A collection of messages that Amazon Lex can send to the user. Amazon Lex
	// chooses the actual message to send at runtime.
	//
	// This member is required.
	MessageGroups []MessageGroup

	// Indicates whether the user can interrupt a speech prompt from the bot.
	AllowInterrupt *bool

	// Indicates how a message is selected from a message group among retries.
	MessageSelectionStrategy MessageSelectionStrategy

	// Specifies the advanced settings on each attempt of the prompt.
	PromptAttemptsSpecification map[string]PromptAttemptSpecification
	// contains filtered or unexported fields
}

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

type QnAIntentConfiguration added in v1.43.0 

type QnAIntentConfiguration struct {

	// Contains information about the Amazon Bedrock model used to interpret the
	// prompt used in descriptive bot building.
	BedrockModelConfiguration *BedrockModelSpecification

	// Contains details about the configuration of the data source used for the
	// AMAZON.QnAIntent .
	DataSourceConfiguration *DataSourceConfiguration
	// contains filtered or unexported fields
}

Details about the the configuration of the built-in Amazon.QnAIntent .

type QnAKendraConfiguration added in v1.43.0 

type QnAKendraConfiguration struct {

	// The ARN of the Amazon Kendra index to use.
	//
	// This member is required.
	KendraIndex *string

	// 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 (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html)
	// .
	ExactResponse bool

	// 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 (https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering)
	// .
	QueryFilterString *string

	// Specifies whether to enable an Amazon Kendra filter string or not.
	QueryFilterStringEnabled bool
	// contains filtered or unexported fields
}

Contains details about the configuration of the Amazon Kendra index used for the AMAZON.QnAIntent .

type RecommendedIntentSummary added in v1.14.0 

type RecommendedIntentSummary struct {

	// The unique identifier of a recommended intent associated with the bot
	// recommendation.
	IntentId *string

	// The name of a recommended intent associated with the bot recommendation.
	IntentName *string

	// The count of sample utterances of a recommended intent that is associated with
	// a bot recommendation.
	SampleUtterancesCount *int32
	// contains filtered or unexported fields
}

An object that contains a summary of a recommended intent.

type RelativeAggregationDuration added in v1.8.0 

type RelativeAggregationDuration struct {

	// The type of time period that the timeValue field represents.
	//
	// This member is required.
	TimeDimension TimeDimension

	// 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
	//
	// This member is required.
	TimeValue *int32
	// contains filtered or unexported fields
}

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.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResponseSpecification 

type ResponseSpecification struct {

	// A collection of responses that Amazon Lex can send to the user. Amazon Lex
	// chooses the actual response to send at runtime.
	//
	// This member is required.
	MessageGroups []MessageGroup

	// Indicates whether the user can interrupt a speech response from Amazon Lex.
	AllowInterrupt *bool
	// contains filtered or unexported fields
}

Specifies a list of message groups that Amazon Lex uses to respond the user input.

type RuntimeHintDetails added in v1.29.0 

type RuntimeHintDetails struct {

	// 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.
	RuntimeHintValues []RuntimeHintValue

	// 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.
	SubSlotHints map[string]RuntimeHintDetails
	// contains filtered or unexported fields
}

Provides an array of phrases that should be given preference when resolving values for a slot.

type RuntimeHintValue added in v1.29.0 

type RuntimeHintValue struct {

	// The phrase that Amazon Lex should look for in the user's input to the bot.
	//
	// This member is required.
	Phrase *string
	// contains filtered or unexported fields
}

Provides the phrase that Amazon Lex should look for in the user's input to the bot.

type RuntimeHints added in v1.29.0 

type RuntimeHints struct {

	// 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 (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html)
	// . The intent name and slot name must exist.
	SlotHints map[string]map[string]RuntimeHintDetails
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/lexv2/latest/dg/using-hints.html) .

type RuntimeSettings added in v1.37.0 

type RuntimeSettings struct {

	// An object containing specifications for the assisted slot resolution feature.
	SlotResolutionImprovement *SlotResolutionImprovementSpecification
	// contains filtered or unexported fields
}

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

type S3BucketLogDestination 

type S3BucketLogDestination struct {

	// The S3 prefix to assign to audio log files.
	//
	// This member is required.
	LogPrefix *string

	// The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are
	// stored.
	//
	// This member is required.
	S3BucketArn *string

	// 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.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Specifies an Amazon S3 bucket for logging audio conversations

type S3BucketTranscriptSource added in v1.14.0 

type S3BucketTranscriptSource struct {

	// The name of the bucket containing the transcript and the associated metadata.
	//
	// This member is required.
	S3BucketName *string

	// The format of the transcript content. Currently, Genie only supports the Amazon
	// Lex transcript format.
	//
	// This member is required.
	TranscriptFormat TranscriptFormat

	// 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.
	KmsKeyArn *string

	// 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.
	PathFormat *PathFormat

	// 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.
	TranscriptFilter *TranscriptFilter
	// contains filtered or unexported fields
}

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

type SSMLMessage 

type SSMLMessage struct {

	// The SSML text that defines the prompt.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Defines a Speech Synthesis Markup Language (SSML) prompt.

type SampleUtterance 

type SampleUtterance struct {

	// The sample utterance that Amazon Lex uses to build its machine-learning model
	// to recognize intents.
	//
	// This member is required.
	Utterance *string
	// contains filtered or unexported fields
}

A sample utterance that invokes an intent or respond to a slot elicitation prompt.

type SampleUtteranceGenerationSpecification added in v1.37.0 

type SampleUtteranceGenerationSpecification struct {

	// Specifies whether to enable sample utterance generation or not.
	//
	// This member is required.
	Enabled bool

	// Contains information about the Amazon Bedrock model used to interpret the
	// prompt used in descriptive bot building.
	BedrockModelSpecification *BedrockModelSpecification
	// contains filtered or unexported fields
}

Contains specifications for the sample utterance generation feature.

type SampleValue 

type SampleValue struct {

	// The value that can be used for a slot type.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Defines one of the values for a slot type.

type SearchOrder added in v1.14.0 

type SearchOrder string
const (
	SearchOrderAscending  SearchOrder = "Ascending"
	SearchOrderDescending SearchOrder = "Descending"
)

Enum values for SearchOrder

func (SearchOrder) Values added in v1.14.0 

func (SearchOrder) Values() []SearchOrder

Values returns all known values for SearchOrder. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SentimentAnalysisSettings 

type SentimentAnalysisSettings struct {

	// Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user
	// utterances.
	//
	// This member is required.
	DetectSentiment bool
	// contains filtered or unexported fields
}

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You have reached a quota for your bot.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SessionDataSortBy added in v1.30.0 

type SessionDataSortBy struct {

	// 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.
	//
	// This member is required.
	Name AnalyticsSessionSortByName

	// Specifies whether to sort the results in ascending or descending order.
	//
	// This member is required.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

An object specifying the measure and method by which to sort the session analytics data.

type SessionSpecification added in v1.30.0 

type SessionSpecification struct {

	// The identifier of the alias of the bot that the session was held with.
	BotAliasId *string

	// The version of the bot that the session was held with.
	BotVersion *string

	// The channel that is integrated with the bot that the session was held with.
	Channel *string

	// The duration of the conversation in seconds. A conversation is defined as a
	// unique combination of a sessionId and an originatingRequestId .
	ConversationDurationSeconds *int64

	// The final state of the conversation. A conversation is defined as a unique
	// combination of a sessionId and an originatingRequestId .
	ConversationEndState ConversationEndState

	// The date and time when the conversation ended. A conversation is defined as a
	// unique combination of a sessionId and an originatingRequestId .
	ConversationEndTime *time.Time

	// The date and time when the conversation began. A conversation is defined as a
	// unique combination of a sessionId and an originatingRequestId .
	ConversationStartTime *time.Time

	// A list of objects containing the name of an intent that was invoked.
	InvokedIntentSamples []InvokedIntentSample

	// The locale of the bot that the session was held with.
	LocaleId *string

	// 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.
	Mode AnalyticsModality

	// The number of turns that the session took.
	NumberOfTurns *int64

	// The identifier of the first request in a session.
	OriginatingRequestId *string

	// The identifier of the session.
	SessionId *string
	// contains filtered or unexported fields
}

An object containing information about a specific session.

type SlotCaptureSetting added in v1.22.0 

type SlotCaptureSetting struct {

	// A list of conditional branches to evaluate after the slot value is captured.
	CaptureConditional *ConditionalSpecification

	// Specifies the next step that the bot runs when the slot value is captured
	// before the code hook times out.
	CaptureNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	CaptureResponse *ResponseSpecification

	// Code hook called after Amazon Lex successfully captures a slot value.
	CodeHook *DialogCodeHookInvocationSetting

	// Code hook called when Amazon Lex doesn't capture a slot value.
	ElicitationCodeHook *ElicitationCodeHookInvocationSetting

	// A list of conditional branches to evaluate when the slot value isn't captured.
	FailureConditional *ConditionalSpecification

	// Specifies the next step that the bot runs when the slot value code is not
	// recognized.
	FailureNextStep *DialogState

	// Specifies a list of message groups that Amazon Lex uses to respond the user
	// input.
	FailureResponse *ResponseSpecification
	// contains filtered or unexported fields
}

Settings used when Amazon Lex successfully captures a slot value from a user.

type SlotConstraint 

type SlotConstraint string
const (
	SlotConstraintRequired SlotConstraint = "Required"
	SlotConstraintOptional SlotConstraint = "Optional"
)

Enum values for SlotConstraint

func (SlotConstraint) Values 

func (SlotConstraint) Values() []SlotConstraint

Values returns all known values for SlotConstraint. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotDefaultValue 

type SlotDefaultValue struct {

	// The default value to use when a user doesn't provide a value for a slot.
	//
	// This member is required.
	DefaultValue *string
	// contains filtered or unexported fields
}

Specifies the default value to use when a user doesn't provide a value for a slot.

type SlotDefaultValueSpecification 

type SlotDefaultValueSpecification struct {

	// A list of default values. Amazon Lex chooses the default value to use in the
	// order that they are presented in the list.
	//
	// This member is required.
	DefaultValueList []SlotDefaultValue
	// contains filtered or unexported fields
}

Defines a list of values that Amazon Lex should use as the default value for a slot.

type SlotFilter 

type SlotFilter struct {

	// The name of the field to use for filtering.
	//
	// This member is required.
	Name SlotFilterName

	// 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.
	//
	// This member is required.
	Operator SlotFilterOperator

	// The value to use to filter the response.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response from the ListSlots operation.

type SlotFilterName 

type SlotFilterName string
const (
	SlotFilterNameSlotName SlotFilterName = "SlotName"
)

Enum values for SlotFilterName

func (SlotFilterName) Values 

func (SlotFilterName) Values() []SlotFilterName

Values returns all known values for SlotFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotFilterOperator 

type SlotFilterOperator string
const (
	SlotFilterOperatorContains SlotFilterOperator = "CO"
	SlotFilterOperatorEquals   SlotFilterOperator = "EQ"
)

Enum values for SlotFilterOperator

func (SlotFilterOperator) Values 

func (SlotFilterOperator) Values() []SlotFilterOperator

Values returns all known values for SlotFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotPriority 

type SlotPriority struct {

	// The priority that Amazon Lex should apply to the slot.
	//
	// This member is required.
	Priority *int32

	// The unique identifier of the slot.
	//
	// This member is required.
	SlotId *string
	// contains filtered or unexported fields
}

Sets the priority that Amazon Lex should use when eliciting slot values from a user.

type SlotResolutionImprovementSpecification added in v1.37.0 

type SlotResolutionImprovementSpecification struct {

	// Specifies whether assisted slot resolution is turned on or off.
	//
	// This member is required.
	Enabled bool

	// An object containing information about the Amazon Bedrock model used to assist
	// slot resolution.
	BedrockModelSpecification *BedrockModelSpecification
	// contains filtered or unexported fields
}

Contains specifications for the assisted slot resolution feature.

type SlotResolutionSetting added in v1.37.0 

type SlotResolutionSetting struct {

	// 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.
	//
	// This member is required.
	SlotResolutionStrategy SlotResolutionStrategy
	// contains filtered or unexported fields
}

Contains information about whether assisted slot resolution is turned on for the slot or not.

type SlotResolutionStrategy added in v1.37.0 

type SlotResolutionStrategy string
const (
	SlotResolutionStrategyEnhancedFallback SlotResolutionStrategy = "EnhancedFallback"
	SlotResolutionStrategyDefault          SlotResolutionStrategy = "Default"
)

Enum values for SlotResolutionStrategy

func (SlotResolutionStrategy) Values added in v1.37.0 

func (SlotResolutionStrategy) Values() []SlotResolutionStrategy

Values returns all known values for SlotResolutionStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotResolutionTestResultItem added in v1.29.0 

type SlotResolutionTestResultItem struct {

	// A result for slot resolution in the results of a test execution.
	//
	// This member is required.
	ResultCounts *SlotResolutionTestResultItemCounts

	// The name of the slot.
	//
	// This member is required.
	SlotName *string
	// contains filtered or unexported fields
}

Information about the success and failure rate of slot resolution in the results of a test execution.

type SlotResolutionTestResultItemCounts added in v1.29.0 

type SlotResolutionTestResultItemCounts struct {

	// The number of matched and mismatched results for slot resolution for the slot.
	//
	// This member is required.
	SlotMatchResultCounts map[string]int32

	// The total number of results.
	//
	// This member is required.
	TotalResultCount *int32

	// The number of matched, mismatched and execution error results for speech
	// transcription for the slot.
	SpeechTranscriptionResultCounts map[string]int32
	// contains filtered or unexported fields
}

Information about the counts for a slot resolution in the results of a test execution.

type SlotShape added in v1.22.0 

type SlotShape string
const (
	SlotShapeScalar SlotShape = "Scalar"
	SlotShapeList   SlotShape = "List"
)

Enum values for SlotShape

func (SlotShape) Values added in v1.22.0 

func (SlotShape) Values() []SlotShape

Values returns all known values for SlotShape. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotSortAttribute 

type SlotSortAttribute string
const (
	SlotSortAttributeSlotName            SlotSortAttribute = "SlotName"
	SlotSortAttributeLastUpdatedDateTime SlotSortAttribute = "LastUpdatedDateTime"
)

Enum values for SlotSortAttribute

func (SlotSortAttribute) Values 

func (SlotSortAttribute) Values() []SlotSortAttribute

Values returns all known values for SlotSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotSortBy 

type SlotSortBy struct {

	// The attribute to use to sort the list.
	//
	// This member is required.
	Attribute SlotSortAttribute

	// The order to sort the list. You can choose ascending or descending.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of bots.

type SlotSummary 

type SlotSummary struct {

	// The description of the slot.
	Description *string

	// The timestamp of the last date and time that the slot was updated.
	LastUpdatedDateTime *time.Time

	// Whether the slot is required or optional. An intent is complete when all
	// required slots are filled.
	SlotConstraint SlotConstraint

	// The unique identifier of the slot.
	SlotId *string

	// The name given to the slot.
	SlotName *string

	// The unique identifier for the slot type that defines the values for the slot.
	SlotTypeId *string

	// Prompts that are sent to the user to elicit a value for the slot.
	ValueElicitationPromptSpecification *PromptSpecification
	// contains filtered or unexported fields
}

Summary information about a slot, a value that the bot elicits from the user.

type SlotTypeCategory added in v1.15.0 

type SlotTypeCategory string
const (
	SlotTypeCategoryCustom          SlotTypeCategory = "Custom"
	SlotTypeCategoryExtended        SlotTypeCategory = "Extended"
	SlotTypeCategoryExternalGrammar SlotTypeCategory = "ExternalGrammar"
	SlotTypeCategoryComposite       SlotTypeCategory = "Composite"
)

Enum values for SlotTypeCategory

func (SlotTypeCategory) Values added in v1.15.0 

func (SlotTypeCategory) Values() []SlotTypeCategory

Values returns all known values for SlotTypeCategory. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotTypeFilter 

type SlotTypeFilter struct {

	// The name of the field to use for filtering.
	//
	// This member is required.
	Name SlotTypeFilterName

	// 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.
	//
	// This member is required.
	Operator SlotTypeFilterOperator

	// The value to use to filter the response.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Filters the response from the ListSlotTypes operation.

type SlotTypeFilterName 

type SlotTypeFilterName string
const (
	SlotTypeFilterNameSlotTypeName       SlotTypeFilterName = "SlotTypeName"
	SlotTypeFilterNameExternalSourceType SlotTypeFilterName = "ExternalSourceType"
)

Enum values for SlotTypeFilterName

func (SlotTypeFilterName) Values 

func (SlotTypeFilterName) Values() []SlotTypeFilterName

Values returns all known values for SlotTypeFilterName. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotTypeFilterOperator 

type SlotTypeFilterOperator string
const (
	SlotTypeFilterOperatorContains SlotTypeFilterOperator = "CO"
	SlotTypeFilterOperatorEquals   SlotTypeFilterOperator = "EQ"
)

Enum values for SlotTypeFilterOperator

func (SlotTypeFilterOperator) Values 

func (SlotTypeFilterOperator) Values() []SlotTypeFilterOperator

Values returns all known values for SlotTypeFilterOperator. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotTypeSortAttribute 

type SlotTypeSortAttribute string
const (
	SlotTypeSortAttributeSlotTypeName        SlotTypeSortAttribute = "SlotTypeName"
	SlotTypeSortAttributeLastUpdatedDateTime SlotTypeSortAttribute = "LastUpdatedDateTime"
)

Enum values for SlotTypeSortAttribute

func (SlotTypeSortAttribute) Values 

func (SlotTypeSortAttribute) Values() []SlotTypeSortAttribute

Values returns all known values for SlotTypeSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotTypeSortBy 

type SlotTypeSortBy struct {

	// The attribute to use to sort the list of slot types.
	//
	// This member is required.
	Attribute SlotTypeSortAttribute

	// The order to sort the list. You can say ascending or descending.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Specifies attributes for sorting a list of slot types.

type SlotTypeStatistics added in v1.14.0 

type SlotTypeStatistics struct {

	// The number of recommended slot types associated with the bot recommendation.
	DiscoveredSlotTypeCount *int32
	// contains filtered or unexported fields
}

The object that contains the statistical summary of the recommended slot type associated with the bot recommendation.

type SlotTypeSummary 

type SlotTypeSummary struct {

	// The description of the slot type.
	Description *string

	// A timestamp of the date and time that the slot type was last updated.
	LastUpdatedDateTime *time.Time

	// If the slot type is derived from a built-on slot type, the name of the parent
	// slot type.
	ParentSlotTypeSignature *string

	// 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 (https://docs.aws.amazon.com/lexv2/latest/dg/custom-slot-types.html)
	//   .
	//   - Extended - A slot type created by extending the AMAZON.AlphaNumeric built-in
	//   slot type. For more information, see AMAZON.AlphaNumeric (https://docs.aws.amazon.com/lexv2/latest/dg/built-in-slot-alphanumerice.html)
	//   .
	//   - ExternalGrammar - A slot type using a custom GRXML grammar to define values.
	//   For more information, see Using a custom grammar slot type (https://docs.aws.amazon.com/lexv2/latest/dg/building-grxml.html)
	//   .
	SlotTypeCategory SlotTypeCategory

	// The unique identifier assigned to the slot type.
	SlotTypeId *string

	// The name of the slot type.
	SlotTypeName *string
	// contains filtered or unexported fields
}

Provides summary information about a slot type.

type SlotTypeValue 

type SlotTypeValue struct {

	// The value of the slot type entry.
	SampleValue *SampleValue

	// Additional values related to the slot type entry.
	Synonyms []SampleValue
	// contains filtered or unexported fields
}

Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.

type SlotValue added in v1.22.0 

type SlotValue struct {

	// 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.
	InterpretedValue *string
	// contains filtered or unexported fields
}

The value to set in a slot.

type SlotValueElicitationSetting 

type SlotValueElicitationSetting struct {

	// Specifies whether the slot is required or optional.
	//
	// This member is required.
	SlotConstraint SlotConstraint

	// 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.
	DefaultValueSpecification *SlotDefaultValueSpecification

	// The prompt that Amazon Lex uses to elicit the slot value from the user.
	PromptSpecification *PromptSpecification

	// 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.
	SampleUtterances []SampleUtterance

	// Specifies the settings that Amazon Lex uses when a slot value is successfully
	// entered by a user.
	SlotCaptureSetting *SlotCaptureSetting

	// An object containing information about whether assisted slot resolution is
	// turned on for the slot or not.
	SlotResolutionSetting *SlotResolutionSetting

	// Specifies the prompts that Amazon Lex uses while a bot is waiting for customer
	// input.
	WaitAndContinueSpecification *WaitAndContinueSpecification
	// contains filtered or unexported fields
}

Specifies the elicitation setting details eliciting a slot.

type SlotValueOverride added in v1.22.0 

type SlotValueOverride struct {

	// 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.
	Shape SlotShape

	// The current value of the slot.
	Value *SlotValue

	// 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."
	Values []SlotValueOverride
	// contains filtered or unexported fields
}

The slot values that Amazon Lex uses when it sets slot values in a dialog step.

type SlotValueRegexFilter 

type SlotValueRegexFilter struct {

	// 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")
	// 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 (.)
	//
	// This member is required.
	Pattern *string
	// contains filtered or unexported fields
}

Provides a regular expression used to validate the value of a slot.

type SlotValueResolutionStrategy 

type SlotValueResolutionStrategy string
const (
	SlotValueResolutionStrategyOriginalValue SlotValueResolutionStrategy = "OriginalValue"
	SlotValueResolutionStrategyTopResolution SlotValueResolutionStrategy = "TopResolution"
	SlotValueResolutionStrategyConcatenation SlotValueResolutionStrategy = "Concatenation"
)

Enum values for SlotValueResolutionStrategy

func (SlotValueResolutionStrategy) Values 

func (SlotValueResolutionStrategy) Values() []SlotValueResolutionStrategy

Values returns all known values for SlotValueResolutionStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SlotValueSelectionSetting 

type SlotValueSelectionSetting struct {

	// 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 .
	//
	// This member is required.
	ResolutionStrategy SlotValueResolutionStrategy

	// 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.
	AdvancedRecognitionSetting *AdvancedRecognitionSetting

	// A regular expression used to validate the value of a slot.
	RegexFilter *SlotValueRegexFilter
	// contains filtered or unexported fields
}

Contains settings used by Amazon Lex to select a slot value.

type SortOrder 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "Ascending"
	SortOrderDescending SortOrder = "Descending"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Specifications added in v1.24.0 

type Specifications struct {

	// The unique identifier assigned to the slot type.
	//
	// This member is required.
	SlotTypeId *string

	// Specifies the elicitation setting details for constituent sub slots of a
	// composite slot.
	//
	// This member is required.
	ValueElicitationSetting *SubSlotValueElicitationSetting
	// contains filtered or unexported fields
}

Subslot specifications.

type StillWaitingResponseSpecification 

type StillWaitingResponseSpecification struct {

	// How often a message should be sent to the user. Minimum of 1 second, maximum of
	// 5 minutes.
	//
	// This member is required.
	FrequencyInSeconds *int32

	// One or more message groups, each containing one or more messages, that define
	// the prompts that Amazon Lex sends to the user.
	//
	// This member is required.
	MessageGroups []MessageGroup

	// If Amazon Lex waits longer than this length of time for a response, it will
	// stop sending messages.
	//
	// This member is required.
	TimeoutInSeconds *int32

	// Indicates that the user can interrupt the response by speaking while the
	// message is being played.
	AllowInterrupt *bool
	// contains filtered or unexported fields
}

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

type SubSlotSetting added in v1.24.0 

type SubSlotSetting struct {

	// The expression text for defining the constituent sub slots in the composite
	// slot using logical AND and OR operators.
	Expression *string

	// Specifications for the constituent sub slots of a composite slot.
	SlotSpecifications map[string]Specifications
	// contains filtered or unexported fields
}

Specifications for the constituent sub slots and the expression for the composite slot.

type SubSlotTypeComposition added in v1.24.0 

type SubSlotTypeComposition struct {

	// Name of a constituent sub slot inside a composite slot.
	//
	// This member is required.
	Name *string

	// 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.
	//
	// This member is required.
	SlotTypeId *string
	// contains filtered or unexported fields
}

Subslot type composition.

type SubSlotValueElicitationSetting added in v1.24.0 

type SubSlotValueElicitationSetting struct {

	// Specifies a list of message groups that Amazon Lex sends to a user to elicit a
	// response.
	//
	// This member is required.
	PromptSpecification *PromptSpecification

	// Defines a list of values that Amazon Lex should use as the default value for a
	// slot.
	DefaultValueSpecification *SlotDefaultValueSpecification

	// 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.
	SampleUtterances []SampleUtterance

	// Specifies the prompts that Amazon Lex uses while a bot is waiting for customer
	// input.
	WaitAndContinueSpecification *WaitAndContinueSpecification
	// contains filtered or unexported fields
}

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.

type TestExecutionApiMode added in v1.29.0 

type TestExecutionApiMode string
const (
	TestExecutionApiModeStreaming    TestExecutionApiMode = "Streaming"
	TestExecutionApiModeNonStreaming TestExecutionApiMode = "NonStreaming"
)

Enum values for TestExecutionApiMode

func (TestExecutionApiMode) Values added in v1.29.0 

func (TestExecutionApiMode) Values() []TestExecutionApiMode

Values returns all known values for TestExecutionApiMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestExecutionModality added in v1.29.0 

type TestExecutionModality string
const (
	TestExecutionModalityText  TestExecutionModality = "Text"
	TestExecutionModalityAudio TestExecutionModality = "Audio"
)

Enum values for TestExecutionModality

func (TestExecutionModality) Values added in v1.29.0 

func (TestExecutionModality) Values() []TestExecutionModality

Values returns all known values for TestExecutionModality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestExecutionResultFilterBy added in v1.29.0 

type TestExecutionResultFilterBy struct {

	// Specifies which results to filter. See Test result details">Test results details (https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html)
	// for details about different types of results.
	//
	// This member is required.
	ResultTypeFilter TestResultTypeFilter

	// Contains information about the method for filtering Conversation level test
	// results.
	ConversationLevelTestResultsFilterBy *ConversationLevelTestResultsFilterBy
	// contains filtered or unexported fields
}

Contains information about the method by which to filter the results of the test execution.

type TestExecutionResultItems added in v1.29.0 

type TestExecutionResultItems struct {

	// Results related to conversations in the test set, including metrics about
	// success and failure of conversations and intent and slot failures.
	ConversationLevelTestResults *ConversationLevelTestResults

	// 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.
	IntentClassificationTestResults *IntentClassificationTestResults

	// 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
	IntentLevelSlotResolutionTestResults *IntentLevelSlotResolutionTestResults

	// Overall results for the test execution, including the breakdown of
	// conversations and single-input utterances.
	OverallTestResults *OverallTestResults

	// Results related to utterances in the test set.
	UtteranceLevelTestResults *UtteranceLevelTestResults
	// contains filtered or unexported fields
}

Contains the results of the test execution, grouped by type of results. See Test result details">Test results details (https://docs.aws.amazon.com/lexv2/latest/dg/test-results-details-test-set.html) for details about different types of results.

type TestExecutionSortAttribute added in v1.29.0 

type TestExecutionSortAttribute string
const (
	TestExecutionSortAttributeTestSetName      TestExecutionSortAttribute = "TestSetName"
	TestExecutionSortAttributeCreationDateTime TestExecutionSortAttribute = "CreationDateTime"
)

Enum values for TestExecutionSortAttribute

func (TestExecutionSortAttribute) Values added in v1.29.0 

func (TestExecutionSortAttribute) Values() []TestExecutionSortAttribute

Values returns all known values for TestExecutionSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestExecutionSortBy added in v1.29.0 

type TestExecutionSortBy struct {

	// Specifies whether to sort the test set executions by the date and time at which
	// the test sets were created.
	//
	// This member is required.
	Attribute TestExecutionSortAttribute

	// Specifies whether to sort in ascending or descending order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Contains information about the method by which to sort the instances of test executions you have carried out.

type TestExecutionStatus added in v1.29.0 

type TestExecutionStatus string
const (
	TestExecutionStatusPending    TestExecutionStatus = "Pending"
	TestExecutionStatusWaiting    TestExecutionStatus = "Waiting"
	TestExecutionStatusInProgress TestExecutionStatus = "InProgress"
	TestExecutionStatusCompleted  TestExecutionStatus = "Completed"
	TestExecutionStatusFailed     TestExecutionStatus = "Failed"
	TestExecutionStatusStopping   TestExecutionStatus = "Stopping"
	TestExecutionStatusStopped    TestExecutionStatus = "Stopped"
)

Enum values for TestExecutionStatus

func (TestExecutionStatus) Values added in v1.29.0 

func (TestExecutionStatus) Values() []TestExecutionStatus

Values returns all known values for TestExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestExecutionSummary added in v1.29.0 

type TestExecutionSummary struct {

	// Specifies whether the API mode for the test execution is streaming or
	// non-streaming.
	ApiMode TestExecutionApiMode

	// The date and time at which the test execution was created.
	CreationDateTime *time.Time

	// The date and time at which the test execution was last updated.
	LastUpdatedDateTime *time.Time

	// Contains information about the bot used for the test execution..
	Target *TestExecutionTarget

	// The unique identifier of the test execution.
	TestExecutionId *string

	// Specifies whether the data used for the test execution is written or spoken.
	TestExecutionModality TestExecutionModality

	// The current status of the test execution.
	TestExecutionStatus TestExecutionStatus

	// The unique identifier of the test set used in the test execution.
	TestSetId *string

	// The name of the test set used in the test execution.
	TestSetName *string
	// contains filtered or unexported fields
}

Summarizes metadata about the test execution.

type TestExecutionTarget added in v1.29.0 

type TestExecutionTarget struct {

	// Contains information about the bot alias used for the test execution.
	BotAliasTarget *BotAliasTestExecutionTarget
	// contains filtered or unexported fields
}

Contains information about the bot used for the test execution.

type TestResultMatchStatus added in v1.29.0 

type TestResultMatchStatus string
const (
	TestResultMatchStatusMatched        TestResultMatchStatus = "Matched"
	TestResultMatchStatusMismatched     TestResultMatchStatus = "Mismatched"
	TestResultMatchStatusExecutionError TestResultMatchStatus = "ExecutionError"
)

Enum values for TestResultMatchStatus

func (TestResultMatchStatus) Values added in v1.29.0 

func (TestResultMatchStatus) Values() []TestResultMatchStatus

Values returns all known values for TestResultMatchStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestResultTypeFilter added in v1.29.0 

type TestResultTypeFilter string
const (
	TestResultTypeFilterOverallTestResults              TestResultTypeFilter = "OverallTestResults"
	TestResultTypeFilterConversationLevelTestResults    TestResultTypeFilter = "ConversationLevelTestResults"
	TestResultTypeFilterIntentClassificationTestResults TestResultTypeFilter = "IntentClassificationTestResults"
	TestResultTypeFilterSlotResolutionTestResults       TestResultTypeFilter = "SlotResolutionTestResults"
	TestResultTypeFilterUtteranceLevelResults           TestResultTypeFilter = "UtteranceLevelResults"
)

Enum values for TestResultTypeFilter

func (TestResultTypeFilter) Values added in v1.29.0 

func (TestResultTypeFilter) Values() []TestResultTypeFilter

Values returns all known values for TestResultTypeFilter. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetDiscrepancyErrors added in v1.29.0 

type TestSetDiscrepancyErrors struct {

	// Contains information about discrepancies found for intents between the test set
	// and the bot.
	//
	// This member is required.
	IntentDiscrepancies []TestSetIntentDiscrepancyItem

	// Contains information about discrepancies found for slots between the test set
	// and the bot.
	//
	// This member is required.
	SlotDiscrepancies []TestSetSlotDiscrepancyItem
	// contains filtered or unexported fields
}

Contains details about the errors in the test set discrepancy report

type TestSetDiscrepancyReportBotAliasTarget added in v1.29.0 

type TestSetDiscrepancyReportBotAliasTarget struct {

	// The unique identifier for the bot associated with the bot alias.
	//
	// This member is required.
	BotAliasId *string

	// The unique identifier for the bot alias.
	//
	// This member is required.
	BotId *string

	// The unique identifier of the locale associated with the bot alias.
	//
	// This member is required.
	LocaleId *string
	// contains filtered or unexported fields
}

Contains information about the bot alias used for the test set discrepancy report.

type TestSetDiscrepancyReportResourceTarget added in v1.29.0 

type TestSetDiscrepancyReportResourceTarget struct {

	// Contains information about the bot alias used as the resource for the test set
	// discrepancy report.
	BotAliasTarget *TestSetDiscrepancyReportBotAliasTarget
	// contains filtered or unexported fields
}

Contains information about the resource used for the test set discrepancy report.

type TestSetDiscrepancyReportStatus added in v1.29.0 

type TestSetDiscrepancyReportStatus string
const (
	TestSetDiscrepancyReportStatusInProgress TestSetDiscrepancyReportStatus = "InProgress"
	TestSetDiscrepancyReportStatusCompleted  TestSetDiscrepancyReportStatus = "Completed"
	TestSetDiscrepancyReportStatusFailed     TestSetDiscrepancyReportStatus = "Failed"
)

Enum values for TestSetDiscrepancyReportStatus

func (TestSetDiscrepancyReportStatus) Values added in v1.29.0 

func (TestSetDiscrepancyReportStatus) Values() []TestSetDiscrepancyReportStatus

Values returns all known values for TestSetDiscrepancyReportStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetExportSpecification added in v1.29.0 

type TestSetExportSpecification struct {

	// The unique identifier of the test set.
	//
	// This member is required.
	TestSetId *string
	// contains filtered or unexported fields
}

Contains information about the test set that is exported.

type TestSetGenerationDataSource added in v1.29.0 

type TestSetGenerationDataSource struct {

	// Contains information about the bot from which the conversation logs are sourced.
	ConversationLogsDataSource *ConversationLogsDataSource
	// contains filtered or unexported fields
}

Contains information about the data source from which the test set is generated.

type TestSetGenerationStatus added in v1.29.0 

type TestSetGenerationStatus string
const (
	TestSetGenerationStatusGenerating TestSetGenerationStatus = "Generating"
	TestSetGenerationStatusReady      TestSetGenerationStatus = "Ready"
	TestSetGenerationStatusFailed     TestSetGenerationStatus = "Failed"
	TestSetGenerationStatusPending    TestSetGenerationStatus = "Pending"
)

Enum values for TestSetGenerationStatus

func (TestSetGenerationStatus) Values added in v1.29.0 

func (TestSetGenerationStatus) Values() []TestSetGenerationStatus

Values returns all known values for TestSetGenerationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetImportInputLocation added in v1.29.0 

type TestSetImportInputLocation struct {

	// The name of the Amazon S3 bucket.
	//
	// This member is required.
	S3BucketName *string

	// The path inside the Amazon S3 bucket pointing to the test-set CSV file.
	//
	// This member is required.
	S3Path *string
	// contains filtered or unexported fields
}

Contains information about the Amazon S3 location from which the test set is imported.

type TestSetImportResourceSpecification added in v1.29.0 

type TestSetImportResourceSpecification struct {

	// Contains information about the input location from where test-set should be
	// imported.
	//
	// This member is required.
	ImportInputLocation *TestSetImportInputLocation

	// Specifies whether the test-set being imported contains written or spoken data.
	//
	// This member is required.
	Modality TestSetModality

	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
	// test set.
	//
	// This member is required.
	RoleArn *string

	// Contains information about the location that Amazon Lex uses to store the
	// test-set.
	//
	// This member is required.
	StorageLocation *TestSetStorageLocation

	// The name of the test set.
	//
	// This member is required.
	TestSetName *string

	// The description of the test set.
	Description *string

	// 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.
	TestSetTags map[string]string
	// contains filtered or unexported fields
}

Contains information about the test set that is imported.

type TestSetIntentDiscrepancyItem added in v1.29.0 

type TestSetIntentDiscrepancyItem struct {

	// The error message for a discrepancy for an intent between the test set and the
	// bot.
	//
	// This member is required.
	ErrorMessage *string

	// The name of the intent in the discrepancy report.
	//
	// This member is required.
	IntentName *string
	// contains filtered or unexported fields
}

Contains information about discrepancy in an intent information between the test set and the bot.

type TestSetModality added in v1.29.0 

type TestSetModality string
const (
	TestSetModalityText  TestSetModality = "Text"
	TestSetModalityAudio TestSetModality = "Audio"
)

Enum values for TestSetModality

func (TestSetModality) Values added in v1.29.0 

func (TestSetModality) Values() []TestSetModality

Values returns all known values for TestSetModality. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetSlotDiscrepancyItem added in v1.29.0 

type TestSetSlotDiscrepancyItem struct {

	// The error message for a discrepancy for an intent between the test set and the
	// bot.
	//
	// This member is required.
	ErrorMessage *string

	// The name of the intent associated with the slot in the discrepancy report.
	//
	// This member is required.
	IntentName *string

	// The name of the slot in the discrepancy report.
	//
	// This member is required.
	SlotName *string
	// contains filtered or unexported fields
}

Contains information about discrepancy in a slot information between the test set and the bot.

type TestSetSortAttribute added in v1.29.0 

type TestSetSortAttribute string
const (
	TestSetSortAttributeTestSetName         TestSetSortAttribute = "TestSetName"
	TestSetSortAttributeLastUpdatedDateTime TestSetSortAttribute = "LastUpdatedDateTime"
)

Enum values for TestSetSortAttribute

func (TestSetSortAttribute) Values added in v1.29.0 

func (TestSetSortAttribute) Values() []TestSetSortAttribute

Values returns all known values for TestSetSortAttribute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetSortBy added in v1.29.0 

type TestSetSortBy struct {

	// Specifies whether to sort the test sets by name or by the time they were last
	// updated.
	//
	// This member is required.
	Attribute TestSetSortAttribute

	// Specifies whether to sort in ascending or descending order.
	//
	// This member is required.
	Order SortOrder
	// contains filtered or unexported fields
}

Contains information about the methods by which to sort the test set.

type TestSetStatus added in v1.29.0 

type TestSetStatus string
const (
	TestSetStatusImporting         TestSetStatus = "Importing"
	TestSetStatusPendingAnnotation TestSetStatus = "PendingAnnotation"
	TestSetStatusDeleting          TestSetStatus = "Deleting"
	TestSetStatusValidationError   TestSetStatus = "ValidationError"
	TestSetStatusReady             TestSetStatus = "Ready"
)

Enum values for TestSetStatus

func (TestSetStatus) Values added in v1.29.0 

func (TestSetStatus) Values() []TestSetStatus

Values returns all known values for TestSetStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestSetStorageLocation added in v1.29.0 

type TestSetStorageLocation struct {

	// The name of the Amazon S3 bucket in which the test set is stored.
	//
	// This member is required.
	S3BucketName *string

	// The path inside the Amazon S3 bucket where the test set is stored.
	//
	// This member is required.
	S3Path *string

	// The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service
	// (KMS) key for encrypting the test set.
	KmsKeyArn *string
	// contains filtered or unexported fields
}

Contains information about the location in which the test set is stored.

type TestSetSummary added in v1.29.0 

type TestSetSummary struct {

	// The date and time at which the test set was created.
	CreationDateTime *time.Time

	// The description of the test set.
	Description *string

	// The date and time at which the test set was last updated.
	LastUpdatedDateTime *time.Time

	// Specifies whether the test set contains written or spoken data.
	Modality TestSetModality

	// The number of turns in the test set.
	NumTurns *int32

	// The Amazon Resource Name (ARN) of an IAM role that has permission to access the
	// test set.
	RoleArn *string

	// The status of the test set.
	Status TestSetStatus

	// Contains information about the location at which the test set is stored.
	StorageLocation *TestSetStorageLocation

	// The unique identifier of the test set.
	TestSetId *string

	// The name of the test set.
	TestSetName *string
	// contains filtered or unexported fields
}

Contains summary information about the test set.

type TestSetTurnRecord added in v1.29.0 

type TestSetTurnRecord struct {

	// The record number associated with the turn.
	//
	// This member is required.
	RecordNumber *int64

	// Contains information about the agent or user turn depending upon type of turn.
	//
	// This member is required.
	TurnSpecification *TurnSpecification

	// The unique identifier for the conversation associated with the turn.
	ConversationId *string

	// The number of turns that has elapsed up to that turn.
	TurnNumber *int32
	// contains filtered or unexported fields
}

Contains information about a turn in a test set.

type TestSetTurnResult added in v1.29.0 

type TestSetTurnResult struct {

	// Contains information about the agent messages in the turn.
	Agent *AgentTurnResult

	// Contains information about the user messages in the turn.
	User *UserTurnResult
	// contains filtered or unexported fields
}

Contains information about the results of the analysis of a turn in the test set.

type TextInputSpecification added in v1.25.0 

type TextInputSpecification struct {

	// Time for which a bot waits before re-prompting a customer for text input.
	//
	// This member is required.
	StartTimeoutMs *int32
	// contains filtered or unexported fields
}

Specifies the text input specifications.

type TextLogDestination 

type TextLogDestination struct {

	// Defines the Amazon CloudWatch Logs log group where text and metadata logs are
	// delivered.
	//
	// This member is required.
	CloudWatch *CloudWatchLogGroupLogDestination
	// contains filtered or unexported fields
}

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

type TextLogSetting 

type TextLogSetting struct {

	// Defines the Amazon CloudWatch Logs destination log group for conversation text
	// logs.
	//
	// This member is required.
	Destination *TextLogDestination

	// Determines whether conversation logs should be stored for an alias.
	//
	// This member is required.
	Enabled bool

	// The option to enable selective conversation log capture for text.
	SelectiveLoggingEnabled *bool
	// contains filtered or unexported fields
}

Defines settings to enable text conversation logs.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

Your request rate is too high. Reduce the frequency of requests.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimeDimension added in v1.8.0 

type TimeDimension string
const (
	TimeDimensionHours TimeDimension = "Hours"
	TimeDimensionDays  TimeDimension = "Days"
	TimeDimensionWeeks TimeDimension = "Weeks"
)

Enum values for TimeDimension

func (TimeDimension) Values added in v1.8.0 

func (TimeDimension) Values() []TimeDimension

Values returns all known values for TimeDimension. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TranscriptFilter added in v1.14.0 

type TranscriptFilter struct {

	// The object representing the filter that Amazon Lex will use to select the
	// appropriate transcript when the transcript format is the Amazon Lex format.
	LexTranscriptFilter *LexTranscriptFilter
	// contains filtered or unexported fields
}

The object representing the filter that Amazon Lex will use to select the appropriate transcript.

type TranscriptFormat added in v1.14.0 

type TranscriptFormat string
const (
	TranscriptFormatLex TranscriptFormat = "Lex"
)

Enum values for TranscriptFormat

func (TranscriptFormat) Values added in v1.14.0 

func (TranscriptFormat) Values() []TranscriptFormat

Values returns all known values for TranscriptFormat. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TranscriptSourceSetting added in v1.14.0 

type TranscriptSourceSetting struct {

	// Indicates the setting of the Amazon S3 bucket where the transcript is stored.
	S3BucketTranscriptSource *S3BucketTranscriptSource
	// contains filtered or unexported fields
}

Indicates the setting of the location where the transcript is stored.

type TurnSpecification added in v1.29.0 

type TurnSpecification struct {

	// Contains information about the agent messages in the turn.
	AgentTurn *AgentTurnSpecification

	// Contains information about the user messages in the turn.
	UserTurn *UserTurnSpecification
	// contains filtered or unexported fields
}

Contains information about the messages in the turn.

type UserTurnInputSpecification added in v1.29.0 

type UserTurnInputSpecification struct {

	// The utterance input in the user turn.
	//
	// This member is required.
	UtteranceInput *UtteranceInputSpecification

	// Request attributes of the user turn.
	RequestAttributes map[string]string

	// Contains information about the session state in the input.
	SessionState *InputSessionStateSpecification
	// contains filtered or unexported fields
}

Contains information about the user messages in the turn in the input.

type UserTurnIntentOutput added in v1.29.0 

type UserTurnIntentOutput struct {

	// The name of the intent.
	//
	// This member is required.
	Name *string

	// The slots associated with the intent.
	Slots map[string]UserTurnSlotOutput
	// contains filtered or unexported fields
}

Contains information about the intent that is output for the turn by the test execution.

type UserTurnOutputSpecification added in v1.29.0 

type UserTurnOutputSpecification struct {

	// Contains information about the intent.
	//
	// This member is required.
	Intent *UserTurnIntentOutput

	// The contexts that are active in the turn.
	ActiveContexts []ActiveContext

	// The transcript that is output for the user turn by the test execution.
	Transcript *string
	// contains filtered or unexported fields
}

Contains results that are output for the user turn by the test execution.

type UserTurnResult added in v1.29.0 

type UserTurnResult struct {

	// Contains information about the expected output for the user turn.
	//
	// This member is required.
	ExpectedOutput *UserTurnOutputSpecification

	// Contains information about the user messages in the turn in the input.
	//
	// This member is required.
	Input *UserTurnInputSpecification

	// Contains information about the actual output for the user turn.
	ActualOutput *UserTurnOutputSpecification

	// Contains information about the results related to the conversation associated
	// with the user turn.
	ConversationLevelResult *ConversationLevelResultDetail

	// Specifies whether the expected and actual outputs match or not, or if there is
	// an error in execution.
	EndToEndResult TestResultMatchStatus

	// Details about an error in an execution of a test set.
	ErrorDetails *ExecutionErrorDetails

	// Specifies whether the expected and actual intents match or not.
	IntentMatchResult TestResultMatchStatus

	// Specifies whether the expected and actual slots match or not.
	SlotMatchResult TestResultMatchStatus

	// Specifies whether the expected and actual speech transcriptions match or not,
	// or if there is an error in execution.
	SpeechTranscriptionResult TestResultMatchStatus
	// contains filtered or unexported fields
}

Contains the results for the user turn by the test execution.

type UserTurnSlotOutput added in v1.29.0 

type UserTurnSlotOutput struct {

	// A list of items mapping the name of the subslots to information about those
	// subslots.
	SubSlots map[string]UserTurnSlotOutput

	// The value output by the slot recognition.
	Value *string

	// Values that are output by the slot recognition.
	Values []UserTurnSlotOutput
	// contains filtered or unexported fields
}

Contains information about a slot output by the test set execution.

type UserTurnSpecification added in v1.29.0 

type UserTurnSpecification struct {

	// Contains results about the expected output for the user turn.
	//
	// This member is required.
	Expected *UserTurnOutputSpecification

	// Contains information about the user messages in the turn in the input.
	//
	// This member is required.
	Input *UserTurnInputSpecification
	// contains filtered or unexported fields
}

Contains information about the expected and input values for the user turn.

type UtteranceAggregationDuration added in v1.8.0 

type UtteranceAggregationDuration struct {

	// The desired time window for aggregating utterances.
	//
	// This member is required.
	RelativeAggregationDuration *RelativeAggregationDuration
	// contains filtered or unexported fields
}

Provides parameters for setting the time window and duration for aggregating utterance data.

type UtteranceAudioInputSpecification added in v1.29.0 

type UtteranceAudioInputSpecification struct {

	// Amazon S3 file pointing to the audio.
	//
	// This member is required.
	AudioFileS3Location *string
	// contains filtered or unexported fields
}

Contains information about the audio for an utterance.

type UtteranceBotResponse added in v1.30.0 

type UtteranceBotResponse struct {

	// The text of the response to the utterance from the bot.
	Content *string

	// 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 (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_ImageResponseCard.html)
	//   for more information.
	ContentType UtteranceContentType

	// 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.
	ImageResponseCard *ImageResponseCard
	// contains filtered or unexported fields
}

An object that contains a response to the utterance from the bot.

type UtteranceContentType added in v1.30.0 

type UtteranceContentType string
const (
	UtteranceContentTypePlainText         UtteranceContentType = "PlainText"
	UtteranceContentTypeCustomPayload     UtteranceContentType = "CustomPayload"
	UtteranceContentTypeSsml              UtteranceContentType = "SSML"
	UtteranceContentTypeImageResponseCard UtteranceContentType = "ImageResponseCard"
)

Enum values for UtteranceContentType

func (UtteranceContentType) Values added in v1.30.0 

func (UtteranceContentType) Values() []UtteranceContentType

Values returns all known values for UtteranceContentType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type UtteranceDataSortBy added in v1.30.0 

type UtteranceDataSortBy struct {

	// The measure by which to sort the utterance analytics data.
	//   - Count – The number of utterances.
	//   - UtteranceTimestamp – The date and time of the utterance.
	//
	// This member is required.
	Name AnalyticsUtteranceSortByName

	// Specifies whether to sort the results in ascending or descending order.
	//
	// This member is required.
	Order AnalyticsSortOrder
	// contains filtered or unexported fields
}

An object specifying the measure and method by which to sort the utterance data.

type UtteranceInputSpecification added in v1.29.0 

type UtteranceInputSpecification struct {

	// Contains information about the audio input for an utterance.
	AudioInput *UtteranceAudioInputSpecification

	// A text input transcription of the utterance. It is only applicable for
	// test-sets containing text data.
	TextInput *string
	// contains filtered or unexported fields
}

Contains information about input of an utterance.

type UtteranceLevelTestResultItem added in v1.29.0 

type UtteranceLevelTestResultItem struct {

	// The record number of the result.
	//
	// This member is required.
	RecordNumber *int64

	// Contains information about the turn associated with the result.
	//
	// This member is required.
	TurnResult *TestSetTurnResult

	// The unique identifier for the conversation associated with the result.
	ConversationId *string
	// contains filtered or unexported fields
}

Contains information about multiple utterances in the results of a test set execution.

type UtteranceLevelTestResults added in v1.29.0 

type UtteranceLevelTestResults struct {

	// Contains information about an utterance in the results of the test set
	// execution.
	//
	// This member is required.
	Items []UtteranceLevelTestResultItem
	// contains filtered or unexported fields
}

Contains information about the utterances in the results of the test set execution.

type UtteranceSpecification added in v1.30.0 

type UtteranceSpecification struct {

	// The name of the intent that the utterance is associated to.
	AssociatedIntentName *string

	// The name of the slot that the utterance is associated to.
	AssociatedSlotName *string

	// The duration in milliseconds of the audio associated with the utterance.
	AudioVoiceDurationMillis *int64

	// The identifier of the alias of the bot that the utterance was made to.
	BotAliasId *string

	// The identifier for the audio of the bot response.
	BotResponseAudioVoiceId *string

	// A list of objects containing information about the bot response to the
	// utterance.
	BotResponses []UtteranceBotResponse

	// The version of the bot that the utterance was made to.
	BotVersion *string

	// The channel that is integrated with the bot that the utterance was made to.
	Channel *string

	// 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 .
	ConversationEndTime *time.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 .
	ConversationStartTime *time.Time

	// The type of dialog action that the utterance is associated to. See the type
	// field in DialogAction (https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_DialogAction.html)
	// for more information.
	DialogActionType *string

	// 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
	InputType *string

	// The state of the intent that the utterance is associated to.
	IntentState IntentState

	// The locale of the bot that the utterance was made to.
	LocaleId *string

	// 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.
	Mode AnalyticsModality

	// 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
	OutputType *string

	// The identifier of the session that the utterance was made in.
	SessionId *string

	// The slots that have been filled in the session by the time of the utterance.
	SlotsFilledInSession *string

	// The text of the utterance.
	Utterance *string

	// The identifier of the request associated with the utterance.
	UtteranceRequestId *string

	// The date and time when the utterance took place.
	UtteranceTimestamp *time.Time

	// Specifies whether the bot understood the utterance or not.
	UtteranceUnderstood bool
	// contains filtered or unexported fields
}

An object containing information about a specific utterance.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type VoiceEngine added in v1.13.0 

type VoiceEngine string
const (
	VoiceEngineStandard VoiceEngine = "standard"
	VoiceEngineNeural   VoiceEngine = "neural"
)

Enum values for VoiceEngine

func (VoiceEngine) Values added in v1.13.0 

func (VoiceEngine) Values() []VoiceEngine

Values returns all known values for VoiceEngine. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type VoiceSettings 

type VoiceSettings struct {

	// The identifier of the Amazon Polly voice to use.
	//
	// This member is required.
	VoiceId *string

	// 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 (https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine)
	// in the Amazon Polly developer guide. If you do not specify a value, the default
	// is standard .
	Engine VoiceEngine
	// contains filtered or unexported fields
}

Defines settings for using an Amazon Polly voice to communicate with a user.

type WaitAndContinueSpecification 

type WaitAndContinueSpecification struct {

	// The response that Amazon Lex sends to indicate that the bot is ready to
	// continue the conversation.
	//
	// This member is required.
	ContinueResponse *ResponseSpecification

	// The response that Amazon Lex sends to indicate that the bot is waiting for the
	// conversation to continue.
	//
	// This member is required.
	WaitingResponse *ResponseSpecification

	// 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.
	Active *bool

	// A response that Amazon Lex sends periodically to the user to indicate that the
	// bot is still waiting for input from the user.
	StillWaitingResponse *StillWaitingResponseSpecification
	// contains filtered or unexported fields
}

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.