Discovery Engine v1 API - Class SearchRequest.Types.CrowdingSpec (1.13.0) 

public sealed class SearchRequest.Types.CrowdingSpec : IMessage<SearchRequest.Types.CrowdingSpec>, IEquatable<SearchRequest.Types.CrowdingSpec>, IDeepCloneable<SearchRequest.Types.CrowdingSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.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.

Inheritance

object > SearchRequest.Types.CrowdingSpec

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CrowdingSpec()

public CrowdingSpec()

CrowdingSpec(CrowdingSpec)

public CrowdingSpec(SearchRequest.Types.CrowdingSpec other)
Parameter
Name Description
other SearchRequestTypesCrowdingSpec

Properties

Field

public string Field { get; set; }

The field to use for crowding. Documents can be crowded by a field in the [Document][google.cloud.discoveryengine.v1.Document] object. Crowding field is case sensitive.

Property Value
Type Description
string

MaxCount

public int MaxCount { get; set; }

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.

Property Value
Type Description
int

Mode

public SearchRequest.Types.CrowdingSpec.Types.Mode Mode { get; set; }

Mode to use for documents that are crowded away.

Property Value
Type Description
SearchRequestTypesCrowdingSpecTypesMode