Cloud Vision V1p4beta1 API - Class Google::Cloud::Vision::V1p4beta1::ProductSearchParams (v0.8.1)

Version latest

• 0.8.1 (latest)
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.2

Reference documentation and code samples for the Cloud Vision V1p4beta1 API class Google::Cloud::Vision::V1p4beta1::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::V1p4beta1::BoundingPoly

Returns

• (::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

#bounding_poly=

def bounding_poly=(value) -> ::Google::Cloud::Vision::V1p4beta1::BoundingPoly

Parameter

• value (::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

Returns

• (::Google::Cloud::Vision::V1p4beta1::BoundingPoly) — The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.

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

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

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

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

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