Class ReferenceImage (3.0.0)

ReferenceImage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A ReferenceImage represents a product image and its associated metadata, such as bounding boxes.


name str
The resource name of the reference image. Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID. This field is ignored when creating a reference image.
uri str
Required. The Google Cloud Storage URI of the reference image. The URI must start with gs://.
bounding_polys Sequence[]
Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not).