Vision AI v1 API - Class FacetGroup (1.0.0-beta01) 

public sealed class FacetGroup : IMessage<FacetGroup>, IEquatable<FacetGroup>, IDeepCloneable<FacetGroup>, IBufferMessage, IMessage

Reference documentation and code samples for the Vision AI v1 API class FacetGroup.

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

Inheritance

object > FacetGroup

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

FacetGroup()

public FacetGroup()

FacetGroup(FacetGroup)

public FacetGroup(FacetGroup other)
Parameter
Name Description
other FacetGroup

Properties

BucketType

public FacetBucketType BucketType { get; set; }

Facet bucket type.

Property Value
Type Description
FacetBucketType

Buckets

public RepeatedField<FacetBucket> Buckets { get; }

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

Property Value
Type Description
RepeatedFieldFacetBucket

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

FacetId

public string FacetId { get; set; }

Unique id of the facet group.

Property Value
Type Description
string

FetchMatchedAnnotations

public bool FetchMatchedAnnotations { get; set; }

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)
Property Value
Type Description
bool