ClassifyPayload.md

@foyer-inc/insight-sdk / Exports / ClassifyPayload

Interface: ClassifyPayload

An interface describing the payload sent to the classify endpoint

Table of contents

Properties

• detectionsRequested
• file
• files
• force
• includeSegmentations
• includeTagpoints
• url
• urls

Properties

detectionsRequested

• Optional detectionsRequested: string[]

An array of detections names to be returned in ClassifyResponse

Defined in

lib/types.ts:67

---

file

• Optional file: string

An image encoded as a base64 string

Defined in

lib/types.ts:37

---

files

• Optional files: string[]

An array of images encoded as base64 strings

Defined in

lib/types.ts:41

---

force

• Optional force: boolean

A flag requesting a new result even when cached data exists

Defined in

lib/types.ts:53

---

includeSegmentations

• Optional includeSegmentations: boolean

A flag requesting the segmentations property to be returned with each Detection, necessary for post processing

Defined in

lib/types.ts:58

---

includeTagpoints

• Optional includeTagpoints: boolean

A flag requesting the tagpoint attribute to be returned with each Detection

Defined in

lib/types.ts:63

---

url

• Optional url: string

A url for a remotely hosted image

Defined in

lib/types.ts:45

---

urls

• Optional urls: string[]

An array of urls for remotely hosted images

Defined in

lib/types.ts:49