# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec.

A facet specification to perform faceted search.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #enable_dynamic_position

    def enable_dynamic_position() -> ::Boolean

**Returns**

- (::Boolean) --- Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets.

  For example, you may always want to have rating facet returned in
  the response, but it's not necessarily to always display the rating facet
  at the top. In that case, you can set enable_dynamic_position to true so
  that the position of rating facet in response is determined
  automatically.

  Another example, assuming you have the following facets in the request:
  - "rating", enable_dynamic_position = true

  - "price", enable_dynamic_position = false

  - "brands", enable_dynamic_position = false

  And also you have a dynamic facets enabled, which generates a facet
  `gender`. Then the final order of the facets in the response can be
  ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  "rating") depends on how API orders "gender" and "rating" facets.
  However, notice that "price" and "brands" are always
  ranked at first and second position because their enable_dynamic_position
  is false.

### #enable_dynamic_position=

    def enable_dynamic_position=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets.


  For example, you may always want to have rating facet returned in
  the response, but it's not necessarily to always display the rating facet
  at the top. In that case, you can set enable_dynamic_position to true so
  that the position of rating facet in response is determined
  automatically.

  Another example, assuming you have the following facets in the request:
  - "rating", enable_dynamic_position = true

  - "price", enable_dynamic_position = false

  - "brands", enable_dynamic_position = false

  And also you have a dynamic facets enabled, which generates a facet
  `gender`. Then the final order of the facets in the response can be
  ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  "rating") depends on how API orders "gender" and "rating" facets.
  However, notice that "price" and "brands" are always
  ranked at first and second position because their enable_dynamic_position
  is false.
**Returns**

- (::Boolean) --- Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets.

  For example, you may always want to have rating facet returned in
  the response, but it's not necessarily to always display the rating facet
  at the top. In that case, you can set enable_dynamic_position to true so
  that the position of rating facet in response is determined
  automatically.

  Another example, assuming you have the following facets in the request:
  - "rating", enable_dynamic_position = true

  - "price", enable_dynamic_position = false

  - "brands", enable_dynamic_position = false

  And also you have a dynamic facets enabled, which generates a facet
  `gender`. Then the final order of the facets in the response can be
  ("price", "brands", "rating", "gender") or ("price", "brands", "gender",
  "rating") depends on how API orders "gender" and "rating" facets.
  However, notice that "price" and "brands" are always
  ranked at first and second position because their enable_dynamic_position
  is false.

### #excluded_filter_keys

    def excluded_filter_keys() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- List of keys to exclude when faceting.

  By default,
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  is not excluded from the filter unless it is listed in this field.

  Listing a facet key in this field allows its values to appear as facet
  results, even when they are filtered out of search results. Using this
  field does not affect what search results are returned.

  For example, suppose there are 100 documents with the color facet "Red"
  and 200 documents with the color facet "Blue". A query containing the
  filter "color:ANY("Red")" and having "color" as
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  would by default return only "Red" documents in the search results, and
  also return "Red" with count 100 as the only color facet. Although there
  are also blue documents available, "Blue" would not be shown as an
  available facet value.

  If "color" is listed in "excludedFilterKeys", then the query returns the
  facet values "Red" with count 100 and "Blue" with count 200, because the
  "color" key is now excluded from the filter. Because this field doesn't
  affect search results, the search results are still correctly filtered to
  return only "Red" documents.

  A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
  error is returned.

### #excluded_filter_keys=

    def excluded_filter_keys=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- List of keys to exclude when faceting.


  By default,
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  is not excluded from the filter unless it is listed in this field.

  Listing a facet key in this field allows its values to appear as facet
  results, even when they are filtered out of search results. Using this
  field does not affect what search results are returned.

  For example, suppose there are 100 documents with the color facet "Red"
  and 200 documents with the color facet "Blue". A query containing the
  filter "color:ANY("Red")" and having "color" as
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  would by default return only "Red" documents in the search results, and
  also return "Red" with count 100 as the only color facet. Although there
  are also blue documents available, "Blue" would not be shown as an
  available facet value.

  If "color" is listed in "excludedFilterKeys", then the query returns the
  facet values "Red" with count 100 and "Blue" with count 200, because the
  "color" key is now excluded from the filter. Because this field doesn't
  affect search results, the search results are still correctly filtered to
  return only "Red" documents.

  A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
  error is returned.
**Returns**

- (::Array\<::String\>) --- List of keys to exclude when faceting.

  By default,
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  is not excluded from the filter unless it is listed in this field.

  Listing a facet key in this field allows its values to appear as facet
  results, even when they are filtered out of search results. Using this
  field does not affect what search results are returned.

  For example, suppose there are 100 documents with the color facet "Red"
  and 200 documents with the color facet "Blue". A query containing the
  filter "color:ANY("Red")" and having "color" as
  [FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key (method)")
  would by default return only "Red" documents in the search results, and
  also return "Red" with count 100 as the only color facet. Although there
  are also blue documents available, "Blue" would not be shown as an
  available facet value.

  If "color" is listed in "excludedFilterKeys", then the query returns the
  facet values "Red" with count 100 and "Blue" with count 200, because the
  "color" key is now excluded from the filter. Because this field doesn't
  affect search results, the search results are still correctly filtered to
  return only "Red" documents.

  A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
  error is returned.

### #facet_key

    def facet_key() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey)) --- Required. The facet key specification.

### #facet_key=

    def facet_key=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey)) --- Required. The facet key specification.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-FacetSpec-FacetKey)) --- Required. The facet key specification.

### #limit

    def limit() -> ::Integer

**Returns**

- (::Integer) --- Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the \[FacetKey.key\] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here.

  If this field is negative, an `INVALID_ARGUMENT` is returned.

### #limit=

    def limit=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the \[FacetKey.key\] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here.


  If this field is negative, an `INVALID_ARGUMENT` is returned.
**Returns**

- (::Integer) --- Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the \[FacetKey.key\] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here.

  If this field is negative, an `INVALID_ARGUMENT` is returned.