Interface Branch.QualityMetricOrBuilder (2.49.0) 

public static interface Branch.QualityMetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getQualifiedProductCount()

public abstract int getQualifiedProductCount()

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

int32 qualified_product_count = 2;

Returns
Type Description
int

The qualifiedProductCount.

getRequirementKey()

public abstract String getRequirementKey()

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.

string requirement_key = 1;

Returns
Type Description
String

The requirementKey.

getRequirementKeyBytes()

public abstract ByteString getRequirementKeyBytes()

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.

string requirement_key = 1;

Returns
Type Description
ByteString

The bytes for requirementKey.

getSuggestedQualityPercentThreshold()

public abstract double getSuggestedQualityPercentThreshold()

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.

double suggested_quality_percent_threshold = 4;

Returns
Type Description
double

The suggestedQualityPercentThreshold.

getUnqualifiedProductCount()

public abstract int getUnqualifiedProductCount()

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

int32 unqualified_product_count = 3;

Returns
Type Description
int

The unqualifiedProductCount.

getUnqualifiedSampleProducts(int index)

public abstract Product getUnqualifiedSampleProducts(int index)

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

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name Description
index int
Returns
Type Description
Product

getUnqualifiedSampleProductsCount()

public abstract int getUnqualifiedSampleProductsCount()

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

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type Description
int

getUnqualifiedSampleProductsList()

public abstract List<Product> getUnqualifiedSampleProductsList()

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

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type Description
List<Product>

getUnqualifiedSampleProductsOrBuilder(int index)

public abstract ProductOrBuilder getUnqualifiedSampleProductsOrBuilder(int index)

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

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Parameter
Name Description
index int
Returns
Type Description
ProductOrBuilder

getUnqualifiedSampleProductsOrBuilderList()

public abstract List<? extends ProductOrBuilder> getUnqualifiedSampleProductsOrBuilderList()

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

repeated .google.cloud.retail.v2alpha.Product unqualified_sample_products = 5;

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.ProductOrBuilder>