Class: Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1AnnotateImageResponse

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

Returns a new instance of GoogleCloudVisionV1p4beta1AnnotateImageResponse



6819
6820
6821
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6819

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1ImageAnnotationContext

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:



6728
6729
6730
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6728

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1CropHintsAnnotation

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

Returns:



6733
6734
6735
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6733

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:



6743
6744
6745
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6743

def error
  @error
end

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

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

Returns:



6748
6749
6750
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6748

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1TextAnnotation

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:



6759
6760
6761
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6759

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1ImageProperties

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

Returns:



6764
6765
6766
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6764

def image_properties_annotation
  @image_properties_annotation
end

#image_quality_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1ImageQuality

Stores image quality scores, could be aesthetic quality or technical quality. Corresponds to the JSON property imageQualityAnnotation

Returns:



6769
6770
6771
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6769

def image_quality_annotation
  @image_quality_annotation
end

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

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

Returns:



6774
6775
6776
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6774

def label_annotations
  @label_annotations
end

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

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

Returns:



6779
6780
6781
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6779

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



6785
6786
6787
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6785

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



6790
6791
6792
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6790

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1ProductSearchResults

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

Returns:



6795
6796
6797
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6795

def product_search_results
  @product_search_results
end

#quality_optimization_result ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1QualityOptimizationResult

Stores enhanced image bytes. Corresponds to the JSON property qualityOptimizationResult

Returns:



6800
6801
6802
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6800

def quality_optimization_result
  @quality_optimization_result
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1SafeSearchAnnotation

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:



6807
6808
6809
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6807

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



6812
6813
6814
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6812

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1WebDetection

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

Returns:



6817
6818
6819
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6817

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
 
# File 'generated/google/apis/vision_v1/classes.rb', line 6824

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)
  @image_quality_annotation = args[:image_quality_annotation] if args.key?(:image_quality_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)
  @quality_optimization_result = args[:quality_optimization_result] if args.key?(:quality_optimization_result)
  @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