Class QualityMetric (1.24.0)

QualityMetric(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't.

Attributes

Name Description
requirement_key str
The key that represents a quality requirement rule. Supported keys: - "has-valid-uri": product has a valid and accessible uri. - "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now". - "has-searchable-attributes": product has at least one attribute set to searchable. - "has-description": product has non-empty description. - "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality. - "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level. - "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level. - "has-publish-time": product has non-empty publish_time.
qualified_product_count int
Number of products passing the quality requirement check. We only check searchable products.
unqualified_product_count int
Number of products failing the quality requirement check. We only check searchable products.
suggested_quality_percent_threshold float
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 MutableSequence[google.cloud.retail_v2alpha.types.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 API, and is always empty for BranchService.ListBranches. Only the following fields are set in the Product. - Product.name - Product.id - Product.title