Class: Google::Apis::VisionV1::GoogleCloudVisionV1p5beta1AnnotateImageResponse

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

Returns a new instance of GoogleCloudVisionV1p5beta1AnnotateImageResponse



8688
8689
8690
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8688

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1::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:



8607
8608
8609
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8607

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p5beta1CropHintsAnnotation

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

Returns:



8612
8613
8614
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8612

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:



8622
8623
8624
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8622

def error
  @error
end

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

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

Returns:



8627
8628
8629
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8627

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1::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:



8638
8639
8640
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8638

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p5beta1ImageProperties

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

Returns:



8643
8644
8645
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8643

def image_properties_annotation
  @image_properties_annotation
end

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

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

Returns:



8648
8649
8650
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8648

def label_annotations
  @label_annotations
end

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

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

Returns:



8653
8654
8655
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8653

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



8659
8660
8661
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8659

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



8664
8665
8666
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8664

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p5beta1ProductSearchResults

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

Returns:



8669
8670
8671
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8669

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::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:



8676
8677
8678
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8676

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



8681
8682
8683
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8681

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p5beta1WebDetection

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

Returns:



8686
8687
8688
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8686

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
 
# File 'generated/google/apis/vision_v1/classes.rb', line 8693

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