Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey

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) ⇒ GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey

Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey.



8722
8723
8724
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8722

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) 


8670
8671
8672
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8670

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>) 


8679
8680
8681
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8679

def contains
  @contains
end

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

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:



8686
8687
8688
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8686

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) 


8692
8693
8694
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8692

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) 


8702
8703
8704
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8702

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>) 


8711
8712
8713
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8711

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>) 


8720
8721
8722
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8720

def restricted_values
  @restricted_values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8727
8728
8729
8730
8731
8732
8733
8734
8735
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 8727

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