Understanding Search Result Object Fields

TLDR David had queries regarding various search object fields, such as `out_of`, `found` and `found_docs`. Kishore Nallan provided explanations for each field.

Photo of David
David
Sat, 16 Sep 2023 15:28:54 UTC

is there a reference for all the fields in the search result object and what they mean - like what does "out_of" mean?

Photo of David
David
Sat, 16 Sep 2023 15:30:22 UTC

I'm pretty sure this field has a different meaning when I have group_by enabled, right? `out_of` with `group_by` would tell me how many groups are found, as opposed to `found` and `found_docs` - and without `group_by` enabled then `out_of` replaces `found_docs` since they're giving the same info... is that right?

Photo of David
David
Sat, 16 Sep 2023 15:30:43 UTC

and `found` is the total found so far including previous pages?

Photo of David
David
Sat, 16 Sep 2023 15:33:37 UTC

it does not appear that `found_docs` is included in the SearchResponse interface in the js client

Photo of Kishore Nallan
Kishore Nallan
Sun, 17 Sep 2023 15:06:16 UTC

• out_of: total number of docs in collection. In the case of group_by queries, this will be total groups, yes • `found` is the groups found satisfying the search query • `found_docs` was added recently. It's the individual (non-grouped) docs found.