Vision AI V1 API - Class Google::Cloud::VisionAI::V1::FacetGroup (v0.1.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::FacetGroup.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bucket_type

def bucket_type() -> ::Google::Cloud::VisionAI::V1::FacetBucketType

Returns

(::Google::Cloud::VisionAI::V1::FacetBucketType) — Facet bucket type.

#bucket_type=

def bucket_type=(value) -> ::Google::Cloud::VisionAI::V1::FacetBucketType

Parameter

value (::Google::Cloud::VisionAI::V1::FacetBucketType) — Facet bucket type.

Returns

(::Google::Cloud::VisionAI::V1::FacetBucketType) — Facet bucket type.

#buckets

def buckets() -> ::Array<::Google::Cloud::VisionAI::V1::FacetBucket>

Returns

(::Array<::Google::Cloud::VisionAI::V1::FacetBucket>) — Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc.

#buckets=

def buckets=(value) -> ::Array<::Google::Cloud::VisionAI::V1::FacetBucket>

Parameter

value (::Array<::Google::Cloud::VisionAI::V1::FacetBucket>) — Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc.

Returns

(::Array<::Google::Cloud::VisionAI::V1::FacetBucket>) — Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc.

#display_name

def display_name() -> ::String

Returns

(::String) — Display name of the facet. To be used by UI for facet rendering.

#display_name=

def display_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

def facet_id() -> ::String

Returns

(::String) — Unique id of the facet group.

#facet_id=

def facet_id=(value) -> ::String

Parameter

value (::String) — Unique id of the facet group.

Returns

(::String) — Unique id of the facet group.

#fetch_matched_annotations

def fetch_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:
- INTEGER
- STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)

#fetch_matched_annotations=

def fetch_matched_annotations=(value) -> ::Boolean

Parameter

value (::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)

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)