Shared Command Parameters

📄️ batch

The batching API allows users to specify a query that can be used by multiple workers to retrieve a portion of the results, as explained above. The query must be exactly the same (except from the batching parameters, of course) for all workers. The result is computed once by one worker and re-used by the rest of workers. The result is cached for 60 seconds since the last access. This is, every time a worker retrieves a portion of the result, the timer resets. After the timer goes off, the result will be re-computed if a worker issues the same query.

📄️ blobs

blobs specifies whether you want to retrieve the blobs associated with the objects that satisfy the constraints of a Find\* command. The returned binary data will be returned in the blobs array, separate from the JSON responses. Typically applies to objects of the type Image, Video, Frame, Clip, Blob, Descriptor, or BoundingBox. Default is “false”.

📄️ class

The class represents an abstraction specific for an application, and can be either applied to an Entity or to a Connection. Simple examples of classes for Entity objects can be “Person”, “Car”, Animal”, “Brain-Scan”. Simple examples of classes for a Connection objects can be “made_visit”, to represent a connection between, say, an Entity of the class a “Person” and an Entity of the class “Visit”.

📄️ codec

The codec parameter can be used to re-encode a video. When inserting a Video (AddVideo), it will perform the transcoding before persisting it. When retrieving a Video (FindVideo), it will perform the operation on-the-fly, without modifying the stored video.

📄️ connect

connect can be used to create a connection between objects (when present in an Add\* command).

📄️ constraints

The constraints parameter filters entities, images, connections, and other objects by their properties. Use expression arrays to compare values, call functions, and combine conditions. The same expression language is available in connection filters and conditional-add filters such as if_not_found.

📄️ container

The container parameter can be used to change the container of a video. When inserting a Video (AddVideo), it will perform the change before persisting it. When retrieving a Video (FindVideo), it will perform the change on-the-fly, without modifying the stored video.

📄️ format

The format parameter can be used to re-encode an image in a format different from the one stored in ApertureDB when retrieving the image, or to re-encode the image before inserting it.

📄️ group_by_source

When is_connected_to parameter is specified in a Find\ command the result is a set of objects connected to the referenced Find\ command by connections as defined by the is_connected_to parameter. group_by_source offers a way to group the resulting objects by their source entity. This parameter is set to False by default and objects are returned in one flat array.

📄️ if_not_found

When using if_not_found, an Add\* command (AddEntity, AddBoundingBox, etc) will become a “conditional add”. This is, the object will be inserted into the database if and only if there is no other element of the same type that fulfills the specified constraints. The most common use case is making sure we do not add an object twice, using some specific properties.

📄️ in_rectangle

The in_rectangle parameter is used to specify the constraints on the position of a region of interest (RoI).

📄️ 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

Typical credentials for cloud services.

📄️ label

The label parameter is string used to specify the label for either a BoundingBox or a Descriptor object, as follows:

📄️ 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

The properties are key-value pairs associated with objects (Entity, Image, Video, Descriptor, etc) and connections.

📄️ rectangle

The rectangle parameter is used to specify the coordinates of a BoundingBox object, as follows:

📄️ ref

The \_ref value is used to specify a reference to the added entity to be used later (usually, to create a connection to another object) within the same transaction. The ref value is used to specify such a backwards reference to an entity.

📄️ 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. Use list to select properties, expressions to compute output values, or all_properties to return every property. Use count to count matches before offset and limit*.

📄️ search

similarity, isimilarity, and fulltext return numeric values using the constraint expression grammar. Compare these values with a threshold to select matches, combine conditions with all, any, and not, and use sort expressions to rank results. Return any number of scores through results.expressions.