Class: Google::Apis::VisionV1::ProductSearchParams
- Inherits:
-
Object
- Object
- Google::Apis::VisionV1::ProductSearchParams
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/vision_v1/classes.rb,
lib/google/apis/vision_v1/representations.rb,
lib/google/apis/vision_v1/representations.rb more...
Overview
Parameters for a product search request.
Instance Attribute Summary collapse
-
#bounding_poly ⇒ Google::Apis::VisionV1::BoundingPoly
A bounding polygon for the detected image annotation.
-
#filter ⇒ String
The filtering expression.
-
#product_categories ⇒ Array<String>
The list of product categories to search in.
-
#product_set ⇒ String
The resource name of a ProductSet to be searched for similar images.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ProductSearchParams
constructor
A new instance of ProductSearchParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ProductSearchParams
Returns a new instance of ProductSearchParams.
9565 9566 9567 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9565 def initialize(**args) update!(**args) end |
Instance Attribute Details
#bounding_poly ⇒ Google::Apis::VisionV1::BoundingPoly
A bounding polygon for the detected image annotation.
Corresponds to the JSON property boundingPoly
9535 9536 9537 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9535 def bounding_poly @bounding_poly end |
#filter ⇒ 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 '='.
Corresponds to the JSON property filter
9546 9547 9548 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9546 def filter @filter end |
#product_categories ⇒ 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.
Corresponds to the JSON property productCategories
9557 9558 9559 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9557 def product_categories @product_categories end |
#product_set ⇒ 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
.
Corresponds to the JSON property productSet
9563 9564 9565 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9563 def product_set @product_set end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9570 9571 9572 9573 9574 9575 |
# File 'lib/google/apis/vision_v1/classes.rb', line 9570 def update!(**args) @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @filter = args[:filter] if args.key?(:filter) @product_categories = args[:product_categories] if args.key?(:product_categories) @product_set = args[:product_set] if args.key?(:product_set) end |