Cloud Vision V1 Client - Class ProductSearchResults (1.8.0)

Reference documentation and code samples for the Cloud Vision V1 Client class ProductSearchResults.

Results for a product search request.

Generated from protobuf message google.cloud.vision.v1.ProductSearchResults

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ index_time`	`Google\Protobuf\Timestamp` Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.
`↳ results`	`array<Google\Cloud\Vision\V1\ProductSearchResults\Result>` List of results, one for each product match.
`↳ product_grouped_results`	`array<Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult>` List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

getIndexTime

Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasIndexTime

clearIndexTime

setIndexTime

Timestamp of the index which provided these results. Products added to the product set and products removed from the product set after this time are not reflected in the current results.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getResults

List of results, one for each product match.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setResults

List of results, one for each product match.

Parameter
Name	Description
`var`	`array<Google\Cloud\Vision\V1\ProductSearchResults\Result>`

Returns
Type	Description
`$this`

getProductGroupedResults

List of results grouped by products detected in the query image. Each entry corresponds to one bounding polygon in the query image, and contains the matching products specific to that region. There may be duplicate product matches in the union of all the per-product results.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setProductGroupedResults

Parameter
Name	Description
`var`	`array<Google\Cloud\Vision\V1\ProductSearchResults\GroupedResult>`

Returns
Type	Description
`$this`