You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|_deephits_ <br/>|Overrides the default number of hits that is used as the basis for refinement computation. When refiners are produced, all results for the query will be evaluated. Normally, using this parameter will improve search performance. <br/>**Syntax** <br/>`deephits=<integer value>` <br/>**Example** <br/>`price(deephits=1000)` <br/>**Note:** This limit applies within each index partition. The actual number of hits that are evaluated will be larger than this value due to the aggregation across search partitions. |
96
98
| _discretize_ <br/>| Specifies custom intervals (refinement bins) for numeric refiners. <br/>**Syntax** <br/>`discretize=manual/<threshold>/<threshold>[/<threshold>]*` <br/>**Example** <br/>`write(discretize=manual/2013-01-01/2013-08-22/2013-09-15/2013-09-21/2013-09-22)` <br/>The `<threshold>` attribute specifies the threshold for each refinement bin. <br/>There is one interval for everything below the first threshold specified, one interval between each consecutive threshold, and one interval for everything above the last threshold. <br/>For a refiner of type **DateTime**, specify the threshold according to one of the following ISO 8601-compatible formats: <br/><ul><li><i>YYYY-MM-DD</i></li><li><i>YYYY-MM-DDThh:mm:ss</i></li><li><i>YYYY-MM-DDThh:mm:ss:Z</i></li></ul>The format values specify the following: <ul><li><i>YYYY</i> - Four-digit year. Only four-digit years are supported. </li><li><i>MM</i> - Two-digit month. 01 = January. </li><li><i>DD</i> - Two-digit day of month (01 through 31). </li><li><i>T</i> - The letter "T". </li><li><i>hh</i> - Two-digit hour (00 through 23). A.M. or P.M. indication is not allowed. </li><li><i>mm</i> - Two-digit minute (00 through 59). </li><li><i>ss</i> - Two-digit second (00 through 59). </li></ul>**Important:** All date/time values must be specified according to the Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT) zone. The UTC zone identifier (a trailing "Z" character) is optional. |
97
99
|_sort_ <br/>| Defines how to sort the bins within a string refiner. <br/>**Syntax** <br/>`sort=<property>/<direction>` <br/>The attributes perform the following: <ul><li><i>\<property\></i> - Specifies the sorting algorithm. These lowercase values are valid: <ul><li>**frequency** - Orders by occurrence within the bins. </li><li>**name** - Orders by label name. </li><li>**number** - Treats the strings as numeric and uses numeric sorting. This value can be useful to specify discrete values, for example, to perform numeric sorting of a value that is contained in a managed property of type **String**.</li></ul></li><li><i>\<direction\></i> - Specifies the sorting direction. These lowercase values are valid : <ul><li>**descending** </li><li>**ascending** </li></ul></li></ul>**Example** <br/>`sort=name/ascending` <br/>**Default**: frequency/descending <br/>|
98
-
| _filter_ <br/>| Defines how bins within a refiner of type **String** are filtered before they are returned to the client. <br/>**Syntax** <br/> `filter=<bins>/<freq>/<prefix>[<levels>]` <br/>The attributes perform the following: <ul><li><i>\<bins\></i> - Specifies the maximum number of returned bins. <br/>After sorting the bins within the refiner, use this attribute to truncate any trailing bins. For example, if bins=10, only the first 10 bins are returned, according to the specified sorting algorithm. </li><li><i>\<freq\></i> - Limits the number of returned bins. <br/>Use this attribute to remove bins that have low frequency counts. For example, <i>freq</i>=2 indicates that only the bins with 2 or more members are returned. </li><li><i>\<prefix\></i> - Specifies that only bins with a name that begins with this prefix are returned. <br/>The wildcard character "*" will match all names. <br/>**Example** <br/>`filter=30/2/*` </li><li><i>\<levels\></i> - Specifies the levels of taxonomy. <br/>Use this attribute to filter hierarchical refiner output based on taxonomy levels. The attribute should be a positive integer <i>n</i>. The **default** value is <i>n</i>=0. If <i>n</i>\>0, only refiner entries that contain less than <i>n</i> taxonomy path separator symbols ("/") will be returned. If <i>n</i>=0, no level filtering is performed. The level separator is the forward slash character ("/"). <br/>Be aware of the performance cost of using a large taxonomy navigator. The filtering is performed as part of the result processing. </li></ul>**Note:** This parameter applies application-specific result-side filtering. This differs from the cutoff parameter, which applies limitations in every index partition for performance reasons. |
99
-
| _cutoff_ <br/>| Limits the data that must be transferred and processed for deep string refiners. You can configure the refiners to return only the most relevant values (bins). <br/>**Note:** This cutoff filtering is performed within each index partition. This differs from the _filter_ parameter, which performs result-side filtering only. You can combine the two parameters. <br/>**Syntax** <br/>`cutoff=<frequency>/<minbins>/<maxbins>` <br/>The attributes perform the following: <ul><li><i>\<maxbins\></i> - Limits the number of bins. <br/>This parameter limits the number of unique values (bins) that will be returned for a refiner. It is the preferred way to increase search performance when string refiners with large number of bins are returned. "0" implies that the default value specified in the search schema is used. </li><li><i>\<frequency\></i> - Limits the number of bins by frequency. <br/>If the number of occurrences of a refiner value in a result set is less than or equal to the frequency value, the refiner value is not returned. "0" implies that the default value according to the search schema is used. </li><li><i>\<minbins\></i> - Specifies the minimum value for frequency cutoff. <br/>If the number of unique refiner values for the query is less than this value, no frequency cutoff is performed, and all refiner values are returned from that search partition. When cutoff by frequency is used, this parameter can be used to specify a minimum number of unique refiner values that will be returned regardless of the number of occurrences. The default value of this attribute is "0", indicating that frequency cutoff is performed regardless of the number of unique navigator values. "0" implies that the default value specified in the index schema is used. </li></ul>**Note:** Use _<frequency>_ and _<minbins>_ with care. We recommend that you use only _<maxbins>_. |
100
+
| _filter_ <br/>| Defines how bins within a refiner of type **String** are filtered before they are returned to the client. <br/>**Syntax** <br/> `filter=<bins>/<freq>/<prefix>[<levels>]` <br/>The attributes perform the following: <ul><li><i>\<bins\></i> - Specifies the maximum number of returned bins. <br/>After sorting the bins within the refiner, use this attribute to truncate any trailing bins. For example, if bins=10, only the first 10 bins are returned, according to the specified sorting algorithm. </li><li><i>\<freq\></i> - Limits the number of returned bins. <br/>Use this attribute to remove bins that have low frequency counts. For example, <i>freq</i>=2 indicates that only the bins with 2 or more members are returned. </li><li><i>\<prefix\></i> - Specifies that only bins with a name that begins with this prefix are returned. <br/>The wildcard character "\*" will match all names. <br/>**Example** <br/>`filter=30/2/*` </li><li><i>\<levels\></i> - Specifies the levels of taxonomy. <br/>Use this attribute to filter hierarchical refiner output based on taxonomy levels. The attribute should be a positive integer <i>n</i>. The **default** value is <i>n</i>=0. If <i>n</i>\>0, only refiner entries that contain less than <i>n</i> taxonomy path separator symbols ("/") will be returned. If <i>n</i>=0, no level filtering is performed. The level separator is the forward slash character ("/"). <br/>Be aware of the performance cost of using a large taxonomy navigator. The filtering is performed as part of the result processing. </li></ul>**Note:** This parameter applies application-specific result-side filtering. This differs from the cutoff parameter, which applies limitations in every index partition for performance reasons. |
101
+
| _cutoff_ <br/>| Limits the data that must be transferred and processed for deep string refiners. You can configure the refiners to return only the most relevant values (bins). <br/>**Note:** This cutoff filtering is performed within each index partition. This differs from the _filter_ parameter, which performs result-side filtering only. You can combine the two parameters. <br/>**Syntax** <br/>`cutoff=<frequency>/<minbins>/<maxbins>` <br/>The attributes perform the following: <ul><li><i>\<maxbins\></i> - Limits the number of bins. <br/>This parameter limits the number of unique values (bins) that will be returned for a refiner. It is the preferred way to increase search performance when string refiners with large number of bins are returned. "0" implies that the default value specified in the search schema is used. </li><li><i>\<frequency\></i> - Limits the number of bins by frequency. <br/>If the number of occurrences of a refiner value in a result set is less than or equal to the frequency value, the refiner value is not returned. "0" implies that the default value according to the search schema is used. </li><li><i>\<minbins\></i> - Specifies the minimum value for frequency cutoff. <br/>If the number of unique refiner values for the query is less than this value, no frequency cutoff is performed, and all refiner values are returned from that search partition. When cutoff by frequency is used, this parameter can be used to specify a minimum number of unique refiner values that will be returned regardless of the number of occurrences. The default value of this attribute is "0", indicating that frequency cutoff is performed regardless of the number of unique navigator values. "0" implies that the default value specified in the index schema is used. </li></ul>**Note:** Use _\<frequency\>_ and _\<minbins\>_ with care. We recommend that you use only _\<maxbins\>_. |
0 commit comments