Skip to main content

EOIProcessImageInputs

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOIProcessImageInputs

Class: EOIProcessImageInputs

Request payload for processing a single image.

Extends​

Constructors​

Constructor​

new EOIProcessImageInputs(base64Image, regions, return_image?, effects?): EOIProcessImageInputs

Parameters​

base64Image​

Base64-encoded image payload.

string | undefined

regions​

EOIRegion[]

Detection regions and configuration.

return_image?​

boolean

Whether to include an annotated image in the response.

effects?​

EOIEffects

Optional visual effects/overlays configuration.

Returns​

EOIProcessImageInputs

Overrides​

EOIBaseInputs.constructor

Properties​

base64Image​

base64Image: string | undefined

Base64-encoded image payload.

regions​

regions: EOIRegion[]

Detection regions and configuration.

Inherited from​

EOIBaseInputs.regions

return_image?​

optional return_image: boolean

Whether to include an annotated image in the response.

effects?​

optional effects: EOIEffects

Optional visual effects/overlays configuration.

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOIProcessImageInputs | undefined

Parameters​

obj​

any

Returns​

EOIProcessImageInputs | undefined

stringify()​

stringify(): string

Serializes this payload for the API request body. The serializer excludes nested confidence values.

Returns​

string

validate()​

validate(): EOIResponse

Validates this payload against SDK-side constraints.

Returns​

EOIResponse