Class: Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1AnnotateImageResponse

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

Returns a new instance of GoogleCloudVisionV1p6beta1AnnotateImageResponse



10792
10793
10794
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10792

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1ImageAnnotationContext

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:



10677
10678
10679
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10677

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1CropHintsAnnotation

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

Returns:



10682
10683
10684
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10682

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:



10692
10693
10694
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10692

def error
  @error
end

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

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

Returns:



10697
10698
10699
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10697

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1TextAnnotation

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:



10708
10709
10710
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10708

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1ImageProperties

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

Returns:



10713
10714
10715
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10713

def image_properties_annotation
  @image_properties_annotation
end

#image_quality_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1ImageQuality

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

Returns:



10718
10719
10720
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10718

def image_quality_annotation
  @image_quality_annotation
end

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

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

Returns:



10723
10724
10725
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10723

def label_annotations
  @label_annotations
end

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

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

Returns:



10728
10729
10730
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10728

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



10734
10735
10736
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10734

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



10739
10740
10741
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10739

def logo_annotations
  @logo_annotations
end

#object_attribute_annotations ⇒ Array<Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1EntityAnnotation>

If present, objects attributes calculation has completed successfully. The attributes value will be filled in the EntityAnnotation.properties. Example: object_attribute_annotations properties name: "color" value: "blue" confidence: 0.1 properties name: "color" value: "white" confidence: 0.2 properties name: "material" value: "silk" confidence: 0.3 Corresponds to the JSON property objectAttributeAnnotations

Returns:



10763
10764
10765
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10763

def object_attribute_annotations
  @object_attribute_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1ProductSearchResults

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

Returns:



10768
10769
10770
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10768

def product_search_results
  @product_search_results
end

#quality_optimization_result ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1QualityOptimizationResult

Stores enhanced image bytes. Corresponds to the JSON property qualityOptimizationResult

Returns:



10773
10774
10775
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10773

def quality_optimization_result
  @quality_optimization_result
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1SafeSearchAnnotation

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:



10780
10781
10782
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10780

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



10785
10786
10787
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10785

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p6beta1WebDetection

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

Returns:



10790
10791
10792
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10790

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
 
# File 'generated/google/apis/vision_v1/classes.rb', line 10797

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