Skip to main content

EOIObjectDescription

eyesonit-typescript-sdk

eyesonit-typescript-sdk / EOIObjectDescription

Class: EOIObjectDescription

Constructors​

Constructor​

new EOIObjectDescription(text, background_prompt, alert, threshold?, confidence?, over_threshold?): EOIObjectDescription

Parameters​

text​

string

background_prompt​

boolean = false

alert​

boolean = true

threshold?​

number

confidence?​

number

over_threshold?​

boolean = false

Returns​

EOIObjectDescription

Properties​

display_text​

display_text: string

text​

text: string

background_prompt​

background_prompt: boolean = false

alert​

alert: boolean = true

threshold?​

optional threshold: number

confidence?​

optional confidence: number

over_threshold​

over_threshold: boolean = false

Methods​

fromJsonObj()​

static fromJsonObj(obj): EOIObjectDescription

Parameters​

obj​

any

Returns​

EOIObjectDescription

toJSON()​

toJSON(): { text: string; background_prompt: true; alert: boolean; threshold?: undefined; display_text?: undefined; } | { text: string; background_prompt: false; threshold: number | undefined; alert: boolean; display_text: string; }

Returns​

{ text: string; background_prompt: true; alert: boolean; threshold?: undefined; display_text?: undefined; } | { text: string; background_prompt: false; threshold: number | undefined; alert: boolean; display_text: string; }

default()​

static default(): EOIObjectDescription

Returns​

EOIObjectDescription