Class: Google::Apis::VisionV1::ProductSearchParams

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1/classes.rb,
generated/google/apis/vision_v1/representations.rb,
generated/google/apis/vision_v1/representations.rb

Overview

Parameters for a product search request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProductSearchParams

Returns a new instance of ProductSearchParams.



9500
9501
9502
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9500

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

Returns:



9470
9471
9472
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9470

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

Returns:

  • (String) 


9481
9482
9483
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9481

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

Returns:

  • (Array<String>) 


9492
9493
9494
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9492

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

Returns:

  • (String) 


9498
9499
9500
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9498

def product_set
  @product_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9505
9506
9507
9508
9509
9510
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9505

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