Skip to content

Lexv2 Runtime Classes

ActiveContextTimeToLiveTypeDef

timeToLiveInSeconds

  • Type:
  • Required: Yes

turnsToLive

  • Type:
  • Required: Yes

ActiveContextTypeDef

name

  • Type:
  • Required: Yes

timeToLive

  • Type:
  • Required: Yes

contextAttributes

  • Type: typing.Dict[str, str]
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ButtonTypeDef

text

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

ConfidenceScoreTypeDef

score

  • Type: typing.Optional[float]

DeleteSessionRequestRequestTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

DeleteSessionResponseTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DialogActionTypeDef

type

  • Type: typing.Literal['Close', 'ConfirmIntent', 'Delegate', 'ElicitIntent', 'ElicitSlot', 'None']
  • Required: Yes

slotToElicit

  • Type: typing.Optional[str]

slotElicitationStyle

  • Type: typing.Optional[typing.Literal['Default', 'SpellByLetter', 'SpellByWord']]

subSlotToElicit

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ElicitSubSlotTypeDef]

ElicitSubSlotTypeDef

name

  • Type:
  • Required: Yes

subSlotToElicit

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

GetSessionRequestRequestTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

GetSessionResponseTypeDef

sessionId

  • Type:
  • Required: Yes

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.MessageTypeDef]
  • Required: Yes

interpretations

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.InterpretationTypeDef]
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ImageResponseCardTypeDef

title

  • Type:
  • Required: Yes

subtitle

  • Type: typing.Optional[str]

imageUrl

  • Type: typing.Optional[str]

buttons

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ButtonTypeDef]]

IntentTypeDef

name

  • Type:
  • Required: Yes

slots

  • Type: typing.Optional[typing.Dict[str, aws_resource_validator.pydantic_models.lexv2_runtime_classes.SlotTypeDef]]

state

  • Type: typing.Optional[typing.Literal['Failed', 'Fulfilled', 'FulfillmentInProgress', 'InProgress', 'ReadyForFulfillment', 'Waiting']]

confirmationState

  • Type: typing.Optional[typing.Literal['Confirmed', 'Denied', 'None']]

InterpretationTypeDef

nluConfidence

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ConfidenceScoreTypeDef]

sentimentResponse

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.SentimentResponseTypeDef]

intent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.IntentTypeDef]

interpretationSource

  • Type: typing.Optional[typing.Literal['Bedrock', 'Lex']]

MessageTypeDef

contentType

  • Type: typing.Literal['CustomPayload', 'ImageResponseCard', 'PlainText', 'SSML']
  • Required: Yes

content

  • Type: typing.Optional[str]

imageResponseCard

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ImageResponseCardTypeDef]

PutSessionRequestRequestTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

messages

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.lexv2_runtime_classes.MessageTypeDef]]

requestAttributes

  • Type: typing.Optional[typing.Mapping[str, str]]

responseContentType

  • Type: typing.Optional[str]

PutSessionResponseTypeDef

contentType

  • Type:
  • Required: Yes

messages

  • Type:
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

requestAttributes

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizeTextRequestRequestTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

text

  • Type:
  • Required: Yes

sessionState

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.SessionStateTypeDef]

requestAttributes

  • Type: typing.Optional[typing.Mapping[str, str]]

RecognizeTextResponseTypeDef

messages

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.MessageTypeDef]
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

interpretations

  • Type: typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.InterpretationTypeDef]
  • Required: Yes

requestAttributes

  • Type: typing.Dict[str, str]
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

recognizedBotMember

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizeUtteranceRequestRequestTypeDef

botId

  • Type:
  • Required: Yes

botAliasId

  • Type:
  • Required: Yes

localeId

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

requestContentType

  • Type:
  • Required: Yes

sessionState

  • Type: typing.Optional[str]

requestAttributes

  • Type: typing.Optional[str]

responseContentType

  • Type: typing.Optional[str]

inputStream

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], NoneType]

RecognizeUtteranceResponseTypeDef

inputMode

  • Type:
  • Required: Yes

contentType

  • Type:
  • Required: Yes

messages

  • Type:
  • Required: Yes

interpretations

  • Type:
  • Required: Yes

sessionState

  • Type:
  • Required: Yes

requestAttributes

  • Type:
  • Required: Yes

sessionId

  • Type:
  • Required: Yes

inputTranscript

  • Type:
  • Required: Yes

audioStream

  • Type:
  • Required: Yes

recognizedBotMember

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RecognizedBotMemberTypeDef

botId

  • Type:
  • Required: Yes

botName

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

RuntimeHintDetailsTypeDef

runtimeHintValues

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.RuntimeHintValueTypeDef]]

subSlotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

RuntimeHintValueTypeDef

phrase

  • Type:
  • Required: Yes

RuntimeHintsTypeDef

slotHints

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, aws_resource_validator.pydantic_models.lexv2_runtime_classes.RuntimeHintDetailsTypeDef]]]

SentimentResponseTypeDef

sentiment

  • Type: typing.Optional[typing.Literal['MIXED', 'NEGATIVE', 'NEUTRAL', 'POSITIVE']]

sentimentScore

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.SentimentScoreTypeDef]

SentimentScoreTypeDef

positive

  • Type: typing.Optional[float]

negative

  • Type: typing.Optional[float]

neutral

  • Type: typing.Optional[float]

mixed

  • Type: typing.Optional[float]

SessionStateTypeDef

dialogAction

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.DialogActionTypeDef]

intent

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.IntentTypeDef]

activeContexts

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ActiveContextTypeDef]]

sessionAttributes

  • Type: typing.Optional[typing.Dict[str, str]]

originatingRequestId

  • Type: typing.Optional[str]

runtimeHints

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.RuntimeHintsTypeDef]

SlotTypeDef

value

  • Type: typing.Optional[aws_resource_validator.pydantic_models.lexv2_runtime_classes.ValueTypeDef]

shape

  • Type: typing.Optional[typing.Literal['Composite', 'List', 'Scalar']]

values

  • Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

subSlots

  • Type: typing.Optional[typing.Dict[str, typing.Dict[str, typing.Any]]]

ValueTypeDef

interpretedValue

  • Type:
  • Required: Yes

originalValue

  • Type: typing.Optional[str]

resolvedValues

  • Type: typing.Optional[typing.List[str]]