📄️ batch
batch lets multiple workers retrieve portions of one cached query result. All workers must sign in as the same user and submit exactly the same query except for the batching parameters. The first worker computes the result; subsequent workers for that user reuse it. Refreshing a session or signing in again preserves the cached result. Each page request must still have a valid session and permission to run the query. The cached result expires 60 seconds after its last access. Each retrieval resets that timer, and a query submitted after expiry recomputes the result.
📄️ blobs
blobs controls whether a Find\* command returns binary data for matching objects. The binary data appears in the blob array, separate from the JSON response. This parameter typically applies to Image, Video, Frame, Clip, Blob, Descriptor, and BoundingBox objects. Its default is false.
📄️ class
A class names an application-defined type of Entity or Connection. Entity classes can represent people, cars, animals, or brain scans. A connection class such as made_visit describes a relationship between a Person entity and a Visit entity.
📄️ codec
The codec parameter selects the encoding of a video. AddVideo transcodes the input before storing it. FindVideo transcodes the returned video without changing the stored content.
📄️ connect
connect creates connections between an object inserted by an Add\* command and objects referenced earlier in the transaction.
📄️ constraints
The constraints parameter selects objects whose properties satisfy an expression. Expressions can compare values, call functions, and combine conditions. They apply to entities, images, connections, and other object types.
📄️ container
The container parameter selects the container format of a video. AddVideo changes the container before storing the video. FindVideo changes the container of the returned video without modifying the stored content.
📄️ format
The format parameter selects the encoding of an image. On insertion, ApertureDB re-encodes the image before storing it. On retrieval, it re-encodes the returned image without changing the stored content.
📄️ group_by_source
group_by_source groups a Find\ command’s matching objects by the source objects of its relationship lookup. With is_connected_to*, each source is an object in the referenced selection. The default is false, which returns objects in one flat array.
📄️ if_not_found
if_not_found makes an Add\* command conditional: the command inserts an object only when no existing object of the same type matches the condition. A condition on identifying properties can prevent repeated insertion of the same object.
📄️ in_rectangle
in_rectangle restricts a query to regions of interest (RoIs) fully within a rectangle. The x and y coordinates locate its upper-left corner; width and height define its dimensions.
📄️ is_connected_to
is_connected_to specifies one or more connection-based constraints that must be satisfied in a Find\ command. It returns object(s) that are connected to the objects referenced by ref*.
📄️ is_endpoint_of
is_endpoint_of restricts a Find\ command to endpoints of connections referenced earlier in the same transaction. Unlike is_connected_to, its ref* identifies connections, not objects.
📄️ key
CreateCredential and UpdateCredential require a complete key object. The origin scheme selects how the object is interpreted. Registration validates required fields; the provider checks authentication and access when an object is fetched. Keys are never returned by inspection commands.
📄️ label
label assigns a string label to a BoundingBox or Descriptor object. For example, a descriptor can identify a person:
📄️ limit
limit specifies the maximum number of elements that will be returned.
📄️ metric
A metric parameter describes a specific metric or collection of metrics within a family.
📄️ offset
offset specifies the number of results that will be skipped. For instance, to retrieve the first 10 results, offset must be set to 0 and limit to 10. To retrieve the next 10 results, offset must be set to 10 and limit to 10.
📄️ operations
operations indicates visual operations to be performed on Image and Video objects at insertion or at retrieval time, and on Frame and Clip objects at retrieval time.
📄️ per_group
The per_group parameter controls how sort, offset, and limit are applied when groupbysource is enabled.
📄️ polygons
The polygons parameter is used to describe the geometry of Polygon RoI, as follows:
📄️ properties
properties stores key-value pairs on objects, such as entities, images, videos, and descriptors, and on connections. Queries can filter these objects by their property values.
📄️ rectangle
rectangle defines a BoundingBox by its upper-left pixel coordinates, width, and height.
📄️ ref
\_ref assigns an integer reference to objects added or found by a command. Later commands in the same request consume it through ref or a command-specific field such as src, dst, image_ref, or video_ref. A reference may represent several matched objects.
📄️ remove_props
remove_props is a list of property keys that will be removed as part of an Update\* command.
📄️ results
The results object specifies which properties, expression values, counts, and aggregates a Find\ command returns. list selects properties, expressions computes output values, and all_properties returns every property. count counts matches before offset and limit*.
📄️ search
similarity, isimilarity, and fulltext return numeric scores in the constraint expression grammar. Threshold comparisons select matching records, and all, any, and not combine conditions. sort expressions rank results; results.expressions returns any number of scores alongside properties.
📄️ sort
The sort parameter orders returned results by properties or value expressions.
📄️ unique
The unique keyword is used in Find\* commands to specify the expectation that only a single Object should be returned as a result. The default is false. When enabled, a violated count expectation can return status: 3; see Responses. This parameter controls the expectation for this query, not a persistent uniqueness constraint on stored properties.
📄️ uniqueids
uniqueids controls whether a Find\* command returns the internal unique IDs of matching objects. Its default is false.
📄️ url
url identifies remote content for an Add\ command instead of supplying an input blob. It applies to Add\ commands that accept blobs, except AddDescriptor. The content remains in remote storage.
📄️ video_position
Video positions can be expressed as frame numbers, elapsed time, or fractions of the video duration. The same units define individual positions and ranges.