Skip to content

KeyPhrase

Source code in docs_src/capo_comprehend/types/key_phrase.py
class KeyPhrase(TypedDict, closed=True):
    score: NotRequired["capo_comprehend.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>"""
    text: NotRequired["capo_comprehend.types.string.String"]
    """<p>The text of a key noun phrase.</p>"""
    begin_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The zero-based offset from the beginning of the source text to the first character in the key phrase.</p>"""
    end_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>The zero-based offset from the beginning of the source text to the last character in the key phrase.</p>"""

begin_offset instance-attribute

begin_offset: NotRequired[Integer]

The zero-based offset from the beginning of the source text to the first character in the key phrase.

end_offset instance-attribute

end_offset: NotRequired[Integer]

The zero-based offset from the beginning of the source text to the last character in the key phrase.

score instance-attribute

score: NotRequired[Float]

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

text instance-attribute

text: NotRequired[String]

The text of a key noun phrase.