Search points matrix distance offsets

Compute distance matrix for sampled points with an offset based output format

post/collections/{collection_name}/points/search/matrix/offsets

Path parameters

collection_namestring required

Name of the collection to search in

Query parameters

integer

'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

sampleinteger nullable

How many points to select and search within. Default is 10.

limitinteger nullable

How many neighbours per sample to find. Default is 3.

usingstring nullable

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

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "ids": [
      42
    ]
  }
}

Changes

Changed in 7 of the 18 revisions of this API.367

Aug 5, 2026d08b1f613f29114See the full diff
- ▲
  the filter/anyOf[Filter]/min_should/anyOf[MinShould]/min_count request property's min was increased to 1.00
  request-property-min-increased
- ○
  added MatchPrefix to the filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/must/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/must/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/must_not/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/should/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPrefix to the filter/anyOf[Filter]/should/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/must/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/must/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/must_not/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/should/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added SliceCondition to the filter/anyOf[Filter]/should/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 17, 2025d09f337ca2f310See the full diff
- ○
  added MatchTextAny to the filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/must/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/must/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/must_not/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/should/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchTextAny to the filter/anyOf[Filter]/should/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added ShardKeyWithFallback to the shard_key/anyOf[ShardKeySelector]/ request property anyOf list
  request-property-any-of-added
- ○
  added Usage to the usage response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed HardwareUsage from the usage response property anyOf list for the response status 200
  response-property-any-of-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 18, 2025172ce7556b1f7See the full diff
- ○
  added MatchPhrase to the filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/must/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/must/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/must_not/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/should/anyOf[Condition]/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
- ○
  added MatchPhrase to the filter/anyOf[Filter]/should/anyOf[subschema #2]/items/anyOf[FieldCondition]/match/anyOf[Match]/ request property anyOf list
  request-property-any-of-added
Apr 15, 20255d330acca4cd220See the full diff
- ▲
  removed the required property usage/anyOf[HardwareUsage]/io_read from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property usage/anyOf[HardwareUsage]/io_write from the response with the 200 status
  response-required-property-removed
- ○
  added the new optional request property filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must/anyOf[Condition]/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must/anyOf[Condition]/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must_not/anyOf[Condition]/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must_not/anyOf[Condition]/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/should/anyOf[Condition]/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/should/anyOf[Condition]/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/should/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_empty
  new-optional-request-property
- ○
  added the new optional request property filter/anyOf[Filter]/should/anyOf[subschema #2]/items/anyOf[FieldCondition]/is_null
  new-optional-request-property
- ○
  added the required property usage/anyOf[HardwareUsage]/payload_index_io_read to the response with the 200 status
  response-required-property-added
- ○
  added the required property usage/anyOf[HardwareUsage]/payload_index_io_write to the response with the 200 status
  response-required-property-added
- ○
  added the required property usage/anyOf[HardwareUsage]/payload_io_read to the response with the 200 status
  response-required-property-added
- ○
  added the required property usage/anyOf[HardwareUsage]/payload_io_write to the response with the 200 status
  response-required-property-added
- ○
  added the required property usage/anyOf[HardwareUsage]/vector_io_read to the response with the 200 status
  response-required-property-added
- ○
  added the required property usage/anyOf[HardwareUsage]/vector_io_write to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025a7900f38a79d10See the full diff
- ○
  api tag Search added
  api-tag-added
- ○
  api tag points removed
  api-tag-removed
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/min_should/anyOf[MinShould]/conditions/items/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/must/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/must/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/must_not/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/must_not/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/should/anyOf[Condition]/ request property anyOf list
  request-property-any-of-added
- ○
  added HasVectorCondition to the filter/anyOf[Filter]/should/anyOf[subschema #2]/items/ request property anyOf list
  request-property-any-of-added
- ○
  added the optional property usage to the response with the 200 status
  response-optional-property-added
Oct 13, 202432595103f4625See the full diff
- ○
  api operation id search_points_matrix_offsets removed and replaced with search_matrix_offsets
  api-operation-id-removed
- ○
  the request property limit became nullable
  request-property-became-nullable
- ○
  the request property sample became nullable
  request-property-became-nullable
- ○
  the request property limit became optional
  request-property-became-optional
- ○
  the request property sample became optional
  request-property-became-optional
Sep 9, 202499f8ca65a2071See the full diff
- ○
  endpoint added
  endpoint-added

Full history