Member Junction
    Preparing search index...

    Interface SegmentationParams<TOptions>

    Input to BaseSegmenter.Segment.

    interface SegmentationParams<
        TOptions extends SegmentationOptions = SegmentationOptions,
    > {
        ContextUser?: UserInfo;
        Cues?: TranscriptCue[];
        DurationMs?: number;
        Media?: MediaReference;
        MimeType?: string;
        Options?: TOptions;
        Pages?: ContentPage[];
        Text?: string;
    }

    Type Parameters

    Index

    Properties

    ContextUser? Cues? DurationMs? Media? MimeType? Options? Pages? Text?

    Properties

    ContextUser?: UserInfo

    Context user, required by segmenters that call MJ services (e.g. the LLM boundary pass in SemanticTextSegmenter). Always pass it in server-side code.

    Cues?: TranscriptCue[]

    Timed transcript cues, when available (ASR output or MJ realtime capture).

    DurationMs?: number

    Total duration of the source asset in milliseconds, for AV content.

    Media?: MediaReference

    Media pointer for the source asset, for image/audio/video content.

    MimeType?: string

    Mime type of the source asset — lets a segmenter pick a structure parser.

    Options?: TOptions

    Strategy-specific options.

    Pages?: ContentPage[]

    Pages of a paginated source, for page-aware segmentation.

    OptionalText

    Text?: string

    Extracted text of the source content, when it has any.

    Settings

    Member Visibility

    On This Page

    Properties