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

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

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

Central configuration for a facet.

Inheritance

object > FacetProperty

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

FacetProperty()

public FacetProperty()

FacetProperty(FacetProperty)

public FacetProperty(FacetProperty other)
Parameter
Name Description
other FacetProperty

Properties

BucketType

public FacetBucketType BucketType { get; set; }

Facet bucket type e.g. value, range.

Property Value
Type Description
FacetBucketType

CustomRangeBucketSpec

public FacetProperty.Types.CustomRangeBucketSpec CustomRangeBucketSpec { get; set; }

Custom range facet bucket config.

Property Value
Type Description
FacetPropertyTypesCustomRangeBucketSpec

DatetimeBucketSpec

public FacetProperty.Types.DateTimeBucketSpec DatetimeBucketSpec { get; set; }

Datetime range facet bucket config.

Property Value
Type Description
FacetPropertyTypesDateTimeBucketSpec

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

FixedRangeBucketSpec

public FacetProperty.Types.FixedRangeBucketSpec FixedRangeBucketSpec { get; set; }

Fixed range facet bucket config.

Property Value
Type Description
FacetPropertyTypesFixedRangeBucketSpec

MappedFields

public RepeatedField<string> MappedFields { get; }

Name of the facets, which are the dimensions users want to use to refine search results. mapped_fields will match UserSpecifiedDataSchema keys.

For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].

UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.

Property Value
Type Description
RepeatedFieldstring

RangeFacetConfigCase

public FacetProperty.RangeFacetConfigOneofCase RangeFacetConfigCase { get; }
Property Value
Type Description
FacetPropertyRangeFacetConfigOneofCase

ResultSize

public long ResultSize { get; set; }

Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size.

Property Value
Type Description
long