Skip to content

Interpretation

Source code in docs_src/capo_lex_runtime_v2/types/interpretation.py
class Interpretation(TypedDict, closed=True):
    nlu_confidence: NotRequired[
        "capo_lex_runtime_v2.types.confidence_score.ConfidenceScore"
    ]
    """<p>Determines the threshold where Amazon Lex V2 will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a response. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p>"""
    sentiment_response: NotRequired[
        "capo_lex_runtime_v2.types.sentiment_response.SentimentResponse"
    ]
    """<p>The sentiment expressed in an utterance. </p> <p>When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.</p>"""
    intent: NotRequired["capo_lex_runtime_v2.types.intent.Intent"]
    """<p>A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.</p>"""
    interpretation_source: NotRequired[
        "capo_lex_runtime_v2.types.interpretation_source.InterpretationSource"
    ]
    """<p>Specifies the service that interpreted the input.</p>"""

intent instance-attribute

intent: NotRequired[Intent]

A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.

interpretation_source instance-attribute

interpretation_source: NotRequired[InterpretationSource]

Specifies the service that interpreted the input.

nlu_confidence instance-attribute

nlu_confidence: NotRequired[ConfidenceScore]

Determines the threshold where Amazon Lex V2 will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.

sentiment_response instance-attribute

sentiment_response: NotRequired[SentimentResponse]

The sentiment expressed in an utterance.

When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.