Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Lex Runtime V2 can respond with.

Structs

ActiveContext

Contains information about the contexts that a user is using in a session. You can configure Amazon Lex V2 to set a context when an intent is fulfilled, or you can set a context using the , , or operations.

Use a context to indicate to Amazon Lex V2 intents that should be used as follow-up intents. For example, if the active context is order-fulfilled, only intents that have order-fulfilled configured as a trigger are considered for follow up.

ActiveContextTimeToLive

The time that a context is active. You can specify the time to live in seconds or in conversation turns.

AudioInputEvent

Represents a chunk of audio sent from the client application to Amazon Lex V2. The audio is all or part of an utterance from the user.

Amazon Lex V2 accumulates audio chunks until it recognizes a natural pause in speech before processing the input.

AudioResponseEvent

An event sent from Amazon Lex V2 to your client application containing audio to play to the user.

Button

A button that appears on a response card show to the user.

ConfidenceScore

Provides a score that indicates the confidence that Amazon Lex V2 has that an intent is the one that satisfies the user's intent.

ConfigurationEvent

The initial event sent from the application to Amazon Lex V2 to configure the conversation, including session and request attributes and the response content type.

DialogAction

The next action that Amazon Lex V2 should take.

DisconnectionEvent

A notification from the client that it is disconnecting from Amazon Lex V2. Sending a DisconnectionEvent event is optional, but can help identify a conversation in logs.

DtmfInputEvent

A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex V2 process a credit card number input from a phone.

ElicitSubSlot

The specific constituent sub slot of the composite slot to elicit in dialog action.

HeartbeatEvent

Event that Amazon Lex V2 sends to indicate that the stream is still open between the client application and Amazon Lex V2

ImageResponseCard

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.

Intent

The current intent that Amazon Lex V2 is attempting to fulfill.

IntentResultEvent

Contains the current state of the conversation between the client application and Amazon Lex V2.

Interpretation

An object containing information about an intent that Amazon Lex V2 determined might satisfy the user's utterance. The intents are ordered by the confidence score.

Message

Container for text that is returned to the customer..

PlaybackCompletionEvent

Event sent from the client application to Amazon Lex V2 to indicate that playback of audio is complete and that Amazon Lex V2 should start processing the user's input.

PlaybackInterruptionEvent

Event sent from Amazon Lex V2 to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex V2 sends this event to the client application to indicate that the user is responding and that Amazon Lex V2 is processing their input.

RecognizedBotMember

The bot member that processes the request.

RuntimeHintDetails

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

RuntimeHintValue

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

RuntimeHints

You can provide Amazon Lex V2 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.

SentimentResponse

Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.

For more information, see Determine Sentiment in the Amazon Comprehend developer guide.

SentimentScore

The individual sentiment responses for the utterance.

SessionState

The state of the user's session with Amazon Lex V2.

Slot

A value that Amazon Lex V2 uses to fulfill an intent.

TextInputEvent

The event sent from your client application to Amazon Lex V2 with text input from the user.

TextResponseEvent

The event sent from Amazon Lex V2 to your application with text to present to the user.

TranscriptEvent

Event sent from Amazon Lex V2 to your client application that contains a transcript of voice audio.

Value

Information about the value provided for a slot and Amazon Lex V2's interpretation.

Enums

ConfirmationState

When writing a match expression against ConfirmationState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConversationMode

When writing a match expression against ConversationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DialogActionType

When writing a match expression against DialogActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InputMode

When writing a match expression against InputMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IntentState

When writing a match expression against IntentState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InterpretationSource

When writing a match expression against InterpretationSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MessageContentType

When writing a match expression against MessageContentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PlaybackInterruptionReason

When writing a match expression against PlaybackInterruptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SentimentType

When writing a match expression against SentimentType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Shape

When writing a match expression against Shape, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

StartConversationRequestEventStream

Represents a stream of events between your application and Amazon Lex V2.

StartConversationResponseEventStream

Represents a stream of events between Amazon Lex V2 and your application.

StyleType

When writing a match expression against StyleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.