# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec (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::CrowdingSpec.

Specification for crowding. Crowding improves the diversity of search
results by limiting the number of results that share the same field value.
For example, crowding on the color field with a max_count of 3 and mode
DROP_CROWDED_RESULTS will return at most 3 results with the same color
across all pages.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #field

    def field() -> ::String

**Returns**

- (::String) --- The field to use for crowding. Documents can be crowded by a field in the [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") object. Crowding field is case sensitive.

### #field=

    def field=(value) -> ::String

**Parameter**

- **value** (::String) --- The field to use for crowding. Documents can be crowded by a field in the [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") object. Crowding field is case sensitive.
**Returns**

- (::String) --- The field to use for crowding. Documents can be crowded by a field in the [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") object. Crowding field is case sensitive.

### #max_count

    def max_count() -> ::Integer

**Returns**

- (::Integer) --- The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.

### #max_count=

    def max_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.
**Returns**

- (::Integer) --- The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.

### #mode

    def mode() -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec::Mode

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-CrowdingSpec-Mode)) --- Mode to use for documents that are crowded away.

### #mode=

    def mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec::Mode

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-CrowdingSpec-Mode)) --- Mode to use for documents that are crowded away.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::CrowdingSpec::Mode](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest-CrowdingSpec-Mode)) --- Mode to use for documents that are crowded away.