Skip to content

Segment

Source code in docs_src/capo_xray/types/segment.py
class Segment(TypedDict, closed=True):
    id: NotRequired["capo_xray.types.segment_id.SegmentId"]
    """<p>The segment's ID.</p>"""
    document: NotRequired["capo_xray.types.segment_document.SegmentDocument"]
    """<p>The segment document.</p>"""

document instance-attribute

document: NotRequired[SegmentDocument]

The segment document.

id instance-attribute

id: NotRequired[SegmentId]

The segment's ID.