Interface SegmentImageConfig

Configuration for segmenting an image.

interface SegmentImageConfig {
    abortSignal?: AbortSignal;
    binaryColorThreshold?: number;
    confidenceThreshold?: number;
    httpOptions?: HttpOptions;
    labels?: Record<string, string>;
    maskDilation?: number;
    maxPredictions?: number;
    mode?: SegmentMode;
}

Properties

abortSignal? binaryColorThreshold? confidenceThreshold? httpOptions? labels? maskDilation? maxPredictions? mode?

Properties

OptionalabortSignal

abortSignal?: AbortSignal

Abort signal which can be used to cancel the request.

NOTE: AbortSignal is a client-only operation. Using it to cancel an operation will not cancel the request in the service. You will still be charged usage for any applicable operations.

OptionalbinaryColorThreshold

binaryColorThreshold?: number

The binary color threshold to apply to the masks. The threshold can be set to a decimal value between 0 and 255 non-inclusive. Set to -1 for no binary color thresholding.

OptionalconfidenceThreshold

confidenceThreshold?: number

The confidence score threshold for the detections as a decimal value. Only predictions with a confidence score higher than this threshold will be returned.

OptionalhttpOptions

httpOptions?: HttpOptions

Used to override HTTP request options.

Optionallabels

labels?: Record<string, string>

User specified labels to track billing usage.

OptionalmaskDilation

maskDilation?: number

A decimal value representing how much dilation to apply to the masks. 0 for no dilation. 1.0 means the masked area covers the whole image.

OptionalmaxPredictions

maxPredictions?: number

The maximum number of predictions to return up to, by top confidence score.

Optionalmode

mode?: SegmentMode

The segmentation mode to use.

Settings

On This Page

Properties