Class: Google::Apis::VisionV1::AnnotateImageResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1/classes.rb,
generated/google/apis/vision_v1/representations.rb,
generated/google/apis/vision_v1/representations.rb

Overview

Response to an image annotation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AnnotateImageResponse

Returns a new instance of AnnotateImageResponse.


251
252
253
# File 'generated/google/apis/vision_v1/classes.rb', line 251

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#contextGoogle::Apis::VisionV1::ImageAnnotationContext

If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image. Corresponds to the JSON property context


172
173
174
# File 'generated/google/apis/vision_v1/classes.rb', line 172

def context
  @context
end

#crop_hints_annotationGoogle::Apis::VisionV1::CropHintsAnnotation

Set of crop hints that are used to generate new crops when serving images. Corresponds to the JSON property cropHintsAnnotation


177
178
179
# File 'generated/google/apis/vision_v1/classes.rb', line 177

def crop_hints_annotation
  @crop_hints_annotation
end

#errorGoogle::Apis::VisionV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error


187
188
189
# File 'generated/google/apis/vision_v1/classes.rb', line 187

def error
  @error
end

#face_annotationsArray<Google::Apis::VisionV1::FaceAnnotation>

If present, face detection has completed successfully. Corresponds to the JSON property faceAnnotations


192
193
194
# File 'generated/google/apis/vision_v1/classes.rb', line 192

def face_annotations
  @face_annotations
end

#full_text_annotationGoogle::Apis::VisionV1::TextAnnotation

TextAnnotation contains a structured representation of OCR extracted text. The hierarchy of an OCR extracted text structure is like this: TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol Each structural component, starting from Page, may further have their own properties. Properties describe detected languages, breaks etc.. Please refer to the TextAnnotation. TextProperty message definition below for more detail. Corresponds to the JSON property fullTextAnnotation


202
203
204
# File 'generated/google/apis/vision_v1/classes.rb', line 202

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotationGoogle::Apis::VisionV1::ImageProperties

Stores image properties, such as dominant colors. Corresponds to the JSON property imagePropertiesAnnotation


207
208
209
# File 'generated/google/apis/vision_v1/classes.rb', line 207

def image_properties_annotation
  @image_properties_annotation
end

#label_annotationsArray<Google::Apis::VisionV1::EntityAnnotation>

If present, label detection has completed successfully. Corresponds to the JSON property labelAnnotations


212
213
214
# File 'generated/google/apis/vision_v1/classes.rb', line 212

def label_annotations
  @label_annotations
end

#landmark_annotationsArray<Google::Apis::VisionV1::EntityAnnotation>

If present, landmark detection has completed successfully. Corresponds to the JSON property landmarkAnnotations


217
218
219
# File 'generated/google/apis/vision_v1/classes.rb', line 217

def landmark_annotations
  @landmark_annotations
end

#localized_object_annotationsArray<Google::Apis::VisionV1::LocalizedObjectAnnotation>

If present, localized object detection has completed successfully. This will be sorted descending by confidence score. Corresponds to the JSON property localizedObjectAnnotations


223
224
225
# File 'generated/google/apis/vision_v1/classes.rb', line 223

def localized_object_annotations
  @localized_object_annotations
end

#logo_annotationsArray<Google::Apis::VisionV1::EntityAnnotation>

If present, logo detection has completed successfully. Corresponds to the JSON property logoAnnotations


228
229
230
# File 'generated/google/apis/vision_v1/classes.rb', line 228

def logo_annotations
  @logo_annotations
end

#product_search_resultsGoogle::Apis::VisionV1::ProductSearchResults

Results for a product search request. Corresponds to the JSON property productSearchResults


233
234
235
# File 'generated/google/apis/vision_v1/classes.rb', line 233

def product_search_results
  @product_search_results
end

#safe_search_annotationGoogle::Apis::VisionV1::SafeSearchAnnotation

Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). Corresponds to the JSON property safeSearchAnnotation


239
240
241
# File 'generated/google/apis/vision_v1/classes.rb', line 239

def safe_search_annotation
  @safe_search_annotation
end

#text_annotationsArray<Google::Apis::VisionV1::EntityAnnotation>

If present, text (OCR) detection has completed successfully. Corresponds to the JSON property textAnnotations


244
245
246
# File 'generated/google/apis/vision_v1/classes.rb', line 244

def text_annotations
  @text_annotations
end

#web_detectionGoogle::Apis::VisionV1::WebDetection

Relevant information for the image from the Internet. Corresponds to the JSON property webDetection


249
250
251
# File 'generated/google/apis/vision_v1/classes.rb', line 249

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'generated/google/apis/vision_v1/classes.rb', line 256

def update!(**args)
  @context = args[:context] if args.key?(:context)
  @crop_hints_annotation = args[:crop_hints_annotation] if args.key?(:crop_hints_annotation)
  @error = args[:error] if args.key?(:error)
  @face_annotations = args[:face_annotations] if args.key?(:face_annotations)
  @full_text_annotation = args[:full_text_annotation] if args.key?(:full_text_annotation)
  @image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation)
  @label_annotations = args[:label_annotations] if args.key?(:label_annotations)
  @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations)
  @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations)
  @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations)
  @product_search_results = args[:product_search_results] if args.key?(:product_search_results)
  @safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation)
  @text_annotations = args[:text_annotations] if args.key?(:text_annotations)
  @web_detection = args[:web_detection] if args.key?(:web_detection)
end