Cloud Vision V1p3beta1 API - Class Google::Cloud::Vision::V1p3beta1::ProductSearchParams (v0.5.5)

Reference documentation and code samples for the Cloud Vision V1p3beta1 API class Google::Cloud::Vision::V1p3beta1::ProductSearchParams.

Parameters for a product search request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bounding_poly

def bounding_poly() -> ::Google::Cloud::Vision::V1p3beta1::BoundingPoly
Returns

#bounding_poly=

def bounding_poly=(value) -> ::Google::Cloud::Vision::V1p3beta1::BoundingPoly
Parameter
Returns

#catalog_name

def catalog_name() -> ::String
Returns
  • (::String) — The resource name of the catalog to search.

    Format is: productSearch/catalogs/CATALOG_NAME.

#catalog_name=

def catalog_name=(value) -> ::String
Parameter
  • value (::String) — 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.

#category

def category() -> ::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory
Returns

#category=

def category=(value) -> ::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory
Parameter
Returns

#filter

def filter() -> ::String
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".

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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".

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

#normalized_bounding_poly

def normalized_bounding_poly() -> ::Google::Cloud::Vision::V1p3beta1::NormalizedBoundingPoly
Returns

#normalized_bounding_poly=

def normalized_bounding_poly=(value) -> ::Google::Cloud::Vision::V1p3beta1::NormalizedBoundingPoly
Parameter
Returns

#product_categories

def product_categories() -> ::Array<::String>
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.

#product_categories=

def product_categories=(value) -> ::Array<::String>
Parameter
  • value (::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.
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.

#product_category

def product_category() -> ::String
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.

#product_category=

def product_category=(value) -> ::String
Parameter
  • value (::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.
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.

#product_set

def product_set() -> ::String
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.

#product_set=

def product_set=(value) -> ::String
Parameter
  • value (::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.

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.

#view

def view() -> ::Google::Cloud::Vision::V1p3beta1::ProductSearchResultsView
Returns

#view=

def view=(value) -> ::Google::Cloud::Vision::V1p3beta1::ProductSearchResultsView
Parameter
Returns