Struct google_api_proto::google::cloud::visionai::v1alpha1::FacetProperty

pub struct FacetProperty {
    pub mapped_fields: Vec<String>,
    pub display_name: String,
    pub result_size: i64,
    pub bucket_type: i32,
    pub range_facet_config: Option<RangeFacetConfig>,
}

Central configuration for a facet.

Fields

mapped_fields: Vec<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.

display_name: String

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

result_size: i64

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.

bucket_type: i32

Facet bucket type e.g. value, range.

range_facet_config: Option<RangeFacetConfig>

Implementations

impl FacetProperty

pub fn bucket_type(&self) -> FacetBucketType

Returns the enum value of bucket_type, or the default if the field is set to an invalid enum value.

pub fn set_bucket_type(&mut self, value: FacetBucketType)

Sets bucket_type to the provided enum value.

Trait Implementations

impl Clone for FacetProperty

fn clone(&self) -> FacetProperty

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FacetProperty

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FacetProperty

fn default() -> Self

Returns the “default value” for a type.

impl Message for FacetProperty

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FacetProperty

fn eq(&self, other: &FacetProperty) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FacetProperty