Class: Google::Cloud::VisionAI::V1::FacetGroup

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

Overview

A group of facet buckets to be passed back and forth between backend & frontend.

Instance Attribute Summary collapse

Instance Attribute Details

#bucket_type ⇒ ::Google::Cloud::VisionAI::V1::FacetBucketType

Returns Facet bucket type.

Returns:



2507
2508
2509
2510
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2507

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

#buckets ⇒ ::Array<::Google::Cloud::VisionAI::V1::FacetBucket>

Returns Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc.

Returns:



2507
2508
2509
2510
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2507

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

#display_name ⇒ ::String

Returns Display name of the facet. To be used by UI for facet rendering.

Returns:

  • (::String) —

    Display name of the facet. To be used by UI for facet rendering.



2507
2508
2509
2510
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2507

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

#facet_id ⇒ ::String

Returns Unique id of the facet group.

Returns:

  • (::String) —

    Unique id of the facet group.



2507
2508
2509
2510
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2507

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

#fetch_matched_annotations ⇒ ::Boolean

Returns If true, return query matched annotations for this facet group's selection. This option is only applicable for facets based on partition level annotations. It supports the following facet values:

  • INTEGER
  • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only).

Returns:

  • (::Boolean) —

    If true, return query matched annotations for this facet group's selection. This option is only applicable for facets based on partition level annotations. It supports the following facet values:

    • INTEGER
    • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)


2507
2508
2509
2510
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2507

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