From 5af51e6b1502ff6e2b8cd70bff7949994ccf3ba6 Mon Sep 17 00:00:00 2001 From: Jono King Date: Thu, 16 Apr 2026 15:23:29 +1200 Subject: [PATCH] Updating stale info about facet queries ignoring search_cutoff --- docs-site/content/0.24.0/api/search.md | 2 +- docs-site/content/0.24.1/api/search.md | 2 +- docs-site/content/0.25.0/api/search.md | 2 +- docs-site/content/0.25.1/api/search.md | 2 +- docs-site/content/0.25.2/api/search.md | 2 +- docs-site/content/26.0/api/search.md | 2 +- docs-site/content/27.0/api/search.md | 2 +- docs-site/content/27.1/api/search.md | 2 +- docs-site/content/28.0/api/search.md | 2 +- docs-site/content/29.0/api/search.md | 2 +- docs-site/content/30.0/api/search.md | 2 +- docs-site/content/30.1/api/search.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs-site/content/0.24.0/api/search.md b/docs-site/content/0.24.0/api/search.md index 0bfab4ba2..2390e9418 100644 --- a/docs-site/content/0.24.0/api/search.md +++ b/docs-site/content/0.24.0/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

Default: no search cutoff happens. | | max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .

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).

Default: `false` | diff --git a/docs-site/content/0.24.1/api/search.md b/docs-site/content/0.24.1/api/search.md index 6e80ed6b9..108a26ed5 100644 --- a/docs-site/content/0.24.1/api/search.md +++ b/docs-site/content/0.24.1/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

Default: no search cutoff happens. | | max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .

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).

Default: `false` | diff --git a/docs-site/content/0.25.0/api/search.md b/docs-site/content/0.25.0/api/search.md index 526348469..3133ed101 100644 --- a/docs-site/content/0.25.0/api/search.md +++ b/docs-site/content/0.25.0/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

Default: no search cutoff happens. | | max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .

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).

Default: `false` | diff --git a/docs-site/content/0.25.1/api/search.md b/docs-site/content/0.25.1/api/search.md index c3e1714b7..1c70615bc 100644 --- a/docs-site/content/0.25.1/api/search.md +++ b/docs-site/content/0.25.1/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

Default: no search cutoff happens. | | max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .

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).

Default: `false` | diff --git a/docs-site/content/0.25.2/api/search.md b/docs-site/content/0.25.2/api/search.md index 4b1f321f9..827f57601 100644 --- a/docs-site/content/0.25.2/api/search.md +++ b/docs-site/content/0.25.2/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

Default: no search cutoff happens. | | max_candidates | no | Control the number of words that Typesense considers for typo and prefix searching .

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).

Default: `false` | diff --git a/docs-site/content/26.0/api/search.md b/docs-site/content/26.0/api/search.md index 0abcf1f51..678de4d30 100644 --- a/docs-site/content/26.0/api/search.md +++ b/docs-site/content/26.0/api/search.md @@ -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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Typo-Tolerance parameters diff --git a/docs-site/content/27.0/api/search.md b/docs-site/content/27.0/api/search.md index 03bb6ec26..3dacafd83 100644 --- a/docs-site/content/27.0/api/search.md +++ b/docs-site/content/27.0/api/search.md @@ -291,7 +291,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters diff --git a/docs-site/content/27.1/api/search.md b/docs-site/content/27.1/api/search.md index d2aa751b5..61d252abb 100644 --- a/docs-site/content/27.1/api/search.md +++ b/docs-site/content/27.1/api/search.md @@ -306,7 +306,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters diff --git a/docs-site/content/28.0/api/search.md b/docs-site/content/28.0/api/search.md index 81a27c3c7..6dcc487f2 100644 --- a/docs-site/content/28.0/api/search.md +++ b/docs-site/content/28.0/api/search.md @@ -317,7 +317,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters diff --git a/docs-site/content/29.0/api/search.md b/docs-site/content/29.0/api/search.md index 14e1b0851..48f7bfa7e 100644 --- a/docs-site/content/29.0/api/search.md +++ b/docs-site/content/29.0/api/search.md @@ -317,7 +317,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters diff --git a/docs-site/content/30.0/api/search.md b/docs-site/content/30.0/api/search.md index d150302ec..f89a3da3b 100644 --- a/docs-site/content/30.0/api/search.md +++ b/docs-site/content/30.0/api/search.md @@ -322,7 +322,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters diff --git a/docs-site/content/30.1/api/search.md b/docs-site/content/30.1/api/search.md index 2a43d9ce7..83196d4fe 100644 --- a/docs-site/content/30.1/api/search.md +++ b/docs-site/content/30.1/api/search.md @@ -322,7 +322,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.

Default: `true` | | snippet_threshold | no | Field values under this length will be fully highlighted, instead of showing a snippet of relevant portion.

Default: `30` | | limit_hits | no | Maximum number of hits that can be fetched from the collection. Eg: `200`

`page * per_page` should be less than this number for the search request to return results.

Default: no limit

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.

Default: no search cutoff happens. | +| search_cutoff_ms | no | Typesense will attempt to return results early if the cutoff time has elapsed.

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).

Default: `false` | ### Caching parameters