Skip to content

TextMatchItem

Source code in docs_src/capo_datazone/types/text_match_item.py
class TextMatchItem(TypedDict, closed=True):
    attribute: NotRequired["capo_datazone.types.attribute.Attribute"]
    """<p>The name of the attribute.</p>"""
    text: NotRequired["str"]
    """<p>Snippet of attribute text containing highlighted content.</p>"""
    match_offsets: NotRequired["capo_datazone.types.match_offsets.MatchOffsets"]
    """<p>List of offsets indicating matching terms in the TextMatchItem text.</p>"""

attribute instance-attribute

attribute: NotRequired[Attribute]

The name of the attribute.

match_offsets instance-attribute

match_offsets: NotRequired[MatchOffsets]

List of offsets indicating matching terms in the TextMatchItem text.

text instance-attribute

text: NotRequired[str]

Snippet of attribute text containing highlighted content.