Detection.Detect

Perform Detection on a list of Images.

DetectRequest

images
array[ImageItem]
feed_id
string

User specified ID to reference the source of the image

custom_id
string

User specified ID used to identify an image. This optional custom ID can be used to map your image request to a result from Engine. Engine does not perform any operations with custom ID, it merely just passes the value directly back in the response. It is up to the client to ensure uniqueness.

group_id
string

User specified GroupID used to identify an image. This is only used by the Face Recognition feature.

data
string

Either encoded or pixel image data

exclusion_zones
array[ExclusionZone]

Zones to ignore on this image (optional)

points
array[Point]

Ordered list of points delimitating this polygon

x
int32

Position on the X-axis

y
int32

Position on the Y-axis

classes
array[string]

The classes to detect

persistence
Persistence

DetectResponse

images
array[DetectImageResult]
image_id
string

ID assigned to the image

feed_id
string

User specified ID to reference the source of the image

custom_id
string

Arbitrary user specified ID to reference the image

results
array[DetectResult]
class
string

The class found

confidence
float

The confidence for the class

bounding_box
BoundingBox
x_min
int32

Start position of bounding box on the X-axis

y_min
int32

Start position of bounding box on the Y-axis

x_max
int32

End position of bounding box on the X-axis

y_max
int32

End position of bounding box on the Y-axis

normalized_bounding_box
NormalizedBoundingBox
x_min
double

Normalized start position of bounding box on the X-axis

y_min
double

Normalized start position of bounding box on the Y-axis

x_max
double

Normalized end position of bounding box on the X-axis

y_max
double

Normalized end position of bounding box on the Y-axis

exclusion_zones
array[ExclusionZone]
points
array[Point]

Ordered list of points delimitating this polygon

x
int32

Position on the X-axis

y
int32

Position on the Y-axis