Class: Google::Apis::CloudsearchV1::SourceCrowdingConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SourceCrowdingConfig

Returns a new instance of SourceCrowdingConfig



4231
4232
4233
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4231

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

Instance Attribute Details

#field ⇒ String

Use a field to control results crowding. For example, if you want to control overly similar results from Gmail topics, use thread_id. For similar pages from Google Sites, you can use webspace_id. When matching query results contain the same field value in GenericMetadata, crowding limits are set on those records. Corresponds to the JSON property field

Returns:

  • (String) 


4210
4211
4212
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4210

def field
  @field
end

#num_results ⇒ Fixnum

Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0. Corresponds to the JSON property numResults

Returns:

  • (Fixnum) 


4216
4217
4218
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4216

def num_results
  @num_results
end

#num_suggestions ⇒ Fixnum

Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0. Corresponds to the JSON property numSuggestions

Returns:

  • (Fixnum) 


4222
4223
4224
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4222

def num_suggestions
  @num_suggestions
end

#source ⇒ Boolean Also known as: source?

Control results by content source. This option limits the total number of results from a given source and ignores field-based crowding control. Corresponds to the JSON property source

Returns:

  • (Boolean) 


4228
4229
4230
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4228

def source
  @source
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4236
4237
4238
4239
4240
4241
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 4236

def update!(**args)
  @field = args[:field] if args.key?(:field)
  @num_results = args[:num_results] if args.key?(:num_results)
  @num_suggestions = args[:num_suggestions] if args.key?(:num_suggestions)
  @source = args[:source] if args.key?(:source)
end