Reference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::ProductSearchParams.
Parameters for a product search request.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bounding_poly
def bounding_poly() -> ::Google::Cloud::Vision::V1::BoundingPoly- (::Google::Cloud::Vision::V1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
#bounding_poly=
def bounding_poly=(value) -> ::Google::Cloud::Vision::V1::BoundingPoly- value (::Google::Cloud::Vision::V1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
- (::Google::Cloud::Vision::V1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.
#filter
def filter() -> ::String-
(::String) — 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 '='.
#filter=
def filter=(value) -> ::String-
value (::String) — 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 '='.
-
(::String) — 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 '='.
#product_categories
def product_categories() -> ::Array<::String>- (::Array<::String>) — 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.
#product_categories=
def product_categories=(value) -> ::Array<::String>- value (::Array<::String>) — 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.
- (::Array<::String>) — 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.
#product_set
def product_set() -> ::String-
(::String) — The resource name of a ProductSet to be searched for similar images.
Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.
#product_set=
def product_set=(value) -> ::String-
value (::String) — The resource name of a ProductSet to be searched for similar images.
Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.
-
(::String) — The resource name of a ProductSet to be searched for similar images.
Format is:
projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.