com.google.cloud.retail.v2alpha

Interface Branch.QualityMetricOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Branch.QualityMetric, Branch.QualityMetric.Builder

Enclosing class:

Branch

public static interface Branch.QualityMetricOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getQualifiedProductCount() Number of products passing the quality requirement check.
String	getRequirementKey() The key that represents a quality requirement rule.
com.google.protobuf.ByteString	getRequirementKeyBytes() The key that represents a quality requirement rule.
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.
int	getUnqualifiedProductCount() Number of products failing the quality requirement check.
Product	getUnqualifiedSampleProducts(int index) A list of a maximum of 100 sample products that do not qualify for this requirement.
int	getUnqualifiedSampleProductsCount() A list of a maximum of 100 sample products that do not qualify for this requirement.
List<Product>	getUnqualifiedSampleProductsList() A list of a maximum of 100 sample products that do not qualify for this requirement.
ProductOrBuilder	getUnqualifiedSampleProductsOrBuilder(int index) A list of a maximum of 100 sample products that do not qualify for this requirement.
List<? extends ProductOrBuilder>	getUnqualifiedSampleProductsOrBuilderList() A list of a maximum of 100 sample products that do not qualify for this requirement.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRequirementKey

String getRequirementKey()

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

string requirement_key = 1;

Returns:

The requirementKey.

getRequirementKeyBytes

com.google.protobuf.ByteString getRequirementKeyBytes()

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

string requirement_key = 1;

Returns:

The bytes for requirementKey.

getQualifiedProductCount

int getQualifiedProductCount()

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

int32 qualified_product_count = 2;

Returns:

The qualifiedProductCount.

getUnqualifiedProductCount

int getUnqualifiedProductCount()

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

int32 unqualified_product_count = 3;

Returns:

The unqualifiedProductCount.

getSuggestedQualityPercentThreshold

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:

The suggestedQualityPercentThreshold.

getUnqualifiedSampleProductsList

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][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]
 

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

getUnqualifiedSampleProducts

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][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]
 

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

getUnqualifiedSampleProductsCount

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][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]
 

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

getUnqualifiedSampleProductsOrBuilderList

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][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]
 

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

getUnqualifiedSampleProductsOrBuilder

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][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]
 

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