Interface: SegmentOptions

Defined in: packages/agentos/src/io/segmentation/types.ts:57

Public options accepted by the high-level segment helper.

Properties

automatic?

optional automatic: boolean

Defined in: packages/agentos/src/io/segmentation/types.ts:73

"Segment everything" when true.

---

box?

optional box: SegmentationBox

Defined in: packages/agentos/src/io/segmentation/types.ts:71

Bounding-box prompt.

---

image

image: string | Buffer | Uint8Array

Defined in: packages/agentos/src/io/segmentation/types.ts:59

Source image as raw bytes or a file path.

---

maxMasks?

optional maxMasks: number

Defined in: packages/agentos/src/io/segmentation/types.ts:76

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

---

minScore?

optional minScore: number

Defined in: packages/agentos/src/io/segmentation/types.ts:78

Confidence floor; masks scoring below this are dropped.

---

model?

optional model: string

Defined in: packages/agentos/src/io/segmentation/types.ts:63

Model id override. Provider default is used when omitted.

---

points?

optional points: SegmentationPoint[]

Defined in: packages/agentos/src/io/segmentation/types.ts:69

Point prompts (foreground/background clicks).

---

prompt?

optional prompt: string

Defined in: packages/agentos/src/io/segmentation/types.ts:67

Open-vocabulary text prompt (routes to GroundedSAM).

---

provider?

optional provider: SegmentationProviderId

Defined in: packages/agentos/src/io/segmentation/types.ts:61

Provider id. Defaults to 'replicate'.

---

providerOptions?

optional providerOptions: Record<string, unknown> | SegmentationProviderOptionBag

Defined in: packages/agentos/src/io/segmentation/types.ts:80

Provider-specific passthrough options.

---

userId?

optional userId: string

Defined in: packages/agentos/src/io/segmentation/types.ts:82

Caller id for usage tracking.