Interface SegmentOptions

Public options accepted by the high-level segment helper.

interface SegmentOptions {
    image: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>;
    provider?: SegmentationProviderId;
    model?: string;
    prompt?: string;
    points?: SegmentationPoint[];
    box?: SegmentationBox;
    automatic?: boolean;
    maxMasks?: number;
    minScore?: number;
    providerOptions?: Record<string, unknown> | SegmentationProviderOptionBag;
    userId?: string;
}

Properties

image provider? model? prompt? points? box? automatic? maxMasks? minScore? providerOptions? userId?

Properties

image

image: string | Buffer<ArrayBufferLike> | Uint8Array<ArrayBufferLike>

Source image as raw bytes or a file path.

Optional provider

provider?: SegmentationProviderId

Provider id. Defaults to 'replicate'.

Optional model

model?: string

Model id override. Provider default is used when omitted.

Optional prompt

prompt?: string

Open-vocabulary text prompt (routes to GroundedSAM).

Optional points

points?: SegmentationPoint[]

Point prompts (foreground/background clicks).

Optional box

box?: SegmentationBox

Bounding-box prompt.

Optional automatic

automatic?: boolean

"Segment everything" when true.

Optional maxMasks

maxMasks?: number

Cap on returned masks (automatic/text can produce many).

Optional minScore

minScore?: number

Confidence floor; masks scoring below this are dropped.

Optional providerOptions

providerOptions?: Record<string, unknown> | SegmentationProviderOptionBag

Provider-specific passthrough options.

Optional userId

userId?: string

Caller id for usage tracking.

Settings

Member Visibility

Theme

On This Page

imageprovidermodelpromptpointsboxautomaticmaxMasksminScoreproviderOptionsuserId