(::String) — Display name of the facet. To be used by UI for facet rendering.
#display_name=
defdisplay_name=(value)->::String
Parameter
value (::String) — 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.
#facet_id
deffacet_id()->::String
Returns
(::String) — Unique id of the facet group.
#facet_id=
deffacet_id=(value)->::String
Parameter
value (::String) — Unique id of the facet group.
Returns
(::String) — Unique id of the facet group.
#fetch_matched_annotations
deffetch_matched_annotations()->::Boolean
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:
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::FacetGroup (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-FacetGroup)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-FacetGroup)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-FacetGroup)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-FacetGroup)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-FacetGroup)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-FacetGroup)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-FacetGroup) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::FacetGroup.\n\nA group of facet buckets to be passed back and forth between backend \\&\nfrontend. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #bucket_type\n\n def bucket_type() -\u003e ::Google::Cloud::VisionAI::V1::FacetBucketType\n\n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::FacetBucketType](./Google-Cloud-VisionAI-V1-FacetBucketType)) --- Facet bucket type.\n\n### #bucket_type=\n\n def bucket_type=(value) -\u003e ::Google::Cloud::VisionAI::V1::FacetBucketType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::VisionAI::V1::FacetBucketType](./Google-Cloud-VisionAI-V1-FacetBucketType)) --- Facet bucket type. \n**Returns**\n\n- ([::Google::Cloud::VisionAI::V1::FacetBucketType](./Google-Cloud-VisionAI-V1-FacetBucketType)) --- Facet bucket type.\n\n### #buckets\n\n def buckets() -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::FacetBucket\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::FacetBucket](./Google-Cloud-VisionAI-V1-FacetBucket)\\\u003e) --- Buckets associated with the facet. E.g. for \"Team\" facet, the bucket can be 49ers, patriots, etc.\n\n### #buckets=\n\n def buckets=(value) -\u003e ::Array\u003c::Google::Cloud::VisionAI::V1::FacetBucket\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::VisionAI::V1::FacetBucket](./Google-Cloud-VisionAI-V1-FacetBucket)\\\u003e) --- Buckets associated with the facet. E.g. for \"Team\" facet, the bucket can be 49ers, patriots, etc. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::VisionAI::V1::FacetBucket](./Google-Cloud-VisionAI-V1-FacetBucket)\\\u003e) --- Buckets associated with the facet. E.g. for \"Team\" facet, the bucket can be 49ers, patriots, etc.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Display name of the facet. To be used by UI for facet rendering.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Display name of the facet. To be used by UI for facet rendering. \n**Returns**\n\n- (::String) --- Display name of the facet. To be used by UI for facet rendering.\n\n### #facet_id\n\n def facet_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Unique id of the facet group.\n\n### #facet_id=\n\n def facet_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Unique id of the facet group. \n**Returns**\n\n- (::String) --- Unique id of the facet group.\n\n### #fetch_matched_annotations\n\n def fetch_matched_annotations() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, return query matched annotations for this facet group's selection.\n This option is only applicable for facets based on partition level\n annotations. It supports the following facet values:\n\n - INTEGER\n - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)\n\n### #fetch_matched_annotations=\n\n def fetch_matched_annotations=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) ---\n\n If true, return query matched annotations for this facet group's selection.\n This option is only applicable for facets based on partition level\n annotations. It supports the following facet values:\n - INTEGER\n- STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) \n**Returns**\n\n- (::Boolean) --- If true, return query matched annotations for this facet group's selection.\n This option is only applicable for facets based on partition level\n annotations. It supports the following facet values:\n\n - INTEGER\n - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)"]]
