Class: Google::Cloud::Vision::V1::ProductSearchParams

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/vision/v1/product_search.rb

Overview

Parameters for a product search request.

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_poly ⇒ ::Google::Cloud::Vision::V1::BoundingPoly

Returns The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

Returns:



55
56
57
58
 
# File 'proto_docs/google/cloud/vision/v1/product_search.rb', line 55

class ProductSearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns 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 '='.

Returns:

  • (::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 '='.



55
56
57
58
 
# File 'proto_docs/google/cloud/vision/v1/product_search.rb', line 55

class ProductSearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_categories ⇒ ::Array<::String>

Returns 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.

Returns:

  • (::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.



55
56
57
58
 
# File 'proto_docs/google/cloud/vision/v1/product_search.rb', line 55

class ProductSearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_set ⇒ ::String

Returns The resource name of a ProductSet to be searched for similar images.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID.

Returns:

  • (::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.



55
56
57
58
 
# File 'proto_docs/google/cloud/vision/v1/product_search.rb', line 55

class ProductSearchParams
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end