docs(atomic,headless): update filter facet count documentation (#4980)

[DOC-15519](https://coveord.atlassian.net/browse/DOC-15519)

Based on the discussion in DOC-15519, a note was added to the
filterFacetCount field to caution that the number shown was only an
estimate and could display incorrect values. Occurrences of the field
have been updated in both Headless and Atomic.


[DOC-15519]:
https://coveord.atlassian.net/browse/DOC-15519?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: GitHub Actions Bot <>

packages/atomic/src/components.d.ts

@@ -149,7 +149,7 @@ export namespace Components {
          */
         "filterByBasePath": boolean;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -237,7 +237,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -856,7 +856,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -1165,7 +1165,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -1331,7 +1331,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -1613,7 +1613,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -1916,7 +1916,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -2426,7 +2426,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -2489,7 +2489,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -3499,7 +3499,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -3776,7 +3776,7 @@ export namespace Components {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount": boolean;
         /**
@@ -6378,7 +6378,7 @@ declare namespace LocalJSX {
          */
         "filterByBasePath"?: boolean;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -6466,7 +6466,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -7053,7 +7053,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -7361,7 +7361,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -7511,7 +7511,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -7781,7 +7781,7 @@ declare namespace LocalJSX {
          */
         "field"?: string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -8071,7 +8071,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -8567,7 +8567,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -8630,7 +8630,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -9587,7 +9587,7 @@ declare namespace LocalJSX {
          */
         "field": string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**
@@ -9874,7 +9874,7 @@ declare namespace LocalJSX {
          */
         "field"?: string;
         /**
-          * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+          * Whether to exclude the parents of folded results when estimating the result count for each facet value.   Note: Resulting count is only an estimation, in some cases this value could be incorrect.
          */
         "filterFacetCount"?: boolean;
         /**

packages/atomic/src/components/insight/atomic-insight-facet/atomic-insight-facet.tsx

@@ -111,6 +111,9 @@ export class AtomicInsightFacet
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/insight/atomic-insight-numeric-facet/atomic-insight-numeric-facet.tsx

@@ -131,6 +131,9 @@ export class AtomicInsightNumericFacet
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/insight/atomic-insight-timeframe-facet/atomic-insight-timeframe-facet.tsx

@@ -91,6 +91,9 @@ export class AtomicInsightTimeframeFacet
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-category-facet/atomic-category-facet.tsx

@@ -213,6 +213,9 @@ export class AtomicCategoryFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-color-facet/atomic-color-facet.tsx

@@ -192,6 +192,9 @@ export class AtomicColorFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-facet/atomic-facet.tsx

@@ -201,6 +201,9 @@ export class AtomicFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-numeric-facet/atomic-numeric-facet.tsx

@@ -191,6 +191,9 @@ export class AtomicNumericFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-rating-facet/atomic-rating-facet.tsx

@@ -171,6 +171,9 @@ export class AtomicRatingFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-rating-range-facet/atomic-rating-range-facet.tsx

@@ -161,6 +161,9 @@ export class AtomicRatingRangeFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-segmented-facet/atomic-segmented-facet.tsx

@@ -100,6 +100,9 @@ export class AtomicSegmentedFacet implements InitializableComponent {
 
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/atomic/src/components/search/facets/atomic-timeframe-facet/atomic-timeframe-facet.tsx

@@ -144,6 +144,9 @@ export class AtomicTimeframeFacet implements InitializableComponent {
   @Prop({reflect: true}) public headingLevel = 0;
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
+   *
+   *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
    */
   @Prop({reflect: true}) public filterFacetCount = true;
   /**

packages/headless/src/controllers/core/facets/category-facet/headless-core-category-facet-options.ts

@@ -60,14 +60,16 @@ export interface CategoryFacetOptions {
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
    *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+   *
    * @defaultValue `true`
    */
   filterFacetCount?: boolean;
 
   /**
    * The maximum number of results to scan in the index to ensure that the facet lists all of the potential facet values.
    *
-   * **Note:** A high `injectionDepth` may reduce facet request performance.
+   * Note: A high `injectionDepth` may reduce facet request performance.
    *
    * Minimum: `0`
    *

packages/headless/src/controllers/core/facets/facet/headless-core-facet-options.ts

@@ -40,14 +40,16 @@ export interface FacetOptions {
   /**
    * Whether to exclude the parents of folded results when estimating the result count for each facet value.
    *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+   *
    * @defaultValue `true`
    */
   filterFacetCount?: boolean;
 
   /**
    * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
    *
-   * Note: A high injectionDepth may negatively impact the facet request performance.
+   * Note: A high `injectionDepth` may negatively impact the facet request performance.
    *
    * Minimum: `0`
    *

packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-core-date-filter.ts

@@ -55,14 +55,16 @@ export interface DateFilterOptions {
   /**
    * Whether to exclude folded result parents when estimating the result count for each facet value.
    *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+   *
    * @defaultValue `true`
    */
   filterFacetCount?: boolean;
 
   /**
    * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
    *
-   * Note: A high injectionDepth may negatively impact the facet request performance.
+   * Note: A high `injectionDepth` may negatively impact the facet request performance.
    *
    * Minimum: `0`
    *

packages/headless/src/controllers/core/facets/range-facet/date-facet/headless-date-facet-options.ts

@@ -68,14 +68,16 @@ export interface DateFacetOptions {
   /**
    * Whether to exclude folded result parents when estimating the result count for each facet value.
    *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+   *
    * @defaultValue `true`
    */
   filterFacetCount?: boolean;
 
   /**
    * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
    *
-   * Note: A high injectionDepth may negatively impact the facet request performance.
+   * Note: A high `injectionDepth` may negatively impact the facet request performance.
    *
    * Minimum: `0`
    *

packages/headless/src/controllers/core/facets/range-facet/numeric-facet/headless-core-numeric-filter.ts

@@ -55,14 +55,16 @@ export interface NumericFilterOptions {
   /**
    * Whether to exclude folded result parents when estimating the result count for each facet value.
    *
+   * Note: Resulting count is only an estimation, in some cases this value could be incorrect.
+   *
    * @defaultValue `true`
    */
   filterFacetCount?: boolean;
 
   /**
    * The maximum number of results to scan in the index to ensure that the facet lists all potential facet values.
    *
-   * Note: A high injectionDepth may negatively impact the facet request performance.
+   * Note: A high `injectionDepth` may negatively impact the facet request performance.
    *
    * Minimum: `0`
    *