Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/search_service.rb

Overview

Specifies how a facet is computed.

Instance Attribute Summary

• #case_insensitive ⇒ ::Boolean

  True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

• #contains ⇒ ::Array<::String>

  Only get facet values that contain the given strings.

• #intervals ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>

  Set only if values should be bucketed into intervals.

• #key ⇒ ::String

  Required.

• #order_by ⇒ ::String

  The order in which documents are returned.

• #prefixes ⇒ ::Array<::String>

  Only get facet values that start with the given string prefix.

• #restricted_values ⇒ ::Array<::String>

  Only get facet for the given restricted values.

Instance Attribute Details

#case_insensitive ⇒ ::Boolean

Returns True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Returns:

• (::Boolean) —

  True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#contains ⇒ ::Array<::String>

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#intervals ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>

Returns 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.

Returns:

• (::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>) —

  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.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key ⇒ ::String

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#prefixes ⇒ ::Array<::String>

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#restricted_values ⇒ ::Array<::String>

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 430

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end