Skip to main content

per_group

The per_group parameter controls how sort, offset, and limit are applied when group_by_source is enabled.

When per_group is false, sorting and pagination are applied to the complete result set before it is divided into source groups. When per_group is true, they are applied independently within each source group. For example, a limit of 10 returns up to 10 matching objects for each source.

The default value is false. Setting per_group to true without also setting group_by_source to true returns an error.

This parameter is supported by:

  • FindEntity

  • FindConnection

  • FindBlob, FindImage, and FindVideo

  • FindDescriptorSet, FindDescriptor, and FindDescriptorBatch

  • FindBoundingBox and FindPolygon

  • FindFrame

It cannot be used with batch commands because group_by_source is not available for batched results.