You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and `d` (days). Also accepts `0` without a unit and `-1` to indicate an unspecified value.
// Set to `true` to ignore an unmapped field and not match any documents for this query. Set to `false` to throw an exception if the field is not mapped.
2539
2547
optionalboolignore_unmapped=6;
2540
2548
2541
-
map<string, GeoLocation> location=7;
2549
+
// The unit of distance measurement.
2550
+
optionalDistanceUnitunit=7;
2551
+
2552
+
map<string, GeoLocation> location=8;
2542
2553
}
2543
2554
messageGeoDistanceSort {
2544
2555
// The mode for sorting on array or multi-valued fields.
Copy file name to clipboardExpand all lines: protos/generated/services/default_service.proto
+31-79Lines changed: 31 additions & 79 deletions
Original file line number
Diff line number
Diff line change
@@ -87,145 +87,97 @@ message SearchRequest {
87
87
// If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified.
88
88
optionalboolanalyze_wildcard=7;
89
89
90
-
// Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.
91
-
optionalstringanalyzer=8;
92
-
93
90
// The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
94
-
optionalint32batched_reduce_size=9;
91
+
optionalint32batched_reduce_size=8;
95
92
96
93
// The time after which the search request will be canceled. Request-level parameter takes precedence over `cancel_after_time_interval` cluster setting.
97
-
optionalstringcancel_after_time_interval=10;
94
+
optionalstringcancel_after_time_interval=9;
98
95
99
96
// If `true`, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests.
100
-
optionalboolccs_minimize_roundtrips=11;
97
+
optionalboolccs_minimize_roundtrips=10;
101
98
102
99
// The default operator for query string query: AND or OR. This parameter can only be used when the `q` query string parameter is specified.
103
-
optionalOperatordefault_operator=12;
100
+
optionalOperatordefault_operator=11;
104
101
105
102
// Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.
106
-
optionalstringdf=13;
103
+
optionalstringdf=12;
107
104
108
105
// A comma-separated list of fields to return as the docvalue representation for each hit.
109
-
repeatedstringdocvalue_fields=14;
106
+
repeatedstringdocvalue_fields=13;
110
107
111
108
// Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.
112
-
repeatedExpandWildcardexpand_wildcards=15;
113
-
114
-
// If `true`, returns detailed information about score computation as part of a hit.
115
-
optionalboolexplain=16;
116
-
117
-
// Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.
118
-
optionalint32from=17;
109
+
repeatedExpandWildcardexpand_wildcards=14;
119
110
120
111
// If `true`, concrete, expanded or aliased indexes will be ignored when frozen.
121
-
optionalboolignore_throttled=18;
112
+
optionalboolignore_throttled=15;
122
113
123
114
// If `false`, the request returns an error if it targets a missing or closed index.
124
-
optionalboolignore_unavailable=19;
125
-
126
-
// Indicates whether `hit.matched_queries` should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)
127
-
optionalboolinclude_named_queries_score=20;
128
-
129
-
// If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can only be used when the `q` query string parameter is specified.
130
-
optionalboollenient=21;
115
+
optionalboolignore_unavailable=16;
131
116
132
117
// Defines the number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
133
-
optionalint32max_concurrent_shard_requests=22;
118
+
optionalint32max_concurrent_shard_requests=17;
134
119
135
120
// Indicates whether to return phase-level `took` time values in the response.
136
-
optionalboolphase_took=23;
121
+
optionalboolphase_took=18;
137
122
138
123
// Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: the request targets more than 128 shards; the request targets one or more read-only index; the primary sort of the query targets an indexed field.
139
-
optionalint32pre_filter_shard_size=24;
124
+
optionalint32pre_filter_shard_size=19;
140
125
141
126
// Nodes and shards used for the search. By default, OpenSearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: `_only_local` to run the search only on shards on the local node; `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; `_only_nodes:<node-id>,<node-id>` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; `_prefer_nodes:<node-id>,<node-id>` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; `_shards:<shard>,<shard>` to run the search only on the specified shards; `<custom-string>` (any string that does not start with `_`) to route searches with the same `<custom-string>` to the same shards in the same order.
142
-
optionalstringpreference=25;
127
+
optionalstringpreference=20;
143
128
144
129
// Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing.
145
-
optionalstringq=26;
130
+
optionalstringq=21;
146
131
147
132
// If `true`, the caching of search results is enabled for requests where `size` is `0`. Defaults to index level settings.
148
-
optionalboolrequest_cache=27;
133
+
optionalboolrequest_cache=22;
149
134
150
135
// Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.
151
-
optionalboolrest_total_hits_as_int=28;
136
+
optionalboolrest_total_hits_as_int=23;
152
137
153
138
// A custom value used to route operations to a specific shard.
154
-
repeatedstringrouting=29;
139
+
repeatedstringrouting=24;
155
140
156
141
// Period to retain the search context for scrolling. See Scroll search results. By default, this value cannot exceed `1d` (24 hours). You can change this limit using the `search.max_keep_alive` cluster-level setting.
157
-
optionalstringscroll=30;
142
+
optionalstringscroll=25;
158
143
159
144
// Customizable sequence of processing stages applied to search queries.
160
-
optionalstringsearch_pipeline=31;
145
+
optionalstringsearch_pipeline=26;
161
146
162
147
// How distributed term frequencies are calculated for relevance scoring.
163
-
optionalSearchTypesearch_type=32;
164
-
165
-
// If `true`, returns sequence number and primary term of the last modification of each hit.
166
-
optionalboolseq_no_primary_term=33;
167
-
168
-
// Defines the number of hits to return. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter.
169
-
optionalint32size=34;
170
-
171
-
// A comma-separated list of <field>:<direction> pairs.
172
-
repeatedstringsort=35;
173
-
174
-
// Specific `tag` of the request for logging and statistical purposes.
175
-
repeatedstringstats=36;
176
-
177
-
// A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response.
178
-
repeatedstringstored_fields=37;
148
+
optionalSearchTypesearch_type=27;
179
149
180
150
// Specifies which field to use for suggestions.
181
-
optionalstringsuggest_field=38;
151
+
optionalstringsuggest_field=28;
182
152
183
153
// Specifies the suggest mode. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
184
-
optionalSuggestModesuggest_mode=39;
154
+
optionalSuggestModesuggest_mode=29;
185
155
186
156
// Number of suggestions to return. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
187
-
optionalint32suggest_size=40;
157
+
optionalint32suggest_size=30;
188
158
189
159
// The source text for which the suggestions should be returned. This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified.
190
-
optionalstringsuggest_text=41;
191
-
192
-
// Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting. Use with caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early.
193
-
optionalint32terminate_after=42;
194
-
195
-
// Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error.
196
-
optionalstringtimeout=43;
197
-
198
-
// If `true`, calculate and return document scores, even if the scores are not used for sorting.
199
-
optionalbooltrack_scores=44;
200
-
201
-
// Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.
202
-
optionalTrackHitstrack_total_hits=45;
160
+
optionalstringsuggest_text=31;
203
161
204
162
// If `true`, aggregation and suggester names are be prefixed by their respective types in the response.
205
-
optionalbooltyped_keys=46;
206
-
207
-
// Enables or disables verbose mode for the search pipeline. When verbose mode is enabled, detailed information about each processor in the search pipeline is included in the search response. This includes the processor name, execution status, input, output, and time taken for processing. This parameter is primarily intended for debugging purposes, allowing users to track how data flows and transforms through the search pipeline.
208
-
optionalboolverbose_pipeline=47;
209
-
210
-
// If `true`, returns document version as part of a hit.
211
-
optionalboolversion=48;
163
+
optionalbooltyped_keys=32;
212
164
213
165
// Whether to pretty-format the returned JSON response.
214
-
optionalboolpretty=49;
166
+
optionalboolpretty=33;
215
167
216
168
// Whether to return human-readable values for statistics.
217
-
optionalboolhuman=50;
169
+
optionalboolhuman=34;
218
170
219
171
// Whether to include the stack trace of returned errors.
220
-
optionalboolerror_trace=51;
172
+
optionalboolerror_trace=35;
221
173
222
174
// The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
223
-
optionalstringsource=52;
175
+
optionalstringsource=36;
224
176
225
177
// A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use `-`.
0 commit comments