Member Junction
    Preparing search index...

    Interface SegmentationResult

    Result of a segmentation pass. Segmenters never throw for content-shaped problems — they return Success: false with an ErrorMessage, matching the convention used by RunView and BaseEntity.Save.

    interface SegmentationResult {
        ErrorMessage?: string;
        SegmenterKey: string;
        Segments: ContentSegment[];
        Success: boolean;
        Warnings: string[];
    }
    Index

    Properties

    ErrorMessage? SegmenterKey Segments Success Warnings

    Properties

    ErrorMessage?: string

    Populated when Success is false.

    SegmenterKey: string

    Registration key of the segmenter that ran.

    Segments: ContentSegment[]

    The produced segments, in order. Empty when Success is false.

    Success: boolean

    False when segmentation could not be performed.

    Warnings: string[]

    Non-fatal notes — e.g. "no cues supplied, fell back to fixed windows".

    Settings

    Member Visibility

    On This Page

    Properties