Skip to content

Type definitions#

Index > LexRuntimeV2 > Type definitions

Auto-generated documentation for LexRuntimeV2 type annotations stubs module mypy-boto3-lexv2-runtime.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

SessionStateUnionTypeDef#

# SessionStateUnionTypeDef definition

SessionStateUnionTypeDef = Union[
    SessionStateTypeDef,  # (1)
    SessionStateOutputTypeDef,  # (2)
]
  1. See SessionStateTypeDef
  2. See SessionStateOutputTypeDef

MessageUnionTypeDef#

# MessageUnionTypeDef definition

MessageUnionTypeDef = Union[
    MessageTypeDef,  # (1)
    MessageOutputTypeDef,  # (2)
]
  1. See MessageTypeDef
  2. See MessageOutputTypeDef

ActiveContextTimeToLiveTypeDef#

# ActiveContextTimeToLiveTypeDef definition

class ActiveContextTimeToLiveTypeDef(TypedDict):
    timeToLiveInSeconds: int,
    turnsToLive: int,

ButtonTypeDef#

# ButtonTypeDef definition

class ButtonTypeDef(TypedDict):
    text: str,
    value: str,

ConfidenceScoreTypeDef#

# ConfidenceScoreTypeDef definition

class ConfidenceScoreTypeDef(TypedDict):
    score: NotRequired[float],

DeleteSessionRequestRequestTypeDef#

# DeleteSessionRequestRequestTypeDef definition

class DeleteSessionRequestRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DialogActionTypeDef#

# DialogActionTypeDef definition

class DialogActionTypeDef(TypedDict):
    type: DialogActionTypeType,  # (1)
    slotToElicit: NotRequired[str],
    slotElicitationStyle: NotRequired[StyleTypeType],  # (2)
    subSlotToElicit: NotRequired[ElicitSubSlotTypeDef],  # (3)
  1. See DialogActionTypeType
  2. See StyleTypeType
  3. See ElicitSubSlotTypeDef

ElicitSubSlotTypeDef#

# ElicitSubSlotTypeDef definition

class ElicitSubSlotTypeDef(TypedDict):
    name: str,
    subSlotToElicit: NotRequired[Dict[str, Any]],

GetSessionRequestRequestTypeDef#

# GetSessionRequestRequestTypeDef definition

class GetSessionRequestRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,

IntentOutputTypeDef#

# IntentOutputTypeDef definition

class IntentOutputTypeDef(TypedDict):
    name: str,
    slots: NotRequired[Dict[str, SlotOutputTypeDef]],  # (1)
    state: NotRequired[IntentStateType],  # (2)
    confirmationState: NotRequired[ConfirmationStateType],  # (3)
  1. See SlotOutputTypeDef
  2. See IntentStateType
  3. See ConfirmationStateType

IntentTypeDef#

# IntentTypeDef definition

class IntentTypeDef(TypedDict):
    name: str,
    slots: NotRequired[Mapping[str, SlotTypeDef]],  # (1)
    state: NotRequired[IntentStateType],  # (2)
    confirmationState: NotRequired[ConfirmationStateType],  # (3)
  1. See SlotTypeDef
  2. See IntentStateType
  3. See ConfirmationStateType

RecognizedBotMemberTypeDef#

# RecognizedBotMemberTypeDef definition

class RecognizedBotMemberTypeDef(TypedDict):
    botId: str,
    botName: NotRequired[str],

RuntimeHintValueTypeDef#

# RuntimeHintValueTypeDef definition

class RuntimeHintValueTypeDef(TypedDict):
    phrase: str,

RuntimeHintsOutputTypeDef#

# RuntimeHintsOutputTypeDef definition

class RuntimeHintsOutputTypeDef(TypedDict):
    slotHints: NotRequired[Dict[str, Dict[str, RuntimeHintDetailsOutputTypeDef]]],  # (1)
  1. See RuntimeHintDetailsOutputTypeDef

RuntimeHintsTypeDef#

# RuntimeHintsTypeDef definition

class RuntimeHintsTypeDef(TypedDict):
    slotHints: NotRequired[Mapping[str, Mapping[str, RuntimeHintDetailsTypeDef]]],  # (1)
  1. See RuntimeHintDetailsTypeDef

