Search

Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.

post/collections/{collection_name}/points/query

Request

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. For a text query, the payload field whose text index to search.

score_thresholdnumber float nullable

Return points with scores better than this threshold.

limitinteger nullable

Max number of points to return. Default is 10.

offsetinteger nullable

Offset of the result. Skip this many points. Default is 0

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "points": [
      {
        "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
      }
    ]
  }
}

Changes

    • info

      added to the //////////////////// request property anyOf list

    • info

      added to the ////////////////// request property anyOf list

    • info

      added to the //////////////// request property anyOf list

    • info

      added to the ////////////////// request property anyOf list

    • info

      added to the //////////////// request property anyOf list

    • info

      added to the ////////////////// request property anyOf list

    • info

      added to the //////////////// request property anyOf list

    • info

      added to the ////////////////////////////// request property anyOf list

    • info

      added to the //////////////////////////// request property anyOf list

    • info

      added to the ////////////////////////// request property anyOf list

    • info

      added to the //////////////////////////// request property anyOf list

    • info

      added to the ////////////////////////// request property anyOf list

    • info

      added to the //////////////////////////// request property anyOf list

    • info

      added to the ////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////// request property anyOf list

    • info

      added to the /////////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////// request property anyOf list

    • info

      added to the ///////////////////// request property anyOf list

    • info

      added to the /////////////////// request property anyOf list

    • info

      added to the ///////////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////// request property anyOf list

    • info

      added to the /////////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////// request property anyOf list

    • info

      added to the ///////////////////////////// request property anyOf list

    • info

      added to the ////////////////////////// request property anyOf list

    • info

      added to the ///////////// request property anyOf list

    • info

      added to the /////////// request property anyOf list

    • info

      added to the //////// request property anyOf list

    • info

      added the new code enum value to the request property /////////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////

    • info

      added the new code enum value to the request property ///////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////

    • info

      added the new code enum value to the request property /////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////////////

    • info

      added the new code enum value to the request property ////////////////////////////

    • info

      added the new code enum value to the request property //////////////////////

    • info

      added to the ////////////////// request property anyOf list

    • info

      added to the //////////////// request property anyOf list

    • info

      added to the ///////////// request property anyOf list