Discover batch points | Qdrant

curl  -X POST \
  'http://localhost:6333/collections/collection_name/points/discover/batch' \
  --header 'api-key: <api-key-value>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "searches": [
    {
      "target": [
        0.2,
        0.1,
        0.9,
        0.7
      ],
      "context": [
        {
          "positive": "7f6652c4-89bd-40e0-ab1d-510f7fcddd2b",
          "negative": "2c2c9f86-0171-4bd2-9ab0-b4754682cddd"
        }
      ],
      "limit": 1
    },
    {
      "target": [
        0.5,
        0.3,
        0.2,
        0.3
      ],
      "context": [
        {
          "positive": 342,
          "negative": 213
        }
      ],
      "limit": 1
    }
  ]
}'

{
  "usage": {
    "cpu": 1,
    "payload_io_read": 1,
    "payload_io_write": 1,
    "payload_index_io_read": 1,
    "payload_index_io_write": 1,
    "vector_io_read": 1,
    "vector_io_write": 1
  },
  "time": 0.002,
  "status": "ok",
  "result": [
    [
      {
        "id": 42,
        "version": 3,
        "score": 0.75,
        "payload": {},
        "vector": {},
        "shard_key": "region_1",
        "order_value": 42
      }
    ]
  ]
}

curl  -X POST \
  'http://localhost:6333/collections/collection_name/points/discover/batch' \
  --header 'api-key: <api-key-value>' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "searches": [
    {
      "target": [
        0.2,
        0.1,
        0.9,
        0.7
      ],
      "context": [
        {
          "positive": "7f6652c4-89bd-40e0-ab1d-510f7fcddd2b",
          "negative": "2c2c9f86-0171-4bd2-9ab0-b4754682cddd"
        }
      ],
      "limit": 1
    },
    {
      "target": [
        0.5,
        0.3,
        0.2,
        0.3
      ],
      "context": [
        {
          "positive": 342,
          "negative": 213
        }
      ],
      "limit": 1
    }
  ]
}'

{
  "usage": {
    "cpu": 1,
    "payload_io_read": 1,
    "payload_io_write": 1,
    "payload_index_io_read": 1,
    "payload_index_io_write": 1,
    "vector_io_read": 1,
    "vector_io_write": 1
  },
  "time": 0.002,
  "status": "ok",
  "result": [
    [
      {
        "id": 42,
        "version": 3,
        "score": 0.75,
        "payload": {},
        "vector": {},
        "shard_key": "region_1",
        "order_value": 42
      }
    ]
  ]
}

Retrieves points in batches based on the target and/or positive and negative example pairs.

Authentication

api-keystring

API Key authentication via header

Path parameters

collection_namestringRequired

Name of the collection to search in

Query parameters

consistencyinteger or enumOptional

Define read consistency guarantees for the operation

timeoutintegerOptional>=1

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

Request

Batch request points based on { positive, negative } pairs of examples, and/or a target.

searcheslist of objectsRequired

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultlist of lists of objects

$	curl -X POST \
>	'http://localhost:6333/collections/collection_name/points/discover/batch' \
>	--header 'api-key: <api-key-value>' \
>	--header 'Content-Type: application/json' \
>	--data-raw '{
>	"searches": [
>	{
>	"target": [
>	0.2,
>	0.1,
>	0.9,
>	0.7
>	],
>	"context": [
>	{
>	"positive": "7f6652c4-89bd-40e0-ab1d-510f7fcddd2b",
>	"negative": "2c2c9f86-0171-4bd2-9ab0-b4754682cddd"
>	}
>	],
>	"limit": 1
>	},
>	{
>	"target": [
>	0.5,
>	0.3,
>	0.2,
>	0.3
>	],
>	"context": [
>	{
>	"positive": 342,
>	"negative": 213
>	}
>	],
>	"limit": 1
>	}
>	]
>	}'

1	{
2	"usage": {
3	"cpu": 1,
4	"payload_io_read": 1,
5	"payload_io_write": 1,
6	"payload_index_io_read": 1,
7	"payload_index_io_write": 1,
8	"vector_io_read": 1,
9	"vector_io_write": 1
10	},
11	"time": 0.002,
12	"status": "ok",
13	"result": [
14	[
15	{
16	"id": 42,
17	"version": 3,
18	"score": 0.75,
19	"payload": {},
20	"vector": {},
21	"shard_key": "region_1",
22	"order_value": 42
23	}
24	]
25	]
26	}