Skip to content

Commit a71ebb5

Browse files
elasticmachineelasticmachine
authored
Auto-generated code for main (#2258)
1 parent 05f7078 commit a71ebb5

File tree

4 files changed

+82
-11
lines changed

4 files changed

+82
-11
lines changed

‎docs/reference.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -935,6 +935,7 @@ A post filter has no impact on the aggregation results.
935935
NOTE: This is a debugging tool and adds significant overhead to search execution.
936936
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule_query, script, script_score, shape, simple_query_string, span_containing, field_masking_span, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Defines the search definition using the Query DSL.
937937
** *`rescore` (Optional, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[])*: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.
938+
** *`retriever` (Optional, { standard, knn, rrf })*: A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as query and knn.
938939
** *`script_fields` (Optional, Record<string, { script, ignore_failure }>)*: Retrieve a script evaluation (based on different fields) for each hit.
939940
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Used to retrieve the next page of hits using a set of sort values from the previous page.
940941
** *`size` (Optional, number)*: The number of hits to return.

‎src/api/api/search.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export default async function SearchApi<TDocument = unknown, TAggregations = Rec
4646
export default async function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptions): Promise<T.SearchResponse<TDocument, TAggregations>>
4747
export default async function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>> (this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptions): Promise<any> {
4848
const acceptedPath: string[] = ['index']
49-
const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'ext', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'knn', 'rank', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats']
49+
const acceptedBody: string[] = ['aggregations', 'aggs', 'collapse', 'explain', 'ext', 'from', 'highlight', 'track_total_hits', 'indices_boost', 'docvalue_fields', 'knn', 'rank', 'min_score', 'post_filter', 'profile', 'query', 'rescore', 'retriever', 'script_fields', 'search_after', 'size', 'slice', 'sort', '_source', 'fields', 'suggest', 'terminate_after', 'timeout', 'track_scores', 'version', 'seq_no_primary_term', 'stored_fields', 'pit', 'runtime_mappings', 'stats']
5050
const querystring: Record<string, any> = {}
5151
// @ts-expect-error
5252
const userBody: any = params?.body

‎src/api/types.ts

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -665,8 +665,8 @@ export interface KnnSearchResponse<TDocument = unknown> {
665665
export interface KnnSearchQuery {
666666
field: Field
667667
query_vector: QueryVector
668-
k: long
669-
num_candidates: long
668+
k: integer
669+
num_candidates: integer
670670
}
671671

672672
export interface MgetMultiGetError {
@@ -1167,6 +1167,7 @@ export interface SearchRequest extends RequestBase {
11671167
profile?: boolean
11681168
query?: QueryDslQueryContainer
11691169
rescore?: SearchRescore | SearchRescore[]
1170+
retriever?: RetrieverContainer
11701171
script_fields?: Record<string, ScriptField>
11711172
search_after?: SortResults
11721173
size?: integer
@@ -2294,17 +2295,26 @@ export interface KnnQuery extends QueryDslQueryBase {
22942295
field: Field
22952296
query_vector?: QueryVector
22962297
query_vector_builder?: QueryVectorBuilder
2297-
num_candidates?: long
2298+
num_candidates?: integer
22982299
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
22992300
similarity?: float
23002301
}
23012302

2303+
export interface KnnRetriever extends RetrieverBase {
2304+
field: string
2305+
query_vector?: QueryVector
2306+
query_vector_builder?: QueryVectorBuilder
2307+
k: integer
2308+
num_candidates: integer
2309+
similarity?: float
2310+
}
2311+
23022312
export interface KnnSearch {
23032313
field: Field
23042314
query_vector?: QueryVector
23052315
query_vector_builder?: QueryVectorBuilder
2306-
k?: long
2307-
num_candidates?: long
2316+
k?: integer
2317+
num_candidates?: integer
23082318
boost?: float
23092319
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
23102320
similarity?: float
@@ -2443,6 +2453,12 @@ export interface QueryVectorBuilder {
24432453
text_embedding?: TextEmbedding
24442454
}
24452455

2456+
export interface RRFRetriever extends RetrieverBase {
2457+
retrievers: RetrieverContainer[]
2458+
rank_constant?: integer
2459+
rank_window_size?: integer
2460+
}
2461+
24462462
export interface RankBase {
24472463
}
24482464

@@ -2492,6 +2508,16 @@ export interface Retries {
24922508
search: long
24932509
}
24942510

2511+
export interface RetrieverBase {
2512+
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
2513+
}
2514+
2515+
export interface RetrieverContainer {
2516+
standard?: StandardRetriever
2517+
knn?: KnnRetriever
2518+
rrf?: RRFRetriever
2519+
}
2520+
24952521
export type Routing = string
24962522

24972523
export interface RrfRank {
@@ -2647,6 +2673,15 @@ export type SortOrder = 'asc' | 'desc'
26472673

26482674
export type SortResults = FieldValue[]
26492675

2676+
export interface StandardRetriever extends RetrieverBase {
2677+
query?: QueryDslQueryContainer
2678+
search_after?: SortResults
2679+
terminate_after?: integer
2680+
sort?: Sort
2681+
min_score?: float
2682+
collapse?: SearchFieldCollapse
2683+
}
2684+
26502685
export interface StoreStats {
26512686
size?: ByteSize
26522687
size_in_bytes: long

‎src/api/typesWithBodyKey.ts

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -690,8 +690,8 @@ export interface KnnSearchResponse<TDocument = unknown> {
690690
export interface KnnSearchQuery {
691691
field: Field
692692
query_vector: QueryVector
693-
k: long
694-
num_candidates: long
693+
k: integer
694+
num_candidates: integer
695695
}
696696

697697
export interface MgetMultiGetError {
@@ -1221,6 +1221,7 @@ export interface SearchRequest extends RequestBase {
12211221
profile?: boolean
12221222
query?: QueryDslQueryContainer
12231223
rescore?: SearchRescore | SearchRescore[]
1224+
retriever?: RetrieverContainer
12241225
script_fields?: Record<string, ScriptField>
12251226
search_after?: SortResults
12261227
size?: integer
@@ -2367,17 +2368,26 @@ export interface KnnQuery extends QueryDslQueryBase {
23672368
field: Field
23682369
query_vector?: QueryVector
23692370
query_vector_builder?: QueryVectorBuilder
2370-
num_candidates?: long
2371+
num_candidates?: integer
23712372
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
23722373
similarity?: float
23732374
}
23742375

2376+
export interface KnnRetriever extends RetrieverBase {
2377+
field: string
2378+
query_vector?: QueryVector
2379+
query_vector_builder?: QueryVectorBuilder
2380+
k: integer
2381+
num_candidates: integer
2382+
similarity?: float
2383+
}
2384+
23752385
export interface KnnSearch {
23762386
field: Field
23772387
query_vector?: QueryVector
23782388
query_vector_builder?: QueryVectorBuilder
2379-
k?: long
2380-
num_candidates?: long
2389+
k?: integer
2390+
num_candidates?: integer
23812391
boost?: float
23822392
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
23832393
similarity?: float
@@ -2516,6 +2526,12 @@ export interface QueryVectorBuilder {
25162526
text_embedding?: TextEmbedding
25172527
}
25182528

2529+
export interface RRFRetriever extends RetrieverBase {
2530+
retrievers: RetrieverContainer[]
2531+
rank_constant?: integer
2532+
rank_window_size?: integer
2533+
}
2534+
25192535
export interface RankBase {
25202536
}
25212537

@@ -2565,6 +2581,16 @@ export interface Retries {
25652581
search: long
25662582
}
25672583

2584+
export interface RetrieverBase {
2585+
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
2586+
}
2587+
2588+
export interface RetrieverContainer {
2589+
standard?: StandardRetriever
2590+
knn?: KnnRetriever
2591+
rrf?: RRFRetriever
2592+
}
2593+
25682594
export type Routing = string
25692595

25702596
export interface RrfRank {
@@ -2720,6 +2746,15 @@ export type SortOrder = 'asc' | 'desc'
27202746

27212747
export type SortResults = FieldValue[]
27222748

2749+
export interface StandardRetriever extends RetrieverBase {
2750+
query?: QueryDslQueryContainer
2751+
search_after?: SortResults
2752+
terminate_after?: integer
2753+
sort?: Sort
2754+
min_score?: float
2755+
collapse?: SearchFieldCollapse
2756+
}
2757+
27232758
export interface StoreStats {
27242759
size?: ByteSize
27252760
size_in_bytes: long

0 commit comments

Comments
 (0)