Struct google_api_proto::google::cloud::retail::v2alpha::branch::QualityMetric

pub struct QualityMetric {
    pub requirement_key: String,
    pub qualified_product_count: i32,
    pub unqualified_product_count: i32,
    pub suggested_quality_percent_threshold: f64,
    pub unqualified_sample_products: Vec<Product>,
}

Metric measured on a group of [Product][google.cloud.retail.v2alpha.Product]s against a certain quality requirement. Contains the number of products that pass the check and the number of products that don’t.

Fields

requirement_key: String

The key that represents a quality requirement rule.

Supported keys:

• “has-valid-uri”: product has a valid and accessible [uri][google.cloud.retail.v2alpha.Product.uri].

• “available-expire-time-conformance”: [Product.available_time][google.cloud.retail.v2alpha.Product.available_time] is early than “now”, and [Product.expire_time][google.cloud.retail.v2alpha.Product.expire_time] is greater than “now”.

• “has-searchable-attributes”: product has at least one [attribute][google.cloud.retail.v2alpha.Product.attributes] set to searchable.

• “has-description”: product has non-empty [description][google.cloud.retail.v2alpha.Product.description].

• “has-at-least-bigram-title”: Product [title][google.cloud.retail.v2alpha.Product.title] has at least two words. A comprehensive title helps to improve search quality.

• “variant-has-image”: the [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has at least one [image][google.cloud.retail.v2alpha.Product.images]. You may ignore this metric if all your products are at [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

• “variant-has-price-info”: the [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] products has [price_info][google.cloud.retail.v2alpha.Product.price_info] set. You may ignore this metric if all your products are at [primary][google.cloud.retail.v2alpha.Product.Type.PRIMARY] level.

• “has-publish-time”: product has non-empty [publish_time][google.cloud.retail.v2alpha.Product.publish_time].

qualified_product_count: i32

Number of products passing the quality requirement check. We only check searchable products.

unqualified_product_count: i32

Number of products failing the quality requirement check. We only check searchable products.

suggested_quality_percent_threshold: f64

Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualified_product_count) / (qualified_product_count + unqualified_product_count) should be greater or equal to this suggestion.

unqualified_sample_products: Vec<Product>

A list of a maximum of 100 sample products that do not qualify for this requirement.

This field is only populated in the response to [BranchService.GetBranch][google.cloud.retail.v2alpha.BranchService.GetBranch] API, and is always empty for [BranchService.ListBranches][google.cloud.retail.v2alpha.BranchService.ListBranches].

Only the following fields are set in the [Product][google.cloud.retail.v2alpha.Product].

• [Product.name][google.cloud.retail.v2alpha.Product.name]
• [Product.id][google.cloud.retail.v2alpha.Product.id]
• [Product.title][google.cloud.retail.v2alpha.Product.title]

Trait Implementations

impl Clone for QualityMetric

fn clone(&self) -> QualityMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QualityMetric

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

Formats the value using the given formatter.

impl Default for QualityMetric

fn default() -> Self

Returns the “default value” for a type.

impl Message for QualityMetric

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 QualityMetric

fn eq(&self, other: &QualityMetric) -> 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 QualityMetric