Skip to content

Commit 1f5026a

Browse files
committed
added availability annotations
1 parent 8ad0fb1 commit 1f5026a

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

specification/_types/Knn.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ export interface KnnSearch {
4343
k?: integer
4444
/** The number of nearest neighbor candidates to consider per shard */
4545
num_candidates?: integer
46-
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk */
46+
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk
47+
* @availability stack since=9.2.0
48+
* @availability serverless
49+
*/
4750
visit_percentage?: float
4851
/** Boost value to apply to kNN scores */
4952
boost?: float
@@ -75,7 +78,10 @@ export interface KnnQuery extends QueryBase {
7578
query_vector_builder?: QueryVectorBuilder
7679
/** The number of nearest neighbor candidates to consider per shard */
7780
num_candidates?: integer
78-
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk */
81+
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk
82+
* @availability stack since=9.2.0
83+
* @availability serverless
84+
*/
7985
visit_percentage?: float
8086
/** The final number of nearest neighbors to return as top hits */
8187
k?: integer

specification/_types/Retriever.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,10 @@ export class KnnRetriever extends RetrieverBase {
124124
k: integer
125125
/** Number of nearest neighbor candidates to consider per shard. */
126126
num_candidates: integer
127-
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk */
127+
/** The percentage of vectors to explore per shard while doing knn search with bbq_disk
128+
* @availability stack since=9.2.0
129+
* @availability serverless
130+
*/
128131
visit_percentage?: float
129132
/** The minimum similarity required for a document to be considered a match. */
130133
similarity?: float

0 commit comments

Comments
 (0)