Skip to main content

Interface: BackgroundRemovalImage

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

One image a background removal returns: the cut-out, or the matte.

Properties​

buffer?​

optional buffer: Buffer

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

The image's bytes, with output: 'buffer' or when the provider answered inline.


dataUrl?​

optional dataUrl: string

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

The image as a data URL, with output: 'buffer' or when the provider answered inline.


fileSize?​

optional fileSize: number

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

Size in bytes, when the provider reports it.


height?​

optional height: number

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

Height in pixels, when the provider reports it.


mimeType​

mimeType: string

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

The image's media type, e.g. 'image/png'.


url?​

optional url: string

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

Where the provider stores the file. Absent when it came back inline.


width?​

optional width: number

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

Width in pixels, when the provider reports it.