Files
qdrant/tests/openapi/test_timeout.py
Andrey Vasnetsov 8a7325ad5d Remove deprecated search endpoints from OpenAPI, deprecate them in gRPC (#9982)
* Remove deprecated search/recommend/discover endpoints from OpenAPI

Remove deprecated REST API endpoint definitions from the OpenAPI
generator. These endpoints were deprecated in v1.13.3 (`f4ced2567`,
#5907, 2025-01-30) in favor of the universal `/points/query` endpoint:

- POST /points/search
- POST /points/search/batch
- POST /points/search/groups
- POST /points/recommend
- POST /points/recommend/batch
- POST /points/recommend/groups
- POST /points/discover
- POST /points/discover/batch

Also removes the corresponding request types from the schema generator
and updates the expected API count in the consistency check.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Migrate OpenAPI integration tests to /points/query

The deprecated /points/search, /points/recommend and /points/discover
endpoints (along with their /batch and /groups variants) were removed
from the OpenAPI spec, which caused validation failures in the Python
integration test harness.

This commit migrates the affected tests to the universal /points/query
endpoint:

- Delete tests dedicated to the deprecated endpoints:
  test_recommend.py, test_discover.py, test_multicollection_reco.py,
  test_recommendation_multivector.py
- Refactor remaining tests to call /points/query (and /query/batch,
  /query/groups), translating request bodies (vector -> query / using,
  positive/negative -> query.recommend, target/context -> query.discover)
  and unwrapping the new result.points response shape.
- Drop equivalence assertions against the now-removed legacy endpoints.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Relax non-empty assertions in migrated recommend/discover tests

The previous migration added `len(...) > 0` assertions to tests that
previously only checked equivalence between the deprecated and new
API. These assertions are too strict because the parametrized
`query_filter` cases legitimately produce empty result sets.

Drop the `> 0` assertion and rely on `request_with_validation` to
verify the response is well-formed and HTTP OK.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Migrate remaining OpenAPI tests off deprecated search endpoints

Tests added to dev after the original migration was written still call
/points/search and /points/recommend/groups through
`request_with_validation`, which resolves the endpoint against the
OpenAPI spec and therefore breaks once the endpoint is not in the spec:

- test_turbo4_storage.py, test_sparse_idf_corpus.py, test_validation.py:
  translate /points/search to /points/query (vector{name,vector} ->
  query + using, result -> result.points).
- test_group.py: drop the /points/recommend/groups half of the
  lookup_from validation test in favour of the query equivalent.

test_sparse_idf_corpus.py's test_query_api_supports_idf_corpus goes
away: with the helper on /points/query every test in the file now
exercises what it asserted.

Also record why test_recommend_group cannot assert on its groups: it
uses every point in the collection as a recommend example, so all of
them are excluded and the result is legitimately empty.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Regenerate openapi.json without the deprecated search endpoints

Drops the 8 deprecated paths and the request schemas that only they
referenced: Search/Recommend/Discover request (+Batch, +Groups) types
and their exclusive dependencies (NamedVector, NamedSparseVector,
NamedVectorStruct, UsingVector, RecommendExample, ContextExamplePair).

Regenerated output is a strict subset of the previous spec, and every
remaining $ref still resolves.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Deprecate the search/recommend/discover RPCs in gRPC

The REST counterparts have carried `deprecated: true` since v1.13.3 and
are now gone from the OpenAPI spec, while the gRPC RPCs never got any
deprecation annotation at all. Mark all 8 with `option deprecated = true`
so generated clients warn, and point each doc comment at its `Query`
replacement.

tonic puts `#[deprecated]` on the generated client methods only; the
server trait gets the doc comment alone, so our own `impl` is unaffected.
The RPCs keep serving traffic — this is annotation only.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

* Restore the deleted recommend/discover suites on /points/query

The earlier migration deleted these four files outright, but the
query-side tests it left behind are all shallow smoke tests
(`len(result) > 0`, `"points" in result[0]`). The deleted ones carried
invariants with no query-API equivalent anywhere, so deleting them was a
real loss of coverage rather than de-duplication:

- test_recommend.py: default strategy equals average_vector; batch
  results identical to sequential singles across six request shapes;
  best_score with only negatives yields all-negative scores; best_score
  with a single positive orders identically to a nearest query; raw
  vectors as examples equal ids as examples.
- test_discover.py: context-only scores are all <= 0; target-only orders
  identically to a nearest query but scores differently; with a fixed
  context the integer part of the score is stable while the decimal part
  moves, and vice versa with a fixed target; batch equals singles;
  lookup_from by id equals by vector.
- test_multicollection_reco.py: cross-collection lookup_from, plus
  wrong-vector-size, unknown-collection and unknown-vector rejections.
- test_recommendation_multivector.py: the same recommend invariants over
  a max_sim multivector collection, which the query suite never covered.

Only test_recommend_missing_lookup_from_collection_with_raw_vector is
dropped as genuinely redundant — test_query.py's
test_query_missing_lookup_from_collection covers query, query/batch and
prefetch.

Two request-shape differences the translation had to absorb:

- Giving no examples at all is 422 (a RecommendInput validation rule),
  where the legacy API reported 400 from the query itself. A malformed
  example, such as an empty vector, is still 400.
- DiscoverInput requires the `context` key and accepts only an explicit
  null to mean "no context", so target-only discover must spell it out.
  The legacy API let it be omitted.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
2026-07-27 18:09:43 +02:00

229 lines
7.4 KiB
Python

from random import random
import subprocess
import pytest
from .helpers.helpers import request_with_validation
from .helpers.collection_setup import drop_collection
num_vectors = 200000
dims = 1024
@pytest.skip("Too big for CI, requires bfb installed", allow_module_level=True)
@pytest.fixture(autouse=True, scope='module')
def setup(collection_name):
drop_collection(collection_name)
response = request_with_validation(
api='/collections/{collection_name}',
method="PUT",
path_params={'collection_name': collection_name},
body={
"vectors": {
"size": dims,
"distance": "Euclid",
"on_disk": True,
},
"optimizers_config": {
"indexing_threshold": 0,
}
}
)
assert response.ok
subprocess.run(['bfb', '--collection-name', collection_name, '--skip-create', '--dim', str(dims), '--num-vectors', str(num_vectors), '--keywords', '300'])
yield
drop_collection(collection_name=collection_name)
def test_search_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"query": [random() for _ in range(dims)],
"limit": 100000,
"filter": {
"must": [
{
"key": "a",
"match": {
"text": "keyword_1"
}
}
]
},
"params": { "exact": False }
}
)
assert not response.ok
assert response.status_code == 500
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'Search' timed out after 1 seconds")
def test_search_batch_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query/batch',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"searches": [
{
"query": [0.5] * dims,
"limit": 100000,
"filter": {
"must": [
{
"key": "a",
"match": {
"text": "keyword_1"
}
}
]
},
},
{
"query": [0.6] * dims,
"limit": 10000,
},
]
}
)
assert not response.ok
assert response.status_code == 500
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'Search' timed out after 1 seconds")
def test_search_groups_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query/groups',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"query": [0.5] * dims,
"limit": 100,
"group_by": "a",
"filter": {"must": [{"key": "a", "match": {"value": "keyword_1"}}]},
"group_size": 3,
}
)
assert not response.ok
assert response.status_code == 408
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'GroupBy' timed out after 1 seconds")
def test_recommend_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"query": {
"recommend": {
"positive": [111,222,333,444,555],
"negative": [666,777,888,999,1010],
"strategy": "best_score",
}
},
"limit": 10000,
}
)
assert not response.ok
assert response.status_code == 500
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'Search' timed out after 1 seconds")
def test_recommend_batch_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query/batch',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"searches": [
{
"query": {
"recommend": {
"positive": [111,222,333,444,555],
"negative": [666,777,888,999,1010],
"strategy": "best_score",
}
},
"limit": 10000,
},
{
"query": {
"recommend": {
"positive": [666,777,888,999,1010],
"negative": [111,222,333,444,555],
"strategy": "best_score",
}
},
"limit": 10000,
},
]
}
)
assert not response.ok
assert response.status_code == 500
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'Search' timed out after 1 seconds")
def test_recommend_groups_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query/groups',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"query": {
"recommend": {
"positive": [111,555],
"negative": [666,1010],
}
},
"limit": 100,
"filter": {"must": [{"key": "a", "match": {"value": "keyword_1"}}]},
"group_by": "a",
"group_size": 3,
}
)
assert not response.ok
assert response.status_code == 408
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'GroupBy' timed out after 1 seconds")
def test_discover_timeout(collection_name):
response = request_with_validation(
api='/collections/{collection_name}/points/query',
method="POST",
path_params={'collection_name': collection_name},
query_params={'timeout': 1},
body={
"query": {
"discover": {
"target": 111,
"context": [
{"positive": 666, "negative": 777},
{"positive": 888, "negative": 999},
{"positive": 1010, "negative": 1111},
],
}
},
"limit": 100,
}
)
assert not response.ok
assert response.status_code == 500
assert response.json()['status']['error'].__contains__("Timeout error: Operation 'Search' timed out after 1 seconds")