Class: Google::Cloud::Vision::V1::Product

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 Product contains ReferenceImages.

Defined Under Namespace

Classes: KeyValue

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns User-provided metadata to be stored with this product. Must be at most 4096 characters long.

Returns:

  • (::String) —

    User-provided metadata to be stored with this product. Must be at most 4096 characters long.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 62

class Product
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A product label represented as a key-value pair.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the label attached to the product. Cannot be empty and cannot
  #     exceed 128 bytes.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the label attached to the product. Cannot be empty and
  #     cannot exceed 128 bytes.
  class KeyValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.

Returns:

  • (::String) —

    The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 62

class Product
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A product label represented as a key-value pair.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the label attached to the product. Cannot be empty and cannot
  #     exceed 128 bytes.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the label attached to the product. Cannot be empty and
  #     cannot exceed 128 bytes.
  class KeyValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The resource name of the product.

Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

This field is ignored when creating a product.

Returns:

  • (::String) —

    The resource name of the product.

    Format is: projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

    This field is ignored when creating a product.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 62

class Product
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A product label represented as a key-value pair.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the label attached to the product. Cannot be empty and cannot
  #     exceed 128 bytes.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the label attached to the product. Cannot be empty and
  #     cannot exceed 128 bytes.
  class KeyValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#product_category ⇒ ::String

Returns Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.

Returns:

  • (::String) —

    Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 62

class Product
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A product label represented as a key-value pair.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the label attached to the product. Cannot be empty and cannot
  #     exceed 128 bytes.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the label attached to the product. Cannot be empty and
  #     cannot exceed 128 bytes.
  class KeyValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#product_labels ⇒ ::Array<::Google::Cloud::Vision::V1::Product::KeyValue>

Returns Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.

Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.

Multiple values can be assigned to the same key. One product may have up to 500 product_labels.

Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.

Returns:

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

    Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels.

    Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon.

    Multiple values can be assigned to the same key. One product may have up to 500 product_labels.

    Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'proto_docs/google/cloud/vision/v1/product_search_service.rb', line 62

class Product
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A product label represented as a key-value pair.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the label attached to the product. Cannot be empty and cannot
  #     exceed 128 bytes.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the label attached to the product. Cannot be empty and
  #     cannot exceed 128 bytes.
  class KeyValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end