Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchParams

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1p2beta1/classes.rb,
generated/google/apis/vision_v1p2beta1/representations.rb,
generated/google/apis/vision_v1p2beta1/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) ⇒ GoogleCloudVisionV1p2beta1ProductSearchParams

Returns a new instance of GoogleCloudVisionV1p2beta1ProductSearchParams



4237
4238
4239
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4237

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bounding_polyGoogle::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly

A bounding polygon for the detected image annotation. Corresponds to the JSON property boundingPoly



4212
4213
4214
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4212

def bounding_poly
  @bounding_poly
end

#filterString

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. For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red". Corresponds to the JSON property filter

Returns:

  • (String)


4221
4222
4223
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4221

def filter
  @filter
end

#product_categoriesArray<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>)


4228
4229
4230
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4228

def product_categories
  @product_categories
end

#product_setString

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)


4235
4236
4237
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4235

def product_set
  @product_set
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4242
4243
4244
4245
4246
4247
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 4242

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