Added missing distinct param in search parameters overview
#3073
Conversation
Added missing `distinct` param in search parameters overview table in `reference/api/search.mdx` file Things to check: 1. Should the default value be `null` string or `""` empty string? 2. If the description is technically correct? Closes meilisearch#3029
There was a problem hiding this comment.
Hello, @RecreationalMath! Thanks for the contribution!
A few comments:
- The default value of
/search'sdistinctisnull, as indicated in the section you're linking to: https://www.meilisearch.com/docs/reference/api/search#distinct-attributes-at-search-time - I'm afraid you have misunderstood what
distinctdoes.distincttells Meilisearch that all documents sharing the samedistinctvalue are functionally the same document. Imagine a webshop where 5 documents represent the same shirt, but in different colours. You can usedistinctso when people search for shirt they don't see the same shirt repeated several times in the search results.
If you need more info, take a look at the distinct search parameter, or the general explanation of distinct attributes.
|
Thanks for sharing the explanation of distinct attributes. Option 1: Attribute whose value must be unique in the returned documents @guimachiavelli Let me know which one suits better for the short description? |
|
I option 2 might work. What's your opinion? Are you afraid it might be hard to understand? |
|
I think It is comprehensible, especially when you look at it in conjunction with the section dedicated to its explanation on the same page |
|
I find it hard to pinpoint precisely why, but I do think that the "document with" bit makes the sentence a bit clearer. Let's go with that! |
Fixes #3029
Added missing
distinctparam in search parameters overview table inreference/api/search.mdxfileThings to check:
distinctparameter benullor""empty string?limit search to return one (most relevant) document per each value of specified attribute