Class ProductSearchParams

public sealed class ProductSearchParams : IMessage<ProductSearchParams>, IEquatable<ProductSearchParams>, IDeepCloneable<ProductSearchParams>, IBufferMessage, IMessage

Parameters for a product search request.

Inheritance

Object > ProductSearchParams

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

ProductSearchParams()

public ProductSearchParams()

ProductSearchParams(ProductSearchParams)

public ProductSearchParams(ProductSearchParams other)
Parameter
TypeNameDescription
ProductSearchParamsother

Properties

BoundingPoly

public BoundingPoly BoundingPoly { get; set; }

The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

Property Value
TypeDescription
BoundingPoly

Filter

public string Filter { get; set; }

The filtering expression. This can be used to restrict search results based on Product labels. We currently support an AND of OR of key-value expressions, where each expression within an OR must have the same key. An '=' should be used to connect the key and value.

For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is not acceptable. "color: red" is not acceptable because it uses a ':' instead of an '='.

Property Value
TypeDescription
String

ProductCategories

public RepeatedField<string> ProductCategories { get; }

The list of product categories to search in. Currently, we only consider the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1", or "general-v1" should be specified. The legacy categories "homegoods", "apparel", and "toys" are still supported but will be deprecated. For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for better product search accuracy. It is recommended to migrate existing products to these categories as well.

Property Value
TypeDescription
RepeatedField<String>

ProductSet

public string ProductSet { get; set; }

The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Property Value
TypeDescription
String

ProductSetAsProductSetName

public ProductSetName ProductSetAsProductSetName { get; set; }

ProductSetName-typed view over the ProductSet resource name property.

Property Value
TypeDescription
ProductSetName