forked from opensearch-project/opensearch-api-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_core.msearch.yaml
186 lines (186 loc) · 7.01 KB
/
_core.msearch.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
openapi: 3.1.0
info:
title: Schemas of _core.msearch category
description: Schemas of _core.msearch category
version: 1.0.0
paths: {}
components:
schemas:
RequestItem:
oneOf:
- $ref: '#/components/schemas/MultisearchHeader'
- $ref: '#/components/schemas/MultisearchBody'
MultisearchHeader:
type: object
properties:
allow_no_indices:
type: boolean
expand_wildcards:
$ref: '_common.yaml#/components/schemas/ExpandWildcards'
ignore_unavailable:
type: boolean
index:
$ref: '_common.yaml#/components/schemas/Indices'
preference:
type: string
request_cache:
type: boolean
routing:
$ref: '_common.yaml#/components/schemas/Routing'
search_type:
$ref: '_common.yaml#/components/schemas/SearchType'
ccs_minimize_roundtrips:
type: boolean
allow_partial_search_results:
type: boolean
ignore_throttled:
type: boolean
MultisearchBody:
type: object
properties:
aggregations:
type: object
additionalProperties:
$ref: '_common.aggregations.yaml#/components/schemas/AggregationContainer'
collapse:
$ref: '_core.search.yaml#/components/schemas/FieldCollapse'
query:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
explain:
description: When `true`, returns detailed information about score computation as part of a hit.
type: boolean
ext:
description: The configuration of search extensions defined by OpenSearch plugins.
type: object
additionalProperties:
type: object
stored_fields:
$ref: '_common.yaml#/components/schemas/Fields'
docvalue_fields:
description: |-
An array of wildcard (*) patterns. The request returns document 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'
knn:
description: Defines the approximate kNN search to run.
oneOf:
- $ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery'
- type: array
items:
$ref: '_common.query_dsl.yaml#/components/schemas/KnnQuery'
from:
description: |-
The starting document offset. By default, you cannot page through more than 10,000
hits using the `from` and `size` parameters. To page through more than 10,000 hits, use the
`search_after` parameter.
type: number
highlight:
$ref: '_core.search.yaml#/components/schemas/Highlight'
indices_boost:
description: Boosts the `_score` of documents from the specified indexes.
type: array
items:
type: object
additionalProperties:
type: number
min_score:
description: |-
The minimum `_score` for document matching. Documents with a lower `_score` than the minimum
are not included in the search results.
type: number
post_filter:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
profile:
type: boolean
rescore:
oneOf:
- $ref: '_core.search.yaml#/components/schemas/Rescore'
- type: array
items:
$ref: '_core.search.yaml#/components/schemas/Rescore'
script_fields:
description: Retrieves 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
sort:
$ref: '_common.yaml#/components/schemas/Sort'
_source:
$ref: '_core.search.yaml#/components/schemas/SourceConfig'
fields:
description: |-
An 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'
terminate_after:
description: |-
The maximum number of documents to collect for each shard. If a query reaches this
limit, OpenSearch stops the query early. OpenSearch collects documents
before sorting. Default is `0`, which does not terminate query execution early.
type: number
stats:
description: |-
The statistics groups to associate with the search. Each group maintains a statistics
aggregation for its associated searches. You can retrieve these statistics using
the Index Stats API.
type: array
items:
type: string
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.
Default is no timeout.
type: string
track_scores:
description: When `true`, calculates and returns all document scores, even if the scores are not used for sorting.
type: boolean
track_total_hits:
$ref: '_core.search.yaml#/components/schemas/TrackHits'
version:
description: When `true`, returns the document version as part of the hit.
type: boolean
seq_no_primary_term:
description: |-
When `true`, returns the sequence number and primary term of the last modification.
of each hit. See Optimistic concurrency control.
type: boolean
pit:
$ref: '_core.search.yaml#/components/schemas/PointInTimeReference'
suggest:
$ref: '_core.search.yaml#/components/schemas/Suggester'
ResponseItem:
oneOf:
- $ref: '#/components/schemas/MultiSearchItem'
- $ref: '_common.yaml#/components/schemas/ErrorResponseBase'
MultiSearchItem:
allOf:
- $ref: '_core.search.yaml#/components/schemas/ResponseBody'
- type: object
properties:
status:
type: number
MultiSearchResult:
type: object
properties:
took:
type: number
responses:
type: array
items:
$ref: '#/components/schemas/ResponseItem'
required:
- responses
- took