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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ProductSearchParams

Returns a new instance of ProductSearchParams



9603
9604
9605
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9603

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:



9576
9577
9578
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9576

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) 


9587
9588
9589
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9587

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", "apparel", or "toys" should be specified. Corresponds to the JSON property productCategories

Returns:

  • (Array<String>) 


9594
9595
9596
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9594

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) 


9601
9602
9603
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9601

def product_set
  @product_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9608
9609
9610
9611
9612
9613
 
# File 'generated/google/apis/vision_v1/classes.rb', line 9608

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