Class: Google::Cloud::Vision::V1::ReferenceImage

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/vision/v1/product_search_service.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#bounding_polys ⇒ ::Array<::Google::Cloud::Vision::V1::BoundingPoly>

Returns 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).

Returns:

  • (::Array<::Google::Cloud::Vision::V1::BoundingPoly>) —

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



140
141
142
143
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 140

class ReferenceImage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

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

Returns:

  • (::String) —

    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.



140
141
142
143
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 140

class ReferenceImage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns Required. The Google Cloud Storage URI of the reference image.

The URI must start with gs://.

Returns:

  • (::String) —

    Required. The Google Cloud Storage URI of the reference image.

    The URI must start with gs://.



140
141
142
143
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 140

class ReferenceImage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end