Class: Google::Cloud::Vision::V1p3beta1::ProductSearchParams

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

Overview

Parameters for a product search request.

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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

#catalog_name ⇒ ::String

Returns The resource name of the catalog to search.

Format is: productSearch/catalogs/CATALOG_NAME.

Returns:

  • (::String) —

    The resource name of the catalog to search.

    Format is: productSearch/catalogs/CATALOG_NAME.



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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

#category ⇒ ::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory

Returns The category to search in. Optional. It is inferred by the system if it is not specified. [Deprecated] Use product_category.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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.

For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".

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.

    For example, "(color = red OR color = blue) AND brand = Google" is acceptable, but not "(color = red OR brand = Google)" or "color: red".



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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

#normalized_bounding_poly ⇒ ::Google::Cloud::Vision::V1p3beta1::NormalizedBoundingPoly

Returns The bounding polygon around the area of interest in the image. Optional. If it is not specified, system discretion will be applied. [Deprecated] Use bounding_poly.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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" or "apparel" should be specified.

Returns:

  • (::Array<::String>) —

    The list of product categories to search in. Currently, we only consider the first category, and either "homegoods" or "apparel" should be specified.



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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

#product_category ⇒ ::String

Returns The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are bag, shoe, sunglasses, dress, outerwear, skirt, top, shorts, and pants.

Returns:

  • (::String) —

    The product category to search in. Optional. It is inferred by the system if it is not specified. Supported values are bag, shoe, sunglasses, dress, outerwear, skirt, top, shorts, and pants.



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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.



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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

#view ⇒ ::Google::Cloud::Vision::V1p3beta1::ProductSearchResultsView

Returns Specifies the verbosity of the product search results. Optional. Defaults to BASIC.

Returns:



75
76
77
78
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 75

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