Engine

Images.SearchImages

Search for image results that match given filters.

SearchImagesRequest

feed_ids	`array[string]` Search for images associated with feed IDs
start	`int64` Search for images created after this timestamp
end	`int64` Search for images created before this timestamp
limit	`int64` Number to limit search results by
offset	`int64` Number to offset search results by
query	`string`
is_summary	`bool`
is_descending	`bool` Order of search results returned
custom_id	`string` Search for images with this custom_id

SearchImagesResponse

images

array[GetImageResponse]

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

created_at

int64

Timestamp for when image was created

data

string

Either encoded or pixel image data

classification

array[ClassifyResultWithExclusionZones]

result

ClassifyResult

class	`string` The class found
confidence	`float` The confidence for the class

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

detection

array[DetectResultWithExclusionZones]

result

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

face_recognition

array[RecognizeFaceResultWithExclusionZones]

result

RecognizeFaceResult

face_id

string

ID assigned to the face

identity_id

string

ID of the identity this face is assigned to

name

string

Name given to identity

confidence

float

The confidence for the face

bounding_box

BoundingBox

Bounding box with absolute pixel coordinates

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

Bounding box with coordinates normalized against the image

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

sharpness

float

The sharpness of the face

frontal_pose

string

The frontal pose of a face

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