Skip to content

Updating search_cutoff_ms description #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YonoYing wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updating search_cutoff_ms description #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs-site/content/0.24.0/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .<br><br>Default: `4` (or `10000` if `exhaustive_search` is enabled). |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

Expand Down
2 changes: 1 addition & 1 deletion docs-site/content/0.24.1/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .<br><br>Default: `4` (or `10000` if `exhaustive_search` is enabled). |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

Expand Down
2 changes: 1 addition & 1 deletion docs-site/content/0.25.0/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .<br><br>Default: `4` (or `10000` if `exhaustive_search` is enabled). |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

Expand Down
2 changes: 1 addition & 1 deletion docs-site/content/0.25.1/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .<br><br>Default: `4` (or `10000` if `exhaustive_search` is enabled). |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

Expand Down
2 changes: 1 addition & 1 deletion docs-site/content/0.25.2/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .<br><br>Default: `4` (or `10000` if `exhaustive_search` is enabled). |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

Expand Down
2 changes: 1 addition & 1 deletion docs-site/content/26.0/api/search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ When a `string[]` field is queried, the `highlights` structure will include the
| enable_highlight_v1 | no | Flag for disabling the deprecated, old highlight structure in the response.<br><br>Default: `true` |
| snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.<br><br>Default: `30` |
| limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`<br><br>`page * per_page` should be less than this number for the search request to return results.<br><br>Default: no limit<br><br>You'd typically want to generate a scoped API key with this parameter embedded and use that API key to perform the search, so it's automatically applied and can't be changed at search time. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed. This is not a strict guarantee and facet computation is not bound by this parameter.<br><br>Default: no search cutoff happens. |
| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.<br><br>Default: no search cutoff happens. |
| exhaustive_search | no | Setting this to `true` will make Typesense consider all variations of prefixes and typo corrections of the words in the query exhaustively, without stopping early when enough results are found (`drop_tokens_threshold` and `typo_tokens_threshold` configurations are ignored). <br><br>Default: `false` |

### Typo-Tolerance parameters
Expand Down
Loading