Class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1AnnotateImageResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/vision_v1/classes.rb,
lib/google/apis/vision_v1/representations.rb,
lib/google/apis/vision_v1/representations.rb

Overview

Response to an image annotation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVisionV1p3beta1AnnotateImageResponse

Returns a new instance of GoogleCloudVisionV1p3beta1AnnotateImageResponse.



4867
4868
4869
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4867

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ImageAnnotationContext

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:



4788
4789
4790
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4788

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1CropHintsAnnotation

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

Returns:



4793
4794
4795
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4793

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:



4803
4804
4805
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4803

def error
  @error
end

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

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

Returns:



4808
4809
4810
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4808

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1TextAnnotation

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:



4818
4819
4820
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4818

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ImageProperties

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

Returns:



4823
4824
4825
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4823

def image_properties_annotation
  @image_properties_annotation
end

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

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

Returns:



4828
4829
4830
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4828

def label_annotations
  @label_annotations
end

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

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

Returns:



4833
4834
4835
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4833

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



4839
4840
4841
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4839

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



4844
4845
4846
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4844

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResults

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

Returns:



4849
4850
4851
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4849

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1SafeSearchAnnotation

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:



4855
4856
4857
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4855

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



4860
4861
4862
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4860

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1WebDetection

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

Returns:



4865
4866
4867
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4865

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
 
# File 'lib/google/apis/vision_v1/classes.rb', line 4872

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