Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs-site/content/30.0/api/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| facet_return_parent | no | Pass a comma separated string of nested facet fields whose parent object should be returned in facet response. For e.g. when you set this to `"color.name"`, this will return the parent `color` object as parent property in the facet response.Dynamic fields can be passed using wildcards like `"product.color.*"` which will return parent for all facets like `"product.color.red"`, `"product.color.blue"`. Pure wildcard are also supported like `facet_return_parent=*` which will return parent object of all found facet fields. |
| facet_sample_percent | no | Percentage of hits that will be used to estimate facet counts. <br><br>Facet sampling is helpful to improve facet computation speed for large datasets, where the exact count is not required in the UI.<br><br>Default: `100` (sampling is disabled by default). |
| facet_sample_threshold | no | Minimum number of hits above which the facet counts are sampled. <br><br>Facet sampling is helpful to improve facet computation speed for large datasets, where the exact count is not required in the UI.<br><br>Default: `0`. |
| facet_sample_slope | no | Controls how steeply we want the `facet_sample_percent` to fall as the collection grows. Useful to make `facet_sample_percent` dynamic as per collection size. If the collection grows beyond facet_sample_threshold, the percentage slides downward on a straight-line “slope”.<br><br>`facet_sample_threshold` should be non-zero for `facet_sample_slope` to be effective.
<br><br>Default: `0`. |
| facet_sample_slope | no | Controls how steeply we want the `facet_sample_percent` to fall as the collection grows. Useful to make `facet_sample_percent` dynamic as per collection size. If the collection grows beyond facet_sample_threshold, the percentage slides downward on a straight-line “slope”.<br><br>`facet_sample_threshold` should be non-zero for `facet_sample_slope` to be effective.<br><br>Default: `0`. |
| validate_field_names | no | Controls whether Typesense should validate if the faceted fields exist in the schema. When set to false, Typesense will not throw an error if a faceted field is missing. This is useful for programmatic faceting where not all facets may exist. <br><br>Default: `true`. |


Expand All @@ -305,7 +304,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| group_limit | no | Maximum number of hits to be returned for every group. If the `group_limit` is set as `K` then only the top K hits in each group are returned in the response.<br><br>Default: `3` |
| group_missing_values | no | Setting this parameter to `true` will place all documents that have a `null` value in the `group_by` field, into a single group. Setting this parameter to `false`, will cause each document with a `null` value in the `group_by` field to not be grouped with other documents. <br><br>Default: `true` |
| validate_field_names | no | Controls whether Typesense should validate if the grouped fields exist in the schema. When set to false, Typesense will not throw an error if a grouped field is missing. This is useful for programmatic grouping where not all fields may exist. <br><br>Default: `true` |
| group_max_candidates | no | Overrides the behavior of `group_by` queries introduced in [v29.0](https://typesense.org/docs/29.0/api/#deprecations-behavior-changes) where `found` value is an approximation. When `group_max_candidates` is passed, `found` will be accurate up until its value.
| group_max_candidates | no | Overrides the behavior of `group_by` queries introduced in [v29.0](https://typesense.org/docs/29.0/api/#deprecations-behavior-changes) where `found` value is an approximation. When `group_max_candidates` is passed, `found` will be accurate up until its value. <br><br>Default: `250`

### Results parameters

Expand Down