Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec.



16256
16257
16258
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16256

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#field ⇒ String

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive. Corresponds to the JSON property field

Returns:

  • (String) 


16241
16242
16243
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16241

def field
  @field
end

#max_count ⇒ Fixnum

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. Corresponds to the JSON property maxCount

Returns:

  • (Fixnum) 


16249
16250
16251
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16249

def max_count
  @max_count
end

#mode ⇒ String

Mode to use for documents that are crowded away. Corresponds to the JSON property mode

Returns:

  • (String) 


16254
16255
16256
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16254

def mode
  @mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16261
16262
16263
16264
16265
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 16261

def update!(**args)
  @field = args[:field] if args.key?(:field)
  @max_count = args[:max_count] if args.key?(:max_count)
  @mode = args[:mode] if args.key?(:mode)
end