(::Google::Cloud::Vision::V1::BoundingPoly) — The bounding polygon around the area of interest in the image.
If it is not specified, system discretion will be applied.
value (::Google::Cloud::Vision::V1::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::V1::BoundingPoly) — The bounding polygon around the area of interest in the image.
If it is not specified, system discretion will be applied.
#filter
deffilter()->::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=
deffilter=(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
defproduct_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=
defproduct_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
defproduct_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=
defproduct_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Vision V1 API - Class Google::Cloud::Vision::V1::ProductSearchParams (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-vision-v1/latest/Google-Cloud-Vision-V1-ProductSearchParams)\n- [1.3.0](/ruby/docs/reference/google-cloud-vision-v1/1.3.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [1.2.1](/ruby/docs/reference/google-cloud-vision-v1/1.2.1/Google-Cloud-Vision-V1-ProductSearchParams)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision-v1/1.1.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision-v1/1.0.1/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.15.0](/ruby/docs/reference/google-cloud-vision-v1/0.15.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.14.0](/ruby/docs/reference/google-cloud-vision-v1/0.14.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.13.2](/ruby/docs/reference/google-cloud-vision-v1/0.13.2/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.12.0](/ruby/docs/reference/google-cloud-vision-v1/0.12.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.11.1](/ruby/docs/reference/google-cloud-vision-v1/0.11.1/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.10.0](/ruby/docs/reference/google-cloud-vision-v1/0.10.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.9.0](/ruby/docs/reference/google-cloud-vision-v1/0.9.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.8.0](/ruby/docs/reference/google-cloud-vision-v1/0.8.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.7.0](/ruby/docs/reference/google-cloud-vision-v1/0.7.0/Google-Cloud-Vision-V1-ProductSearchParams)\n- [0.6.4](/ruby/docs/reference/google-cloud-vision-v1/0.6.4/Google-Cloud-Vision-V1-ProductSearchParams) \nReference documentation and code samples for the Cloud Vision V1 API class Google::Cloud::Vision::V1::ProductSearchParams.\n\nParameters for a product search request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #bounding_poly\n\n def bounding_poly() -\u003e ::Google::Cloud::Vision::V1::BoundingPoly\n\n**Returns**\n\n- ([::Google::Cloud::Vision::V1::BoundingPoly](./Google-Cloud-Vision-V1-BoundingPoly)) --- The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.\n\n### #bounding_poly=\n\n def bounding_poly=(value) -\u003e ::Google::Cloud::Vision::V1::BoundingPoly\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Vision::V1::BoundingPoly](./Google-Cloud-Vision-V1-BoundingPoly)) --- The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied. \n**Returns**\n\n- ([::Google::Cloud::Vision::V1::BoundingPoly](./Google-Cloud-Vision-V1-BoundingPoly)) --- The bounding polygon around the area of interest in the image. If it is not specified, system discretion will be applied.\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n For example, \"(color = red OR color = blue) AND brand = Google\" is\n acceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n \"color: red\" is not acceptable because it uses a ':' instead of an '='.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **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.\n\n\n For example, \"(color = red OR color = blue) AND brand = Google\" is\n acceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n\"color: red\" is not acceptable because it uses a ':' instead of an '='. \n**Returns**\n\n- (::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.\n\n For example, \"(color = red OR color = blue) AND brand = Google\" is\n acceptable, but \"(color = red OR brand = Google)\" is not acceptable.\n \"color: red\" is not acceptable because it uses a ':' instead of an '='.\n\n### #product_categories\n\n def product_categories() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #product_categories=\n\n def product_categories=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- 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. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- 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.\n\n### #product_set\n\n def product_set() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The resource name of a [ProductSet](/ruby/docs/reference/google-cloud-vision-v1/latest/Google-Cloud-Vision-V1-ProductSet \"Google::Cloud::Vision::V1::ProductSet (class)\") to be searched for similar images.\n\n\n Format is:\n `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.\n\n### #product_set=\n\n def product_set=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The resource name of a [ProductSet](/ruby/docs/reference/google-cloud-vision-v1/latest/Google-Cloud-Vision-V1-ProductSet \"Google::Cloud::Vision::V1::ProductSet (class)\") to be searched for similar images.\n\n\n Format is:\n`projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. \n**Returns**\n\n- (::String) --- The resource name of a [ProductSet](/ruby/docs/reference/google-cloud-vision-v1/latest/Google-Cloud-Vision-V1-ProductSet \"Google::Cloud::Vision::V1::ProductSet (class)\") to be searched for similar images.\n\n\n Format is:\n `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`."]]
