Class: Google::Cloud::Vision::V1p3beta1::ProductSearchResults

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

Overview

Results for a product search request.

Defined Under Namespace

Classes: ProductInfo, Result

Instance Attribute Summary collapse

Instance Attribute Details

#category ⇒ ::Google::Cloud::Vision::V1p3beta1::ProductSearchCategory

Returns Product category. [Deprecated] Use product_category.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 100

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

  # Information about a product.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Product ID.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI of the image which matched the query image.
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  class ProductInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about a product.
  # @!attribute [rw] product
  #   @return [::Google::Cloud::Vision::V1p3beta1::Product]
  #     The Product.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] image
  #   @return [::String]
  #     The resource name of the image from the product that is the closest match
  #     to the query.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#index_time ⇒ ::Google::Protobuf::Timestamp

Returns Timestamp of the index which provided these results. Changes made after this time are not reflected in the current results.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Timestamp of the index which provided these results. Changes made after this time are not reflected in the current results.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 100

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

  # Information about a product.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Product ID.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI of the image which matched the query image.
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  class ProductInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about a product.
  # @!attribute [rw] product
  #   @return [::Google::Cloud::Vision::V1p3beta1::Product]
  #     The Product.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] image
  #   @return [::String]
  #     The resource name of the image from the product that is the closest match
  #     to the query.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#product_category ⇒ ::String

Returns Product category. Supported values are bag and shoe. [Deprecated] product_category is provided in each Product.

Returns:

  • (::String) —

    Product category. Supported values are bag and shoe. [Deprecated] product_category is provided in each Product.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 100

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

  # Information about a product.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Product ID.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI of the image which matched the query image.
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  class ProductInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about a product.
  # @!attribute [rw] product
  #   @return [::Google::Cloud::Vision::V1p3beta1::Product]
  #     The Product.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] image
  #   @return [::String]
  #     The resource name of the image from the product that is the closest match
  #     to the query.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#products ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::ProductSearchResults::ProductInfo>

Returns List of detected products.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 100

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

  # Information about a product.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Product ID.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI of the image which matched the query image.
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  class ProductInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about a product.
  # @!attribute [rw] product
  #   @return [::Google::Cloud::Vision::V1p3beta1::Product]
  #     The Product.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] image
  #   @return [::String]
  #     The resource name of the image from the product that is the closest match
  #     to the query.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#results ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::ProductSearchResults::Result>

Returns List of results, one for each product match.

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'proto_docs/google/cloud/vision/v1p3beta1/product_search.rb', line 100

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

  # Information about a product.
  # @!attribute [rw] product_id
  #   @return [::String]
  #     Product ID.
  # @!attribute [rw] image_uri
  #   @return [::String]
  #     The URI of the image which matched the query image.
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  class ProductInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information about a product.
  # @!attribute [rw] product
  #   @return [::Google::Cloud::Vision::V1p3beta1::Product]
  #     The Product.
  # @!attribute [rw] score
  #   @return [::Float]
  #     A confidence level on the match, ranging from 0 (no confidence) to
  #     1 (full confidence).
  #
  #     This field is returned only if `view` is set to `FULL` in
  #     the request.
  # @!attribute [rw] image
  #   @return [::String]
  #     The resource name of the image from the product that is the closest match
  #     to the query.
  class Result
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end