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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/search_service.rb

Overview

A facet specification to perform faceted search.

Defined Under Namespace

Classes: FacetKey

Instance Attribute Summary collapse

Instance Attribute Details

#enable_dynamic_position ⇒ ::Boolean 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 394

class FacetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how a facet is computed.
  # @!attribute [rw] key
  #   @return [::String]
  #     Required. Supported textual and numerical facet keys in
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} object, over which
  #     the facet values are computed. Facet key is case-sensitive.
  # @!attribute [rw] intervals
  #   @return [::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.
  # @!attribute [rw] restricted_values
  #   @return [::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.
  # @!attribute [rw] prefixes
  #   @return [::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.
  # @!attribute [rw] contains
  #   @return [::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.
  # @!attribute [rw] case_insensitive
  #   @return [::Boolean]
  #     True to make facet keys case insensitive when getting faceting
  #     values with prefixes or contains; false otherwise.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     The order in which documents are returned.
  #
  #     Allowed values are:
  #
  #     * "count desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
  #     descending.
  #
  #     * "value desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
  #     descending.
  #       Only applies to textual facets.
  #
  #     If not set, textual values are sorted in [natural
  #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
  #     intervals are sorted in the order given by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
  class FacetKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#excluded_filter_keys ⇒ ::Array<::String> 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 394

class FacetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how a facet is computed.
  # @!attribute [rw] key
  #   @return [::String]
  #     Required. Supported textual and numerical facet keys in
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} object, over which
  #     the facet values are computed. Facet key is case-sensitive.
  # @!attribute [rw] intervals
  #   @return [::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.
  # @!attribute [rw] restricted_values
  #   @return [::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.
  # @!attribute [rw] prefixes
  #   @return [::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.
  # @!attribute [rw] contains
  #   @return [::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.
  # @!attribute [rw] case_insensitive
  #   @return [::Boolean]
  #     True to make facet keys case insensitive when getting faceting
  #     values with prefixes or contains; false otherwise.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     The order in which documents are returned.
  #
  #     Allowed values are:
  #
  #     * "count desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
  #     descending.
  #
  #     * "value desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
  #     descending.
  #       Only applies to textual facets.
  #
  #     If not set, textual values are sorted in [natural
  #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
  #     intervals are sorted in the order given by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
  class FacetKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#facet_key ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 394

class FacetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how a facet is computed.
  # @!attribute [rw] key
  #   @return [::String]
  #     Required. Supported textual and numerical facet keys in
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} object, over which
  #     the facet values are computed. Facet key is case-sensitive.
  # @!attribute [rw] intervals
  #   @return [::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.
  # @!attribute [rw] restricted_values
  #   @return [::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.
  # @!attribute [rw] prefixes
  #   @return [::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.
  # @!attribute [rw] contains
  #   @return [::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.
  # @!attribute [rw] case_insensitive
  #   @return [::Boolean]
  #     True to make facet keys case insensitive when getting faceting
  #     values with prefixes or contains; false otherwise.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     The order in which documents are returned.
  #
  #     Allowed values are:
  #
  #     * "count desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
  #     descending.
  #
  #     * "value desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
  #     descending.
  #       Only applies to textual facets.
  #
  #     If not set, textual values are sorted in [natural
  #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
  #     intervals are sorted in the order given by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
  class FacetKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#limit ⇒ ::Integer 



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 394

class FacetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies how a facet is computed.
  # @!attribute [rw] key
  #   @return [::String]
  #     Required. Supported textual and numerical facet keys in
  #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} object, over which
  #     the facet values are computed. Facet key is case-sensitive.
  # @!attribute [rw] intervals
  #   @return [::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.
  # @!attribute [rw] restricted_values
  #   @return [::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.
  # @!attribute [rw] prefixes
  #   @return [::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.
  # @!attribute [rw] contains
  #   @return [::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.
  # @!attribute [rw] case_insensitive
  #   @return [::Boolean]
  #     True to make facet keys case insensitive when getting faceting
  #     values with prefixes or contains; false otherwise.
  # @!attribute [rw] order_by
  #   @return [::String]
  #     The order in which documents are returned.
  #
  #     Allowed values are:
  #
  #     * "count desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
  #     descending.
  #
  #     * "value desc", which means order by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
  #     descending.
  #       Only applies to textual facets.
  #
  #     If not set, textual values are sorted in [natural
  #     order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
  #     intervals are sorted in the order given by
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals}.
  class FacetKey
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end