Type definitions#
Index > LexRuntimeService > Type definitions
Auto-generated documentation for LexRuntimeService type annotations stubs module mypy-boto3-lex-runtime.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_lex_runtime.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]
DialogActionUnionTypeDef#
# DialogActionUnionTypeDef Union usage example
from mypy_boto3_lex_runtime.type_defs import DialogActionUnionTypeDef
def get_value() -> DialogActionUnionTypeDef:
return ...
# DialogActionUnionTypeDef definition
DialogActionUnionTypeDef = Union[
DialogActionTypeDef, # (1)
DialogActionOutputTypeDef, # (2)
]
IntentSummaryUnionTypeDef#
# IntentSummaryUnionTypeDef Union usage example
from mypy_boto3_lex_runtime.type_defs import IntentSummaryUnionTypeDef
def get_value() -> IntentSummaryUnionTypeDef:
return ...
# IntentSummaryUnionTypeDef definition
IntentSummaryUnionTypeDef = Union[
IntentSummaryTypeDef, # (1)
IntentSummaryOutputTypeDef, # (2)
]
ActiveContextUnionTypeDef#
# ActiveContextUnionTypeDef Union usage example
from mypy_boto3_lex_runtime.type_defs import ActiveContextUnionTypeDef
def get_value() -> ActiveContextUnionTypeDef:
return ...
# ActiveContextUnionTypeDef definition
ActiveContextUnionTypeDef = Union[
ActiveContextTypeDef, # (1)
ActiveContextOutputTypeDef, # (2)
]
ActiveContextTimeToLiveTypeDef#
# ActiveContextTimeToLiveTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ActiveContextTimeToLiveTypeDef
def get_value() -> ActiveContextTimeToLiveTypeDef:
return {
"timeToLiveInSeconds": ...,
}
# ActiveContextTimeToLiveTypeDef definition
class ActiveContextTimeToLiveTypeDef(TypedDict):
timeToLiveInSeconds: NotRequired[int],
turnsToLive: NotRequired[int],
ButtonTypeDef#
# ButtonTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ButtonTypeDef
def get_value() -> ButtonTypeDef:
return {
"text": ...,
}
# ButtonTypeDef definition
class ButtonTypeDef(TypedDict):
text: str,
value: str,
DeleteSessionRequestTypeDef#
# DeleteSessionRequestTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import DeleteSessionRequestTypeDef
def get_value() -> DeleteSessionRequestTypeDef:
return {
"botName": ...,
}
# DeleteSessionRequestTypeDef definition
class DeleteSessionRequestTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DialogActionOutputTypeDef#
# DialogActionOutputTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import DialogActionOutputTypeDef
def get_value() -> DialogActionOutputTypeDef:
return {
"type": ...,
}
# DialogActionOutputTypeDef definition
class DialogActionOutputTypeDef(TypedDict):
type: DialogActionTypeType, # (1)
intentName: NotRequired[str],
slots: NotRequired[Dict[str, str]],
slotToElicit: NotRequired[str],
fulfillmentState: NotRequired[FulfillmentStateType], # (2)
message: NotRequired[str],
messageFormat: NotRequired[MessageFormatTypeType], # (3)
DialogActionTypeDef#
# DialogActionTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import DialogActionTypeDef
def get_value() -> DialogActionTypeDef:
return {
"type": ...,
}
# DialogActionTypeDef definition
class DialogActionTypeDef(TypedDict):
type: DialogActionTypeType, # (1)
intentName: NotRequired[str],
slots: NotRequired[Mapping[str, str]],
slotToElicit: NotRequired[str],
fulfillmentState: NotRequired[FulfillmentStateType], # (2)
message: NotRequired[str],
messageFormat: NotRequired[MessageFormatTypeType], # (3)
GetSessionRequestTypeDef#
# GetSessionRequestTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import GetSessionRequestTypeDef
def get_value() -> GetSessionRequestTypeDef:
return {
"botName": ...,
}
# GetSessionRequestTypeDef definition
class GetSessionRequestTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
checkpointLabelFilter: NotRequired[str],
IntentSummaryOutputTypeDef#
# IntentSummaryOutputTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import IntentSummaryOutputTypeDef
def get_value() -> IntentSummaryOutputTypeDef:
return {
"intentName": ...,
}
# IntentSummaryOutputTypeDef definition
class IntentSummaryOutputTypeDef(TypedDict):
dialogActionType: DialogActionTypeType, # (2)
intentName: NotRequired[str],
checkpointLabel: NotRequired[str],
slots: NotRequired[Dict[str, str]],
confirmationStatus: NotRequired[ConfirmationStatusType], # (1)
fulfillmentState: NotRequired[FulfillmentStateType], # (3)
slotToElicit: NotRequired[str],
IntentConfidenceTypeDef#
# IntentConfidenceTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import IntentConfidenceTypeDef
def get_value() -> IntentConfidenceTypeDef:
return {
"score": ...,
}
# IntentConfidenceTypeDef definition
class IntentConfidenceTypeDef(TypedDict):
score: NotRequired[float],
IntentSummaryTypeDef#
# IntentSummaryTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import IntentSummaryTypeDef
def get_value() -> IntentSummaryTypeDef:
return {
"intentName": ...,
}
# IntentSummaryTypeDef definition
class IntentSummaryTypeDef(TypedDict):
dialogActionType: DialogActionTypeType, # (2)
intentName: NotRequired[str],
checkpointLabel: NotRequired[str],
slots: NotRequired[Mapping[str, str]],
confirmationStatus: NotRequired[ConfirmationStatusType], # (1)
fulfillmentState: NotRequired[FulfillmentStateType], # (3)
slotToElicit: NotRequired[str],
SentimentResponseTypeDef#
# SentimentResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import SentimentResponseTypeDef
def get_value() -> SentimentResponseTypeDef:
return {
"sentimentLabel": ...,
}
# SentimentResponseTypeDef definition
class SentimentResponseTypeDef(TypedDict):
sentimentLabel: NotRequired[str],
sentimentScore: NotRequired[str],
ActiveContextOutputTypeDef#
# ActiveContextOutputTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ActiveContextOutputTypeDef
def get_value() -> ActiveContextOutputTypeDef:
return {
"name": ...,
}
# ActiveContextOutputTypeDef definition
class ActiveContextOutputTypeDef(TypedDict):
name: str,
timeToLive: ActiveContextTimeToLiveTypeDef, # (1)
parameters: Dict[str, str],
ActiveContextTypeDef#
# ActiveContextTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ActiveContextTypeDef
def get_value() -> ActiveContextTypeDef:
return {
"name": ...,
}
# ActiveContextTypeDef definition
class ActiveContextTypeDef(TypedDict):
name: str,
timeToLive: ActiveContextTimeToLiveTypeDef, # (1)
parameters: Mapping[str, str],
PostContentRequestTypeDef#
# PostContentRequestTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PostContentRequestTypeDef
def get_value() -> PostContentRequestTypeDef:
return {
"botName": ...,
}
# PostContentRequestTypeDef definition
class PostContentRequestTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
contentType: str,
inputStream: BlobTypeDef,
sessionAttributes: NotRequired[str],
requestAttributes: NotRequired[str],
accept: NotRequired[str],
activeContexts: NotRequired[str],
GenericAttachmentTypeDef#
# GenericAttachmentTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import GenericAttachmentTypeDef
def get_value() -> GenericAttachmentTypeDef:
return {
"title": ...,
}
# GenericAttachmentTypeDef definition
class GenericAttachmentTypeDef(TypedDict):
title: NotRequired[str],
subTitle: NotRequired[str],
attachmentLinkUrl: NotRequired[str],
imageUrl: NotRequired[str],
buttons: NotRequired[List[ButtonTypeDef]], # (1)
- See
List[ButtonTypeDef]
DeleteSessionResponseTypeDef#
# DeleteSessionResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import DeleteSessionResponseTypeDef
def get_value() -> DeleteSessionResponseTypeDef:
return {
"botName": ...,
}
# DeleteSessionResponseTypeDef definition
class DeleteSessionResponseTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
sessionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PostContentResponseTypeDef#
# PostContentResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PostContentResponseTypeDef
def get_value() -> PostContentResponseTypeDef:
return {
"contentType": ...,
}
# PostContentResponseTypeDef definition
class PostContentResponseTypeDef(TypedDict):
contentType: str,
intentName: str,
nluIntentConfidence: str,
alternativeIntents: str,
slots: str,
sessionAttributes: str,
sentimentResponse: str,
message: str,
encodedMessage: str,
messageFormat: MessageFormatTypeType, # (1)
dialogState: DialogStateType, # (2)
slotToElicit: str,
inputTranscript: str,
encodedInputTranscript: str,
audioStream: botocore.response.StreamingBody,
botVersion: str,
sessionId: str,
activeContexts: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutSessionResponseTypeDef#
# PutSessionResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PutSessionResponseTypeDef
def get_value() -> PutSessionResponseTypeDef:
return {
"contentType": ...,
}
# PutSessionResponseTypeDef definition
class PutSessionResponseTypeDef(TypedDict):
contentType: str,
intentName: str,
slots: str,
sessionAttributes: str,
message: str,
encodedMessage: str,
messageFormat: MessageFormatTypeType, # (1)
dialogState: DialogStateType, # (2)
slotToElicit: str,
audioStream: botocore.response.StreamingBody,
sessionId: str,
activeContexts: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PredictedIntentTypeDef#
# PredictedIntentTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PredictedIntentTypeDef
def get_value() -> PredictedIntentTypeDef:
return {
"intentName": ...,
}
# PredictedIntentTypeDef definition
class PredictedIntentTypeDef(TypedDict):
intentName: NotRequired[str],
nluIntentConfidence: NotRequired[IntentConfidenceTypeDef], # (1)
slots: NotRequired[Dict[str, str]],
GetSessionResponseTypeDef#
# GetSessionResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import GetSessionResponseTypeDef
def get_value() -> GetSessionResponseTypeDef:
return {
"recentIntentSummaryView": ...,
}
# GetSessionResponseTypeDef definition
class GetSessionResponseTypeDef(TypedDict):
recentIntentSummaryView: List[IntentSummaryOutputTypeDef], # (1)
sessionAttributes: Dict[str, str],
sessionId: str,
dialogAction: DialogActionOutputTypeDef, # (2)
activeContexts: List[ActiveContextOutputTypeDef], # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See
List[IntentSummaryOutputTypeDef]
- See DialogActionOutputTypeDef
- See
List[ActiveContextOutputTypeDef]
- See ResponseMetadataTypeDef
ResponseCardTypeDef#
# ResponseCardTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import ResponseCardTypeDef
def get_value() -> ResponseCardTypeDef:
return {
"version": ...,
}
# ResponseCardTypeDef definition
class ResponseCardTypeDef(TypedDict):
version: NotRequired[str],
contentType: NotRequired[ContentTypeType], # (1)
genericAttachments: NotRequired[List[GenericAttachmentTypeDef]], # (2)
- See ContentTypeType
- See
List[GenericAttachmentTypeDef]
PostTextRequestTypeDef#
# PostTextRequestTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PostTextRequestTypeDef
def get_value() -> PostTextRequestTypeDef:
return {
"botName": ...,
}
# PostTextRequestTypeDef definition
class PostTextRequestTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
inputText: str,
sessionAttributes: NotRequired[Mapping[str, str]],
requestAttributes: NotRequired[Mapping[str, str]],
activeContexts: NotRequired[Sequence[ActiveContextUnionTypeDef]], # (1)
- See
Sequence[ActiveContextUnionTypeDef]
PutSessionRequestTypeDef#
# PutSessionRequestTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PutSessionRequestTypeDef
def get_value() -> PutSessionRequestTypeDef:
return {
"botName": ...,
}
# PutSessionRequestTypeDef definition
class PutSessionRequestTypeDef(TypedDict):
botName: str,
botAlias: str,
userId: str,
sessionAttributes: NotRequired[Mapping[str, str]],
dialogAction: NotRequired[DialogActionUnionTypeDef], # (1)
recentIntentSummaryView: NotRequired[Sequence[IntentSummaryUnionTypeDef]], # (2)
accept: NotRequired[str],
activeContexts: NotRequired[Sequence[ActiveContextUnionTypeDef]], # (3)
- See DialogActionUnionTypeDef
- See
Sequence[IntentSummaryUnionTypeDef]
- See
Sequence[ActiveContextUnionTypeDef]
PostTextResponseTypeDef#
# PostTextResponseTypeDef TypedDict usage example
from mypy_boto3_lex_runtime.type_defs import PostTextResponseTypeDef
def get_value() -> PostTextResponseTypeDef:
return {
"intentName": ...,
}
# PostTextResponseTypeDef definition
class PostTextResponseTypeDef(TypedDict):
intentName: str,
nluIntentConfidence: IntentConfidenceTypeDef, # (1)
alternativeIntents: List[PredictedIntentTypeDef], # (2)
slots: Dict[str, str],
sessionAttributes: Dict[str, str],
message: str,
sentimentResponse: SentimentResponseTypeDef, # (3)
messageFormat: MessageFormatTypeType, # (4)
dialogState: DialogStateType, # (5)
slotToElicit: str,
responseCard: ResponseCardTypeDef, # (6)
sessionId: str,
botVersion: str,
activeContexts: List[ActiveContextOutputTypeDef], # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)
- See IntentConfidenceTypeDef
- See
List[PredictedIntentTypeDef]
- See SentimentResponseTypeDef
- See MessageFormatTypeType
- See DialogStateType
- See ResponseCardTypeDef
- See
List[ActiveContextOutputTypeDef]
- See ResponseMetadataTypeDef