forked from opensearch-project/opensearch-api-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinsights._common.yaml
228 lines (228 loc) · 8.28 KB
/
insights._common.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
openapi: 3.1.0
info:
title: Schemas of query insights
description: Schemas of query insights
version: 1.0.0
paths: {}
components:
schemas:
TopQueriesResponse:
type: object
properties:
top_queries:
type: array
items:
type: object
$ref: '#/components/schemas/TopQuery'
required:
- top_queries
TopQuery:
type: object
properties:
timestamp:
type: integer
description: The timestamp of the query execution.
total_shards:
type: integer
description: The total number of shards involved in the query.
task_resource_usages:
type: array
items:
type: object
$ref: '#/components/schemas/TaskResourceUsages'
# eslint-disable-next-line @cspell/spellchecker
query_hashcode:
type: string
description: The hash code of the query.
labels:
type: object
description: Additional labels for the query.
search_type:
type: string
description: The search query type (e.g., query_then_fetch).
source:
type: object
$ref: '#/components/schemas/Source'
node_id:
type: string
description: The node ID associated with the query.
indices:
type: array
items:
type: string
description: The indices involved in the query.
phase_latency_map:
type: object
measurements:
type: object
$ref: '#/components/schemas/Measurements'
TaskResourceUsages:
type: object
properties:
action:
type: string
description: The action type of the task.
taskId:
type: integer
description: The task ID.
parentTaskId:
type: integer
description: The parent task ID.
nodeId:
type: string
description: The node ID where the task was executed.
taskResourceUsage:
type: object
$ref: '#/components/schemas/TaskResourceUsage'
TaskResourceUsage:
type: object
properties:
cpu_time_in_nanos:
type: integer
description: The CPU time used in nanoseconds.
memory_in_bytes:
type: integer
description: The memory usage in bytes.
Source:
type: object
properties:
aggregations:
description: Defines the aggregations that are run as part of the search request.
type: object
collapse:
$ref: '_core.search.yaml#/components/schemas/FieldCollapse'
explain:
description: If true, returns detailed information about score computation as part of a hit.
type: boolean
ext:
description: Configuration of search extensions defined by OpenSearch plugins.
type: object
additionalProperties:
type: object
from:
description: |-
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.
type: number
highlight:
$ref: '_core.search.yaml#/components/schemas/Highlight'
track_total_hits:
$ref: '_core.search.yaml#/components/schemas/TrackHits'
indices_boost:
description: Boosts the _score of documents from specified indices.
type: array
items:
type: object
additionalProperties:
type: number
docvalue_fields:
description: |-
Array of wildcard (`*`) patterns.
The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.
type: array
items:
$ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat'
min_score:
description: |-
Minimum `_score` for matching documents.
Documents with a lower `_score` are not included in the search results.
type: number
post_filter:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
profile:
description: |-
Set to `true` to return detailed timing information about the execution of individual components in a search request.
NOTE: This is a debugging tool and adds significant overhead to search execution.
type: boolean
query:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
script_fields:
description: Retrieve a script evaluation (based on different fields) for each hit.
type: object
additionalProperties:
$ref: '_common.yaml#/components/schemas/ScriptField'
search_after:
$ref: '_common.yaml#/components/schemas/SortResults'
size:
description: |-
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.
type: number
slice:
$ref: '_common.yaml#/components/schemas/SlicedScroll'
sort:
$ref: '_common.yaml#/components/schemas/Sort'
_source:
$ref: '_core.search.yaml#/components/schemas/SourceConfig'
fields:
description: |-
Array of wildcard (`*`) patterns.
The request returns values for field names matching these patterns in the `hits.fields` property of the response.
type: array
items:
$ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat'
suggest:
$ref: '_core.search.yaml#/components/schemas/Suggester'
terminate_after:
description: |-
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 indices across multiple data tiers.
If set to `0` (default), the query does not terminate early.
type: integer
format: int32
timeout:
description: |-
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.
Defaults to no timeout.
type: string
track_scores:
description: If true, calculate and return document scores, even if the scores are not used for sorting.
type: boolean
version:
description: If true, returns document version as part of a hit.
type: boolean
seq_no_primary_term:
description: If `true`, returns sequence number and primary term of the last modification of each hit.
type: boolean
stored_fields:
$ref: '_common.yaml#/components/schemas/Fields'
pit:
$ref: '_core.search.yaml#/components/schemas/PointInTimeReference'
stats:
description: |-
Stats groups to associate with the search.
Each group maintains a statistics aggregation for its associated searches.
You can retrieve these stats using the indices stats API.
type: array
items:
type: string
Measurement:
type: object
properties:
number:
type: integer
count:
type: integer
aggregationType:
type: string
Measurements:
type: object
properties:
latency:
type: object
$ref: '#/components/schemas/Measurement'
cpu:
type: object
$ref: '#/components/schemas/Measurement'
memory:
type: object
$ref: '#/components/schemas/Measurement'