Vision AI V1 API - Class Google::Cloud::VisionAI::V1::FacetProperty (v0.3.0)

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

Central configuration for a facet.

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 e.g. value, range.

#bucket_type=

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

Parameter

value (::Google::Cloud::VisionAI::V1::FacetBucketType) — Facet bucket type e.g. value, range.

Returns

(::Google::Cloud::VisionAI::V1::FacetBucketType) — Facet bucket type e.g. value, range.

#custom_range_bucket_spec

def custom_range_bucket_spec() -> ::Google::Cloud::VisionAI::V1::FacetProperty::CustomRangeBucketSpec

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::CustomRangeBucketSpec) — Custom range facet bucket config.

#custom_range_bucket_spec=

def custom_range_bucket_spec=(value) -> ::Google::Cloud::VisionAI::V1::FacetProperty::CustomRangeBucketSpec

Parameter

value (::Google::Cloud::VisionAI::V1::FacetProperty::CustomRangeBucketSpec) — Custom range facet bucket config.

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::CustomRangeBucketSpec) — Custom range facet bucket config.

#datetime_bucket_spec

def datetime_bucket_spec() -> ::Google::Cloud::VisionAI::V1::FacetProperty::DateTimeBucketSpec

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::DateTimeBucketSpec) — Datetime range facet bucket config.

#datetime_bucket_spec=

def datetime_bucket_spec=(value) -> ::Google::Cloud::VisionAI::V1::FacetProperty::DateTimeBucketSpec

Parameter

value (::Google::Cloud::VisionAI::V1::FacetProperty::DateTimeBucketSpec) — Datetime range facet bucket config.

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::DateTimeBucketSpec) — Datetime range facet bucket config.

#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.

#fixed_range_bucket_spec

def fixed_range_bucket_spec() -> ::Google::Cloud::VisionAI::V1::FacetProperty::FixedRangeBucketSpec

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::FixedRangeBucketSpec) — Fixed range facet bucket config.

#fixed_range_bucket_spec=

def fixed_range_bucket_spec=(value) -> ::Google::Cloud::VisionAI::V1::FacetProperty::FixedRangeBucketSpec

Parameter

value (::Google::Cloud::VisionAI::V1::FacetProperty::FixedRangeBucketSpec) — Fixed range facet bucket config.

Returns

(::Google::Cloud::VisionAI::V1::FacetProperty::FixedRangeBucketSpec) — Fixed range facet bucket config.

#mapped_fields

def mapped_fields() -> ::Array<::String>

Returns

(::Array<::String>) — 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.

#mapped_fields=

def mapped_fields=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — 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.

Returns

(::Array<::String>) — 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.

#result_size

def result_size() -> ::Integer

Returns

(::Integer) — 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.

#result_size=

def result_size=(value) -> ::Integer

Parameter

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

Returns

(::Integer) — 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.