upstream-archive/qdrant
1
0
Fork 0
mirror of https://github.com/qdrant/qdrant.git synced 2026-07-23 11:11:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

add consistency param for count api in openapi (#6905)

Browse Source 
* add consistency param to openapi spec for count api

* reorder query params: collection_name -> consistency -> timeout
This commit is contained in:
Luis Cossío
2025-08-14 10:38:53 -04:00
committed by timvisee
parent d9a6329429
commit 70f315d49e
2 changed files with 37 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/redoc/master/openapi.json
View File

@@ -5440,7 +5440,7 @@
"Search"
],
"summary": "Discover points",
"description": "Use context and a target to find the most similar points to the target, constrained by the context.\nWhen using only the context (without a target), a special search - called context search - is performed where pairs of points are used to generate a loss that guides the search towards the zone where most positive examples overlap. This means that the score minimizes the scenario of finding a point closer to a negative than to a positive part of a pair.\nSince the score of a context relates to loss, the maximum score a point can get is 0.0, and it becomes normal that many points can have a score of 0.0.\nWhen using target (with or without context), the score behaves a little different: The integer part of the score represents the rank with respect to the context, while the decimal part of the score relates to the distance to the target. The context part of the score for each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair, and -1 otherwise.\n",
"description": "Use context and a target to find the most similar points to the target, constrained by the context.\nWhen using only the context (without a target), a special search - called context search - is performed where pairs of points are used to generate a loss that guides the search towards the zone where most positive examples overlap. This means that the score minimizes the scenario of finding a point closer to a negative than to a positive part of a pair.\nSince the score of a context relates to loss, the maximum score a point can get is 0.0, and it becomes normal that many points can have a score of 0.0.\nWhen using target (with or without context), the score behaves a little different: The integer part of the score represents the rank with respect to the context, while the decimal part of the score relates to the distance to the target. The context part of the score for each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair, and -1 otherwise.\n",
"operationId": "discover_points",
"requestBody": {
"description": "Request points based on {positive, negative} pairs of examples, and/or a target",
@@ -5688,6 +5688,15 @@
"type": "string"
}
},
{
"name": "consistency",
"in": "query",
"description": "Define read consistency guarantees for the operation",
"required": false,
"schema": {
"$ref": "#/components/schemas/ReadConsistency"
}
},
{
"name": "timeout",
"in": "query",
@@ -5787,6 +5796,15 @@
"type": "string"
}
},
{
"name": "consistency",
"in": "query",
"description": "Define read consistency guarantees for the operation",
"required": false,
"schema": {
"$ref": "#/components/schemas/ReadConsistency"
}
},
{
"name": "timeout",
"in": "query",
@@ -5796,15 +5814,6 @@
"type": "integer",
"minimum": 1
}
},
{
"name": "consistency",
"in": "query",
"description": "Define read consistency guarantees for the operation",
"required": false,
"schema": {
"$ref": "#/components/schemas/ReadConsistency"
}
}
],
"responses": {

30
openapi/openapi-main.ytt.yaml
View File

@@ -527,10 +527,10 @@ paths:
Since the score of a context relates to loss, the maximum score a point can get is 0.0,
and it becomes normal that many points can have a score of 0.0.
When using target (with or without context), the score behaves a little different: The
When using target (with or without context), the score behaves a little different: The
integer part of the score represents the rank with respect to the context, while the
decimal part of the score relates to the distance to the target. The context part of the score for
each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair,
decimal part of the score relates to the distance to the target. The context part of the score for
each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair,
and -1 otherwise.
operationId: discover_points
requestBody:
@@ -620,6 +620,12 @@ paths:
required: true
schema:
type: string
- name: consistency
in: query
description: Define read consistency guarantees for the operation
required: false
schema:
$ref: "#/components/schemas/ReadConsistency"
- name: timeout
in: query
description: If set, overrides global timeout for this request. Unit is seconds.
@@ -650,6 +656,12 @@ paths:
required: true
schema:
type: string
- name: consistency
in: query
description: Define read consistency guarantees for the operation
required: false
schema:
$ref: "#/components/schemas/ReadConsistency"
- name: timeout
in: query
description: If set, overrides global timeout for this request. Unit is seconds.
@@ -657,14 +669,8 @@ paths:
schema:
type: integer
minimum: 1
- name: consistency
in: query
description: Define read consistency guarantees for the operation
required: false
schema:
$ref: "#/components/schemas/ReadConsistency"
responses: #@ response(reference("FacetResponse"))
/collections/{collection_name}/points/query:
post:
tags:
@@ -672,13 +678,13 @@ paths:
summary: Query points
description: Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.
operationId: query_points
requestBody:
requestBody:
description: Describes the query to make to the collection
content:
application/json:
schema:
$ref: "#/components/schemas/QueryRequest"
parameters:
- name: collection_name