Class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1AnnotateImageResponse

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) ⇒ GoogleCloudVisionV1p1beta1AnnotateImageResponse

Returns a new instance of GoogleCloudVisionV1p1beta1AnnotateImageResponse.



1529
1530
1531
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1529

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ImageAnnotationContext

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:



1448
1449
1450
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1448

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1CropHintsAnnotation

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

Returns:



1453
1454
1455
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1453

def crop_hints_annotation
  @crop_hints_annotation
end

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

Returns:



1463
1464
1465
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1463

def error
  @error
end

#face_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1FaceAnnotation>

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

Returns:



1468
1469
1470
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1468

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1TextAnnotation

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:



1479
1480
1481
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1479

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ImageProperties

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

Returns:



1484
1485
1486
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1484

def image_properties_annotation
  @image_properties_annotation
end

#label_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation>

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

Returns:



1489
1490
1491
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1489

def label_annotations
  @label_annotations
end

#landmark_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation>

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

Returns:



1494
1495
1496
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1494

def landmark_annotations
  @landmark_annotations
end

#localized_object_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1LocalizedObjectAnnotation>

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

Returns:



1500
1501
1502
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1500

def localized_object_annotations
  @localized_object_annotations
end

#logo_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation>

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

Returns:



1505
1506
1507
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1505

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResults

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

Returns:



1510
1511
1512
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1510

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation

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:



1517
1518
1519
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1517

def safe_search_annotation
  @safe_search_annotation
end

#text_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation>

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

Returns:



1522
1523
1524
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1522

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1WebDetection

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

Returns:



1527
1528
1529
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1527

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'generated/google/apis/vision_v1/classes.rb', line 1534

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