Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey

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

Overview

Specifies how a facet is computed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey.



12498
12499
12500
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12498

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

Instance Attribute Details

#case_insensitive ⇒ Boolean Also known as: case_insensitive?

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. Corresponds to the JSON property caseInsensitive

Returns:

  • (Boolean) 


12446
12447
12448
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12446

def case_insensitive
  @case_insensitive
end

#contains ⇒ Array<String>

Only get facet values that contain the given strings. For example, suppose " category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022" . If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. Corresponds to the JSON property contains

Returns:

  • (Array<String>) 


12455
12456
12457
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12455

def contains
  @contains
end

#intervals ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaInterval>

Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. Corresponds to the JSON property intervals

Returns:



12462
12463
12464
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12462

def intervals
  @intervals
end

#key ⇒ String

Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. Corresponds to the JSON property key

Returns:

  • (String) 


12468
12469
12470
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12468

def key
  @key
end

#order_by ⇒ String

The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. Corresponds to the JSON property orderBy

Returns:

  • (String) 


12478
12479
12480
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12478

def order_by
  @order_by
end

#prefixes ⇒ Array<String>

Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci- Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains " Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10. Corresponds to the JSON property prefixes

Returns:

  • (Array<String>) 


12487
12488
12489
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12487

def prefixes
  @prefixes
end

#restricted_values ⇒ Array<String>

Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", " Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. Corresponds to the JSON property restrictedValues

Returns:

  • (Array<String>) 


12496
12497
12498
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12496

def restricted_values
  @restricted_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12503
12504
12505
12506
12507
12508
12509
12510
12511
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12503

def update!(**args)
  @case_insensitive = args[:case_insensitive] if args.key?(:case_insensitive)
  @contains = args[:contains] if args.key?(:contains)
  @intervals = args[:intervals] if args.key?(:intervals)
  @key = args[:key] if args.key?(:key)
  @order_by = args[:order_by] if args.key?(:order_by)
  @prefixes = args[:prefixes] if args.key?(:prefixes)
  @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
end