SentimentScoreTypeDef#

# SentimentScoreTypeDef definition

class SentimentScoreTypeDef(TypedDict):
    positive: NotRequired[float],
    negative: NotRequired[float],
    neutral: NotRequired[float],
    mixed: NotRequired[float],

ValueOutputTypeDef#

# ValueOutputTypeDef definition

class ValueOutputTypeDef(TypedDict):
    interpretedValue: str,
    originalValue: NotRequired[str],
    resolvedValues: NotRequired[List[str]],

ValueTypeDef#

# ValueTypeDef definition

class ValueTypeDef(TypedDict):
    interpretedValue: str,
    originalValue: NotRequired[str],
    resolvedValues: NotRequired[Sequence[str]],

ActiveContextOutputTypeDef#

# ActiveContextOutputTypeDef definition

class ActiveContextOutputTypeDef(TypedDict):
    name: str,
    timeToLive: ActiveContextTimeToLiveTypeDef,  # (1)
    contextAttributes: Dict[str, str],
  1. See ActiveContextTimeToLiveTypeDef

ActiveContextTypeDef#

# ActiveContextTypeDef definition

class ActiveContextTypeDef(TypedDict):
    name: str,
    timeToLive: ActiveContextTimeToLiveTypeDef,  # (1)
    contextAttributes: Mapping[str, str],
  1. See ActiveContextTimeToLiveTypeDef

RecognizeUtteranceRequestRequestTypeDef#

# RecognizeUtteranceRequestRequestTypeDef definition

class RecognizeUtteranceRequestRequestTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    requestContentType: str,
    sessionState: NotRequired[str],
    requestAttributes: NotRequired[str],
    responseContentType: NotRequired[str],
    inputStream: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

ImageResponseCardOutputTypeDef#

# ImageResponseCardOutputTypeDef definition

class ImageResponseCardOutputTypeDef(TypedDict):
    title: str,
    subtitle: NotRequired[str],
    imageUrl: NotRequired[str],
    buttons: NotRequired[List[ButtonTypeDef]],  # (1)
  1. See ButtonTypeDef

ImageResponseCardTypeDef#

# ImageResponseCardTypeDef definition

class ImageResponseCardTypeDef(TypedDict):
    title: str,
    subtitle: NotRequired[str],
    imageUrl: NotRequired[str],
    buttons: NotRequired[Sequence[ButtonTypeDef]],  # (1)
  1. See ButtonTypeDef

DeleteSessionResponseTypeDef#

# DeleteSessionResponseTypeDef definition

class DeleteSessionResponseTypeDef(TypedDict):
    botId: str,
    botAliasId: str,
    localeId: str,
    sessionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutSessionResponseTypeDef#

# PutSessionResponseTypeDef definition

class PutSessionResponseTypeDef(TypedDict):
    contentType: str,
    messages: str,
    sessionState: str,
    requestAttributes: str,
    sessionId: str,
    audioStream: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RecognizeUtteranceResponseTypeDef#

# RecognizeUtteranceResponseTypeDef definition

class RecognizeUtteranceResponseTypeDef(TypedDict):
    inputMode: str,
    contentType: str,
    messages: str,
    interpretations: str,
    sessionState: str,
    requestAttributes: str,
    sessionId: str,
    inputTranscript: str,
    audioStream: StreamingBody,
    recognizedBotMember: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RuntimeHintDetailsOutputTypeDef#

# RuntimeHintDetailsOutputTypeDef definition

class RuntimeHintDetailsOutputTypeDef(TypedDict):
    runtimeHintValues: NotRequired[List[RuntimeHintValueTypeDef]],  # (1)
    subSlotHints: NotRequired[Dict[str, Dict[str, Any]]],
  1. See RuntimeHintValueTypeDef

RuntimeHintDetailsTypeDef#

# RuntimeHintDetailsTypeDef definition

class RuntimeHintDetailsTypeDef(TypedDict):
    runtimeHintValues: NotRequired[Sequence[RuntimeHintValueTypeDef]],  # (1)
    subSlotHints: NotRequired[Mapping[str, Dict[str, Any]]],
  1. See RuntimeHintValueTypeDef

