Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1AnnotateImageResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/vision_v1p1beta1/classes.rb,
generated/google/apis/vision_v1p1beta1/representations.rb,
generated/google/apis/vision_v1p1beta1/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) ⇒ GoogleCloudVisionV1p5beta1AnnotateImageResponse

Returns a new instance of GoogleCloudVisionV1p5beta1AnnotateImageResponse



9303
9304
9305
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9303

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1ImageAnnotationContext

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

Returns:



9222
9223
9224
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9222

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1CropHintsAnnotation

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

Returns:



9227
9228
9229
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9227

def crop_hints_annotation
  @crop_hints_annotation
end

#error ⇒ Google::Apis::VisionV1p1beta1::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

Returns:



9237
9238
9239
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9237

def error
  @error
end

#face_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1FaceAnnotation>

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

Returns:



9242
9243
9244
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9242

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1TextAnnotation

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

Returns:



9253
9254
9255
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9253

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1ImageProperties

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

Returns:



9258
9259
9260
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9258

def image_properties_annotation
  @image_properties_annotation
end

#label_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1EntityAnnotation>

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

Returns:



9263
9264
9265
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9263

def label_annotations
  @label_annotations
end

#landmark_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1EntityAnnotation>

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

Returns:



9268
9269
9270
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9268

def landmark_annotations
  @landmark_annotations
end

#localized_object_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1LocalizedObjectAnnotation>

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

Returns:



9274
9275
9276
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9274

def localized_object_annotations
  @localized_object_annotations
end

#logo_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1EntityAnnotation>

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

Returns:



9279
9280
9281
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9279

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1ProductSearchResults

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

Returns:



9284
9285
9286
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9284

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1SafeSearchAnnotation

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

Returns:



9291
9292
9293
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9291

def safe_search_annotation
  @safe_search_annotation
end

#text_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1EntityAnnotation>

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

Returns:



9296
9297
9298
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9296

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p5beta1WebDetection

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

Returns:



9301
9302
9303
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9301

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 9308

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