[v1.3] Search in facet values `facetSearch`
brunoocasali opened this issue · 0 comments
Also, if you are a maintainer, please add any clarification and instructions about this issue.
Sorry if this is already wholly/partially implemented. Feel free to let me know about the state of this issue in the repo.
Related to meilisearch/integration-guides#280
This issue is divided into two sections, first, you need to make the implementation, and second, you must update the code-samples (no one likes outdated docs, right?).
New implementation
Related to:
- issue: meilisearch/meilisearch#3611
- discussion: meilisearch/product#515 (comment)
- spec: meilisearch/specifications#246
Users of bigger datasets could have difficulty interacting with vast lists of facets data since, until today, it was not possible to search on them.
To introduce this feature into the SDKs, we must:
Create a new method called facetSearch(facetSearchQuery)
/facet_search(facetSearchQuery)
Besides all the other parameters that a regular SearchQuery
can take. The new FacetSearchQuery
can take a facetName
, facetQuery
, filter
, q
, matchingStrategy
.
Params definition:
facetName:
type: string
required: true
example: '"genres"'
facetQuery:
type: string
example: '"Horror"'
q:
type: string
default: '""'
example: '"Back to the future"'
matchingStrategy:
type: string
default: 'last'
filter: // https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering
type: array
example: '"groupId = 1 AND genre = adventure"'
Code samples
Inside of this file: .code-samples.meilisearch.yml
:
-
Create a new entry with this key
facet_search_1
containing a call to the newfacetSearch
method.
Refer to this curl example and translate it by using the Rust methods: https://github.com/meilisearch/documentation/blob/e4fdc3d485c22e31a045b8a71bacf18b6a7d50e0/.code-samples.meilisearch.yaml#L1069 -
Add new code sample
facet_search_3
with this content:
Refer to this curl example and translate it by using the Rust methods: https://github.com/meilisearch/documentation/blob/e4fdc3d485c22e31a045b8a71bacf18b6a7d50e0/.code-samples.meilisearch.yaml#L1087
TODO:
- Add the new method
facetSearch
- Update the code-samples accordingly
- Add integration tests