Sign in

v17

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-2575397522.8 KB
Search

Query points, grouped by a given payload field

Universally query points, grouped by a given payload field

post/collections/{collection_name}/points/query/groups

Path parameters

collection_namestring required

Name of the collection to query

Query parameters

integer
OR
'majority' | 'quorum' | 'all'

  • majority - send N/2+1 random request and return points, which present on all of them

  • quorum - send requests to all nodes and return points which present on majority of nodes

  • all - send requests to all nodes and return points which present on all nodes

Define read consistency guarantees for the operation

timeoutinteger

If set, overrides global timeout for this request. Unit is seconds.

Request body

usingstring nullable

Define which vector name to use for querying. If missing, the default vector is used.

score_thresholdnumber float nullable

Return points with scores better than this threshold.

group_bystring required

Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.

group_sizeinteger nullable

Maximum amount of points to return per group. Default is 3.

limitinteger nullable

Maximum amount of groups to return. Default is 10.

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "groups": [
      {
        "hits": [
          {
            "id": 42,
            "version": 3,
            "score": 0.75,
            "payload": {
              "city": "London",
              "color": "green"
            },
            "vector": [
              0.875,
              0.140625,
              0.897599995136261
            ],
            "shard_key": "region_1",
            "order_value": 42
          }
        ],
        "lookup": {
          "id": 42,
          "payload": {
            "city": "London",
            "color": "green"
          },
          "vector": [
            0.875,
            0.140625,
            0.897599995136261
          ],
          "shard_key": "region_1",
          "order_value": 42
        }
      }
    ]
  }
}