This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
Search API — Add facetStats description
#224
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Feb 23, 2023
Merged
gmourier
force-pushed
the
facet-stats-min-max
branch
from
c23d73b
to
1d0b291
Compare
gmourier
added
OpenAPI
|
🤖 API change detected: Modified (2)
|
dureuill
reviewed
Feb 23, 2023
Co-authored-by: Louis Dureuil <[email protected]>
dureuill
approved these changes
Feb 27, 2023
bidoubiwa
reviewed
Feb 28, 2023
3 tasks
This was referenced Mar 15, 2023
meili-bors bot
added a commit
to meilisearch/meilisearch-js
that referenced
this pull request
Mar 15, 2023
1458: Add multi search method of Meilisearch v1.1 r=bidoubiwa a=bidoubiwa Introduces the `client.multiSearch()` method as per the [specifications](meilisearch/specifications#225) SDK requirements: meilisearch/integration-guides#251 1459: Add facetStats type in searchResponse for MS v1.1.0 r=bidoubiwa a=bidoubiwa As per [the specification](meilisearch/specifications#224) SDK requirements: meilisearch/integration-guides#251 A new response field, `facetStats` is returned when `facets` is used in the search parameters. It contains the min max value of facets that contain numeric values. I added some test `@brunoocasali` to ensure my typing is correct Co-authored-by: cvermand <[email protected]> Co-authored-by: Charlotte Vermandel <[email protected]>
meili-bors bot
added a commit
to meilisearch/meilisearch-js
that referenced
this pull request
Mar 15, 2023
1459: Add facetStats type in searchResponse for MS v1.1.0 r=bidoubiwa a=bidoubiwa As per [the specification](meilisearch/specifications#224) SDK requirements: meilisearch/integration-guides#251 A new response field, `facetStats` is returned when `facets` is used in the search parameters. It contains the min max value of facets that contain numeric values. I added some test `@brunoocasali` to ensure my typing is correct Co-authored-by: Charlotte Vermandel <[email protected]>
This was referenced Mar 22, 2023
gmourier
added a commit
that referenced
this pull request
Apr 3, 2023
* Bump API version * Metrics API — Introduce a `/metrics` route for observability / monitoring purposes (#174) * init spec for /metrics * Rename spec filename and add description for metrics * update metrics name and type col in the metrics table; add auth errors * Add --enable-metrics-route to instance-options.md specification * Precise metrics * update open-api.yml * Add telemetry instance property * Mention metrics route on stats.get action * Add action * Precise action description * Rephrase future possibility * Add MEILI_ENABLE_METRICS_ROUTE * rename all the cli parameter to the experimental variant * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <[email protected]> * Update open-api.yaml Co-authored-by: Guillaume Mourier <[email protected]> * Update text/0085-api-keys.md Co-authored-by: Guillaume Mourier <[email protected]> * Apply suggestions from code review Co-authored-by: Tamo <[email protected]> --------- Co-authored-by: Tamo <[email protected]> * API Keys - Introduce `*` wildcard char at the last position to express access to multiple indexes starting with the same string (#189) * Bump open-api spec * Precise that the * wildcard char can be used at the last position to match multiple indexes starting with the same string * Update future possibilities * Update the index wildcard pattern error message --------- Co-authored-by: Clément Renault <[email protected]> * Documents API — Support a csv delimiter customization (#221) * specify the support of the csv-delimiter * Apply suggestions from code review * get rid of the last 'future possibility' that is being described in this PR * Update openAPI specification --------- Co-authored-by: Guillaume Mourier <[email protected]> * Update the geo-search spec to mention the fact that null is a valid geo field (#222) * GeoSearch — Add the `_geoBoundingBox` built-in filter (#223) * Add geoBoundingBox built-in filter description * Add missing parts * Update text/0059-geo-search.md Co-authored-by: Tamo <[email protected]> * Replace the top left / bottom right signature to a top right / bottom left signature --------- Co-authored-by: Tamo <[email protected]> * Search API — Add `facetStats` description (#224) * update search-api.md * rephrase * update open-api.yml * rephrase, add example on open-api.yml * Add examples * fix * Update text/0118-search-api.md Co-authored-by: Louis Dureuil <[email protected]> * rephrase * Clarify that facet stats are for all search results --------- Co-authored-by: Louis Dureuil <[email protected]> * Multi Search API (#225) * Add multi-search spec * Change possible HTTP return codes for index_not_found * Add multi-search to openAPI * Update telemetry * openAPI: shorter summary for multi-search * openAPI: attempt to remove superfluous "values" field in multisearch request/response * Apply review suggestions for openAPI Co-authored-by: Guillaume Mourier <[email protected]> * Apply review suggestions for multi search API Co-authored-by: Guillaume Mourier <[email protected]> * Add queries/results keys to openAPI examples Co-authored-by: Guillaume Mourier <[email protected]> * fix indent * Apply review suggestions for multi search API Co-authored-by: cvermand <[email protected]> * OpenAPI: Change summary to `Multi Search` * use backticks instead of ticks in multi search API example * Apply review suggestions for multi search API Co-authored-by: Maryam <[email protected]> * remove superfluous newline from telemetry file Co-authored-by: Guillaume Mourier <[email protected]> --------- Co-authored-by: Guillaume Mourier <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Maryam <[email protected]> * Add small blurb on index count / max size (#226) --------- Co-authored-by: Tamo <[email protected]> Co-authored-by: Clément Renault <[email protected]> Co-authored-by: Louis Dureuil <[email protected]> Co-authored-by: cvermand <[email protected]> Co-authored-by: Maryam <[email protected]>
This was referenced Apr 27, 2023
Closed
Closed
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤖 API Diff
Summary
When using the
facetsparameter, the distributed facets that contain some numeric values are displayed in afacetStatsobject that contains, per facet, the numericminandmaxvalues of the hits returned by the search query.If none of the hits returned by the search query have a numeric value for a facet, this facet is not part of the
facetStatsobject.meilisearch/meilisearch#3426
Changes
facetStatssearch response object.facetStatssearch response object.Out Of Scope
Explain in clear way subjects that are out of scope and shouldn't be discussed by the reviewers
Attention To Reviewers
Explain clearly what reviewers should specifically look for to facilitate the review phase. Also, mention the sections that will not necessarily be taken into account if reviewed.
Misc
OpenApilabel)Telemetrylabel)