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
{{ message }}
This repository was archived by the owner on Mar 21, 2024. It is now read-only.
Search API - Remove/Rename confusing fields (#135)
* Rename nbHits, remove exhaustive* boolean fields
* Rename approximativeNbHits to estimatedTotalHits
* Update open-api.yaml
* Apply naming changes for facet distribution and showing matches position
* Add a telemetry for facet distribution usage
Copy file name to clipboardExpand all lines: open-api.yaml
+29-38Lines changed: 29 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,7 @@ components:
86
86
overview: 'When a scientists daughter is kidnapped, American Ninja, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the ninja.'
87
87
release_date: '1993-01-01'
88
88
description: 'A document made of attribute. The maximum number of attribute for a document is 65,535.'
overview: 'When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.'
overview: 'When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.'
133
133
release_date: '1993-01-01'
134
-
_matchesInfo:
134
+
_matchesPosition:
135
135
overview:
136
136
- start: 49
137
137
length: 5
@@ -143,12 +143,12 @@ components:
143
143
type: object
144
144
description: Only present if `attributesToHighlight`/`attributesToCrop` is not empty. Return highlighted and cropped fields.
145
145
additionalProperties: true
146
-
_matchesInfo:
146
+
_matchesPosition:
147
147
type: object
148
-
description: Only present if matches = `true`. Array of all search query occurrences in all fields.
148
+
description: Only present if showMatchesPosition = `true`. Array of all search query occurrences in all fields.
149
149
properties:
150
150
'':
151
-
$ref: '#/components/schemas/matchesInfo'
151
+
$ref: '#/components/schemas/matchesPosition'
152
152
attribute:
153
153
type:
154
154
- string
@@ -228,20 +228,17 @@ components:
228
228
limit:
229
229
type: integer
230
230
description: Number of returned documents.
231
-
nbHits:
231
+
estimatedTotalHits:
232
232
type: integer
233
-
description: Total number of candidates for this search in the database.
234
-
exhaustiveNbHits:
235
-
type: boolean
236
-
description: Whether `nbHits` is exhaustive.
237
-
facetsDistribution:
233
+
description: Estimated number of candidates for the search query.
234
+
facetDistribution:
238
235
type: object
239
236
additionalProperties:
240
237
type: object
241
238
additionalProperties:
242
239
type: integer
243
240
description: |
244
-
[Distribution of the given facets](https://docs.meilisearch.com/reference/features/search_parameters.html#facets-distribution).
241
+
[Distribution of the given facets](https://docs.meilisearch.com/reference/features/search_parameters.html#facet-distribution).
245
242
example:
246
243
genres:
247
244
action: 273
@@ -251,9 +248,6 @@ components:
251
248
comedy: 475
252
249
mystery: 70
253
250
thriller: 217
254
-
exhaustiveFacetsCount:
255
-
type: boolean
256
-
description: Whether `facetsDistribution` is exhaustive.
257
251
processingTimeMs:
258
252
type: integer
259
253
description: Processing time of the query.
@@ -265,8 +259,7 @@ components:
265
259
- hits
266
260
- offset
267
261
- limit
268
-
- nbHits
269
-
- exhaustiveNbHits
262
+
- estimatedTotalHits
270
263
- processingTimeMs
271
264
- query
272
265
task:
@@ -769,21 +762,21 @@ components:
769
762
example: 5
770
763
default: 10
771
764
description: Sets the total number of words to keep around the matched part of an attribute specified in the `attributesToCrop` parameter.
772
-
facetsDistribution:
773
-
name: facetsDistribution
765
+
facets:
766
+
name: facets
774
767
in: query
775
768
schema:
776
769
type: string
777
770
example: 'genres,author'
778
-
description: 'Comma-separated list of attributes whose fields will be distributed as a facet. If you have [set up filterableAttributes](https://docs.meilisearch.com/reference/features/settings.html#filterable-attributes), you can retrieve the count of matching terms for each facets.[Learn more about facet distribution in the dedicated guide](https://docs.meilisearch.com/reference/features/search_parameters.html#facets-distribution)'
779
-
matches:
780
-
name: matches
771
+
description: 'Comma-separated list of attributes whose fields will be distributed as a facet. If you have [set up filterableAttributes](https://docs.meilisearch.com/reference/features/settings.html#filterable-attributes), you can retrieve the count of matching terms for each facets.[Learn more about facet distribution in the dedicated guide](https://docs.meilisearch.com/reference/features/search_parameters.html#facet-distribution)'
772
+
showMatchesPosition:
773
+
name: showMatchesPosition
781
774
in: query
782
775
required: false
783
776
schema:
784
777
type: boolean
785
778
default: 'false'
786
-
description: Defines whether an `_matchesInfo` object that contains information about the matches should be returned or not.
779
+
description: Defines whether an `_matchesPosition` object that contains information about the matches should be returned or not.
overview: 'When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.'
1462
1455
release_date: '1993-01-01'
1463
-
_matchesInfo:
1456
+
_matchesPosition:
1464
1457
overview:
1465
1458
- start: 49
1466
1459
length: 5
1467
1460
- start: 155
1468
1461
length: 5
1469
1462
limit: 0
1470
1463
offset: 0
1471
-
nbHits: 0
1464
+
estimatedTotalHits: 0
1472
1465
query: string
1473
-
exhaustiveNbHits: true
1474
1466
processingTimeMs: 0
1475
1467
'401':
1476
1468
$ref: '#/components/responses/401'
@@ -1539,15 +1531,15 @@ paths:
1539
1531
type: number
1540
1532
description: Sets the total number of **words** to keep for the cropped part of an attribute specified in the `attributesToCrop` parameter.
1541
1533
default: 10
1542
-
matches:
1534
+
showMatchesPosition:
1543
1535
type: boolean
1544
-
description: Defines whether an `_matchesInfo` object that contains information about the matches should be returned or not.
1536
+
description: Defines whether an `_matchesPosition` object that contains information about the matches should be returned or not.
1545
1537
default: false
1546
1538
filter:
1547
1539
$ref: '#/components/schemas/filter'
1548
-
facetsDistribution:
1540
+
facets:
1549
1541
type: array
1550
-
description: 'Array of attributes whose fields will be distributed as a facet. If you have [set up filterableAttributes](https://docs.meilisearch.com/reference/features/settings.html#filterable-attributes), you can retrieve the count of matching terms for each [facets](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#faceted-search).[Learn more about facet distribution in the dedicated guide](https://docs.meilisearch.com/reference/features/search_parameters.html#facets-distribution)'
1542
+
description: 'Array of attributes whose fields will be distributed as a facet. If you have [set up filterableAttributes](https://docs.meilisearch.com/reference/features/settings.html#filterable-attributes), you can retrieve the count of matching terms for each [facets](https://docs.meilisearch.com/reference/features/filtering_and_faceted_search.html#faceted-search).[Learn more about facet distribution in the dedicated guide](https://docs.meilisearch.com/reference/features/search_parameters.html#facet-distribution)'
1551
1543
items:
1552
1544
type: string
1553
1545
example: '["genres", "author"]'
@@ -1569,7 +1561,7 @@ paths:
1569
1561
offset: 0
1570
1562
limit: 20
1571
1563
filter: (genres = Horror AND genres = Mystery) OR release_date > 523242000
overview: 'When a scientists daughter is kidnapped, American <em>Ninja</em>, attempts to find her, but this time he teams up with a youngster he has trained in the ways of the <em>ninja</em>.'
Copy file name to clipboardExpand all lines: text/0034-telemetry-policies.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,6 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
35
35
36
36
[Amplitude](https://amplitude.com/) is a tool for graphing and highlighting collected data. Segment feeds Amplitude so that we can build visualizations according to our needs.
37
37
38
-
39
38
----
40
39
41
40
#### Events table
@@ -113,7 +112,8 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
113
112
|`formatting.highlight_post_tag`|`true` if `highlightPostTag` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
114
113
|`formatting.crop_length`|`true` if `cropLength` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
115
114
|`formatting.crop_marker`|`true` if `cropMarker` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
116
-
|`formatting.matches`|`true` if `matches` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
115
+
|`formatting.show_matches_position`|`true` if `showMatchesPosition` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
116
+
|`facets`|`true` if `facets` was used in this batch, otherwise `false`| false |`Documents Searched POST`, `Documents Searched GET`|
117
117
|`primary_key`| Value given for the `primaryKey` parameter if used, otherwise `null`| id |`Index Created`, `Index Updated`, `Documents Added`, `Documents Updated`|
118
118
|`payload_type`| All `payload_type` encountered in this batch |["application/json", "text/plain", "application/x-ndjson"]|`Documents Added`, `Documents Updated`|
119
119
|`index_creation`|`true` if a document addition or update request triggered index creation in this batch, otherwise `false`| true |`Documents Added`, `Documents Updated`|
@@ -133,7 +133,6 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
133
133
|`filtered_by_type`|`true` if `GET /tasks` endpoint is filered by `type`, otherwise `false`| false |`Tasks Seen`|
134
134
|`filtered_by_status`|`true` if `GET /tasks` endpoint is filered by `status`, otherwise `false`| false |`Tasks Seen`|
135
135
136
-
137
136
----
138
137
139
138
#### Detailed list of Instance metrics and, events with their metrics
@@ -218,7 +217,8 @@ This property allows us to gather essential information to better understand on
218
217
| formatting.highlight_post_tag | Does `highlightPostTag` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
219
218
| formatting.crop_length | Does `cropLength` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
220
219
| formatting.crop_marker | Does `cropMarker` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
221
-
| formatting.matches | Does `matches` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
220
+
| formatting.show_matches_position | Does `showMatchesPosition` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
221
+
| facets | Does `facets` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
222
222
223
223
---
224
224
@@ -245,7 +245,8 @@ This property allows us to gather essential information to better understand on
245
245
| formatting.highlight_post_tag | Does `highlightPostTag` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
246
246
| formatting.crop_length | Does `cropLength` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
247
247
| formatting.crop_marker | Does `cropMarker` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
248
-
| formatting.matches | Does `matches` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
248
+
| formatting.show_matches_position | Does `showMatchesPosition` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
249
+
| facets | Does `facets` has been used in the aggregated event? If yes, `true` otherwise `false`|`false`|
249
250
250
251
---
251
252
@@ -347,7 +348,6 @@ This property allows us to gather essential information to better understand on
347
348
| user_agent | Represents the user-agent encountered on this call. |`["Meilisearch Ruby (v2.1)", "Ruby (3.0)"]`|
348
349
| searchable_attributes.total | Number of searchable attributes. |`3`|
0 commit comments