Skip to content

PromptSpecification

Source code in docs_src/capo_lex_models_v2/types/prompt_specification.py
class PromptSpecification(TypedDict, closed=True):
    message_groups: "capo_lex_models_v2.types.message_groups_list.MessageGroupsList"
    """<p>A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.</p>"""
    max_retries: "capo_lex_models_v2.types.prompt_max_retries.PromptMaxRetries"
    """<p>The maximum number of times the bot tries to elicit a response from the user using this prompt.</p>"""
    allow_interrupt: NotRequired["capo_lex_models_v2.types.boxed_boolean.BoxedBoolean"]
    """<p>Indicates whether the user can interrupt a speech prompt from the bot.</p>"""
    message_selection_strategy: NotRequired[
        "capo_lex_models_v2.types.message_selection_strategy.MessageSelectionStrategy"
    ]
    """<p>Indicates how a message is selected from a message group among retries.</p>"""
    prompt_attempts_specification: NotRequired[
        "capo_lex_models_v2.types.prompt_attempts_specification_map.PromptAttemptsSpecificationMap"
    ]
    """<p>Specifies the advanced settings on each attempt of the prompt.</p>"""

allow_interrupt instance-attribute

allow_interrupt: NotRequired[BoxedBoolean]

Indicates whether the user can interrupt a speech prompt from the bot.

max_retries instance-attribute

max_retries: PromptMaxRetries

The maximum number of times the bot tries to elicit a response from the user using this prompt.

message_groups instance-attribute

message_groups: MessageGroupsList

A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

message_selection_strategy instance-attribute

message_selection_strategy: NotRequired[MessageSelectionStrategy]

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

prompt_attempts_specification instance-attribute

prompt_attempts_specification: NotRequired[PromptAttemptsSpecificationMap]

Specifies the advanced settings on each attempt of the prompt.