mirror of
https://github.com/qdrant/qdrant.git
synced 2026-08-04 09:01:00 -05:00
8a7325ad5d
* 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>
465 lines
13 KiB
Python
465 lines
13 KiB
Python
import pytest
|
|
|
|
from .helpers.collection_setup import basic_collection_setup, drop_collection
|
|
from .helpers.helpers import request_with_validation
|
|
|
|
|
|
@pytest.fixture(autouse=True, scope="module")
|
|
def setup(on_disk_vectors, collection_name):
|
|
basic_collection_setup(collection_name=collection_name, on_disk_vectors=on_disk_vectors)
|
|
yield
|
|
drop_collection(collection_name=collection_name)
|
|
|
|
|
|
def test_points_retrieve(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/{id}',
|
|
method="GET",
|
|
path_params={'collection_name': collection_name, 'id': 2},
|
|
)
|
|
assert response.ok
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"ids": [1, 2]
|
|
}
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()['result']) == 2
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}',
|
|
method="GET",
|
|
path_params={'collection_name': collection_name},
|
|
)
|
|
assert response.ok
|
|
assert response.json()['result']['points_count'] == 10
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 3
|
|
}
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()['result']['points']) == 3
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"key": "city",
|
|
"match": {
|
|
"value": "London"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 3
|
|
}
|
|
)
|
|
assert response.ok
|
|
# only 2 London records in collection
|
|
assert len(response.json()['result']['points']) == 2
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/scroll',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={"offset": 2, "limit": 2, "with_vector": True}
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()['result']['points']) == 2
|
|
|
|
|
|
def test_exclude_payload(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"key": "city",
|
|
"match": {
|
|
"value": "London"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"with_payload": {
|
|
"exclude": ["city"]
|
|
}
|
|
}
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()['result']['points']) > 0
|
|
for result in response.json()['result']['points']:
|
|
assert 'city' not in result['payload']
|
|
|
|
|
|
def test_batch_search(collection_name):
|
|
response = request_with_validation(
|
|
api="/collections/{collection_name}/points/query/batch",
|
|
method="POST",
|
|
path_params={"collection_name": collection_name},
|
|
body={
|
|
"searches": [
|
|
{
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 3,
|
|
},
|
|
{
|
|
"filter": {
|
|
"should": [{"key": "city", "match": {"value": "London"}}]
|
|
},
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 3,
|
|
},
|
|
],
|
|
},
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()["result"]) == 2
|
|
assert len(response.json()["result"][0]["points"]) == 3
|
|
assert len(response.json()["result"][1]["points"]) == 2
|
|
|
|
response = request_with_validation(
|
|
api="/collections/{collection_name}/points/query/batch",
|
|
method="POST",
|
|
path_params={"collection_name": collection_name},
|
|
body={"searches": []},
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()["result"]) == 0
|
|
|
|
|
|
def test_is_empty_condition(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"is_empty": {
|
|
"key": "city"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
|
|
assert response.ok
|
|
|
|
json = response.json()
|
|
assert len(json['result']['points']) == 4
|
|
|
|
ids = [x['id'] for x in json['result']['points']]
|
|
assert 5 in ids
|
|
assert 6 in ids
|
|
assert 7 in ids
|
|
assert 8 in ids
|
|
|
|
response2 = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"key": "city",
|
|
"is_empty": True
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert response2.ok
|
|
|
|
json2 = response2.json()
|
|
ids2 = [x['id'] for x in json2['result']['points']]
|
|
assert ids == ids2
|
|
|
|
|
|
def test_is_null_condition(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"is_null": {
|
|
"key": "city"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert response.ok
|
|
|
|
json = response.json()
|
|
assert len(json['result']['points']) == 1
|
|
|
|
ids = [x['id'] for x in json['result']['points']]
|
|
assert 7 in ids
|
|
|
|
response2 = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"should": [
|
|
{
|
|
"key": "city",
|
|
"is_null": True
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert response2.ok
|
|
|
|
json2 = response2.json()
|
|
ids2 = [x['id'] for x in json2['result']['points']]
|
|
|
|
assert ids == ids2
|
|
|
|
# With must_not (as recommended in docs)
|
|
def must_not_is_null(field: str):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"must_not": [
|
|
{
|
|
"is_null": {
|
|
"key": field
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert response.ok
|
|
|
|
json = response.json()
|
|
assert len(json['result']['points']) == 5
|
|
|
|
ids = [x['id'] for x in json['result']['points']]
|
|
assert 5 not in ids
|
|
assert 6 not in ids
|
|
assert 7 not in ids
|
|
assert 1 in ids
|
|
assert 2 in ids
|
|
|
|
response2 = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 5,
|
|
"filter": {
|
|
"must": [
|
|
{
|
|
"key": field,
|
|
"is_null": False
|
|
}
|
|
]
|
|
},
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert response2.ok
|
|
|
|
json2 = response2.json()
|
|
ids2 = [x['id'] for x in json2['result']['points']]
|
|
assert ids == ids2
|
|
|
|
must_not_is_null("city")
|
|
must_not_is_null("city[]")
|
|
|
|
|
|
def test_recommendation(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"query": {
|
|
"recommend": {
|
|
"negative": [],
|
|
"positive": [1],
|
|
}
|
|
},
|
|
"limit": 3,
|
|
"with_vector": False,
|
|
"with_payload": True
|
|
}
|
|
)
|
|
assert len(response.json()['result']['points']) == 3
|
|
assert response.json()['result']['points'][0]['payload'] is not None
|
|
assert response.ok
|
|
|
|
|
|
def test_query_single_condition(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/query',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"filter": {
|
|
"must": {
|
|
"key": "city",
|
|
"match": {
|
|
"value": "London"
|
|
}
|
|
}
|
|
},
|
|
"query": [0.2, 0.1, 0.9, 0.7],
|
|
"limit": 3
|
|
}
|
|
)
|
|
assert response.ok
|
|
# only 2 London records in collection
|
|
assert len(response.json()['result']['points']) == 2
|
|
|
|
|
|
def test_query_nested(collection_name):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points',
|
|
method="PUT",
|
|
path_params={'collection_name': collection_name},
|
|
query_params={'wait': 'true'},
|
|
body={
|
|
"points": [
|
|
{
|
|
"id": 8,
|
|
"vector": [0.15, 0.31, 0.76, 0.74],
|
|
"payload": {
|
|
"database_id": {
|
|
"type": "keyword",
|
|
"value": "8594ff5d-265f-4785-a9f5-b3b4b9665506"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
)
|
|
assert response.ok
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/scroll',
|
|
method="POST",
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
"offset": None,
|
|
"limit": 10,
|
|
"with_vector": True,
|
|
"filter": {
|
|
"must": [
|
|
{
|
|
"key": "database_id.value",
|
|
"match": {
|
|
"value": "8594ff5d-265f-4785-a9f5-b3b4b9665506"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
)
|
|
assert response.ok
|
|
assert len(response.json()['result']['points']) == 1
|
|
|
|
|
|
def test_with_vectors_alias_of_with_vector(collection_name):
|
|
database_id = "8594ff5d-265f-adfh-a9f5-b3b4b9665506"
|
|
vector = [0.15, 0.31, 0.76, 0.74]
|
|
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points',
|
|
method="PUT",
|
|
path_params={'collection_name': collection_name},
|
|
query_params={'wait': 'true'},
|
|
body={
|
|
"points": [
|
|
{
|
|
"id": 8,
|
|
"vector": vector,
|
|
"payload": {
|
|
"database_id": database_id,
|
|
}
|
|
}
|
|
]
|
|
}
|
|
)
|
|
assert response.ok
|
|
|
|
def scroll_with_vector(keyword):
|
|
response = request_with_validation(
|
|
api='/collections/{collection_name}/points/scroll',
|
|
method='POST',
|
|
path_params={'collection_name': collection_name},
|
|
body={
|
|
keyword: True, # <--- should make no difference
|
|
"filter": {
|
|
"must": [
|
|
{
|
|
"key": "database_id",
|
|
"match": {
|
|
"value": database_id
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"limit": 1,
|
|
}
|
|
)
|
|
|
|
assert response.ok
|
|
body = response.json()
|
|
|
|
assert body["result"]["points"][0]["vector"] == vector
|
|
|
|
scroll_with_vector("with_vector")
|
|
scroll_with_vector("with_vectors")
|