SentimentResponseTypeDef#

# SentimentResponseTypeDef definition

class SentimentResponseTypeDef(TypedDict):
    sentiment: NotRequired[SentimentTypeType],  # (1)
    sentimentScore: NotRequired[SentimentScoreTypeDef],  # (2)
  1. See SentimentTypeType
  2. See SentimentScoreTypeDef

SlotOutputTypeDef#

# SlotOutputTypeDef definition

class SlotOutputTypeDef(TypedDict):
    value: NotRequired[ValueOutputTypeDef],  # (1)
    shape: NotRequired[ShapeType],  # (2)
    values: NotRequired[List[Dict[str, Any]]],
    subSlots: NotRequired[Dict[str, Dict[str, Any]]],
  1. See ValueOutputTypeDef
  2. See ShapeType

SlotTypeDef#

# SlotTypeDef definition

class SlotTypeDef(TypedDict):
    value: NotRequired[ValueTypeDef],  # (1)
    shape: NotRequired[ShapeType],  # (2)
    values: NotRequired[Sequence[Dict[str, Any]]],
    subSlots: NotRequired[Mapping[str, Dict[str, Any]]],
  1. See ValueTypeDef
  2. See ShapeType

SessionStateOutputTypeDef#

# SessionStateOutputTypeDef definition

class SessionStateOutputTypeDef(TypedDict):
    dialogAction: NotRequired[DialogActionTypeDef],  # (1)
    intent: NotRequired[IntentOutputTypeDef],  # (2)
    activeContexts: NotRequired[List[ActiveContextOutputTypeDef]],  # (3)
    sessionAttributes: NotRequired[Dict[str, str]],
    originatingRequestId: NotRequired[str],
    runtimeHints: NotRequired[RuntimeHintsOutputTypeDef],  # (4)
  1. See DialogActionTypeDef
  2. See IntentOutputTypeDef
  3. See ActiveContextOutputTypeDef
  4. See RuntimeHintsOutputTypeDef

SessionStateTypeDef#

# SessionStateTypeDef definition

class SessionStateTypeDef(TypedDict):
    dialogAction: NotRequired[DialogActionTypeDef],  # (1)
    intent: NotRequired[IntentTypeDef],  # (2)
    activeContexts: NotRequired[Sequence[ActiveContextTypeDef]],  # (3)
    sessionAttributes: NotRequired[Mapping[str, str]],
    originatingRequestId: NotRequired[str],
    runtimeHints: NotRequired[RuntimeHintsTypeDef],  # (4)
  1. See DialogActionTypeDef
  2. See IntentTypeDef
  3. See ActiveContextTypeDef
  4. See RuntimeHintsTypeDef

MessageOutputTypeDef#

# MessageOutputTypeDef definition

class MessageOutputTypeDef(TypedDict):
    contentType: MessageContentTypeType,  # (1)
    content: NotRequired[str],
    imageResponseCard: NotRequired[ImageResponseCardOutputTypeDef],  # (2)
  1. See MessageContentTypeType
  2. See ImageResponseCardOutputTypeDef

MessageTypeDef#

# MessageTypeDef definition

class MessageTypeDef(TypedDict):
    contentType: MessageContentTypeType,  # (1)
    content: NotRequired[str],
    imageResponseCard: NotRequired[ImageResponseCardTypeDef],  # (2)
  1. See MessageContentTypeType
  2. See ImageResponseCardTypeDef

InterpretationTypeDef#

# InterpretationTypeDef definition

class InterpretationTypeDef(TypedDict):
    nluConfidence: NotRequired[ConfidenceScoreTypeDef],  # (1)
    sentimentResponse: NotRequired[SentimentResponseTypeDef],  # (2)
    intent: NotRequired[IntentOutputTypeDef],  # (3)
    interpretationSource: NotRequired[InterpretationSourceType],  # (4)
  1. See ConfidenceScoreTypeDef
  2. See SentimentResponseTypeDef
  3. See IntentOutputTypeDef
  4. See InterpretationSourceType

RecognizeTextRequestRequestTypeDef#

# RecognizeTextRequestRequestTypeDef definition