Make k and num_candidates optional in kNN queries

elastic · Apr 8, 2024 · 7a668f4 · 7a668f4
1 parent 21f5860
commit 7a668f4
Show file tree

Hide file tree

Showing 7 changed files with 248 additions and 24 deletions.
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/_global/msearch/types.ts b/specification/_global/msearch/types.ts
@@ -41,7 +41,7 @@ import { Rescore } from '@global/search/_types/rescoring'
 import { SourceConfig } from '@global/search/_types/SourceFilter'
 import { RuntimeFields } from '@_types/mapping/RuntimeFields'
 import { ScriptField } from '@_types/Scripting'
-import { KnnQuery } from '@_types/Knn'
+import { KnnSearch } from '@_types/Knn'
 import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
 /**
@@ -101,7 +101,7 @@ export class MultisearchBody {
    * @availability stack since=8.4.0
    * @availability serverless
    */
-  knn?: KnnQuery | KnnQuery[]
+  knn?: KnnSearch | KnnSearch[]
   /**
    * Starting document offset. By default, you cannot page through more than 10,000
    * hits using the from and size parameters. To page through more hits, use the

diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts
@@ -46,7 +46,7 @@ import { Suggester } from './_types/suggester'
 import { TrackHits } from '@global/search/_types/hits'
 import { Operator } from '@_types/query_dsl/Operator'
 import { Sort, SortResults } from '@_types/sort'
-import { KnnQuery } from '@_types/Knn'
+import { KnnSearch } from '@_types/Knn'
 import { RankContainer } from '@_types/Rank'
 import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
 
@@ -384,7 +384,7 @@ export interface Request extends RequestBase {
      * @availability stack since=8.4.0
      * @availability serverless
      */
-    knn?: KnnQuery | KnnQuery[]
+    knn?: KnnSearch | KnnSearch[]
     /**
      * Defines the Reciprocal Rank Fusion (RRF) to use.
      * @availability stack since=8.8.0