Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1AnnotateImageResponse

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



8879
8880
8881
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8879

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

Instance Attribute Details

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



8798
8799
8800
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8798

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1CropHintsAnnotation

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

Returns:



8803
8804
8805
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8803

def crop_hints_annotation
  @crop_hints_annotation
end

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



8813
8814
8815
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8813

def error
  @error
end

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

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

Returns:



8818
8819
8820
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8818

def face_annotations
  @face_annotations
end

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



8829
8830
8831
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8829

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1ImageProperties

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

Returns:



8834
8835
8836
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8834

def image_properties_annotation
  @image_properties_annotation
end

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

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

Returns:



8839
8840
8841
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8839

def label_annotations
  @label_annotations
end

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

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

Returns:



8844
8845
8846
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8844

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



8850
8851
8852
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8850

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



8855
8856
8857
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8855

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1ProductSearchResults

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

Returns:



8860
8861
8862
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8860

def product_search_results
  @product_search_results
end

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



8867
8868
8869
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8867

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



8872
8873
8874
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8872

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p5beta1WebDetection

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

Returns:



8877
8878
8879
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8877

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 8884

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