diff --git a/docs-site/content/0.24.0/api/search.md b/docs-site/content/0.24.0/api/search.md index 0bfab4ba..2390e941 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 6e80ed6b..108a26ed 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 52634846..3133ed10 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 c3e1714b..1c70615b 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 4b1f321f..827f5760 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 0abcf1f5..678de4d3 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 03bb6ec2..3dacafd8 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 d2aa751b..61d252ab 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 81a27c3c..6dcc487f 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 14e1b085..48f7bfa7 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 d150302e..f89a3da3 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 2a43d9ce..83196d4f 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