Class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AnnotateImageResponse

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

Returns a new instance of GoogleCloudVisionV1p2beta1AnnotateImageResponse



2950
2951
2952
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2950

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ImageAnnotationContext

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:



2869
2870
2871
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2869

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1CropHintsAnnotation

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

Returns:



2874
2875
2876
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2874

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:



2884
2885
2886
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2884

def error
  @error
end

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

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

Returns:



2889
2890
2891
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2889

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1TextAnnotation

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:



2900
2901
2902
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2900

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ImageProperties

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

Returns:



2905
2906
2907
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2905

def image_properties_annotation
  @image_properties_annotation
end

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

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

Returns:



2910
2911
2912
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2910

def label_annotations
  @label_annotations
end

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

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

Returns:



2915
2916
2917
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2915

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



2921
2922
2923
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2921

def localized_object_annotations
  @localized_object_annotations
end

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

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

Returns:



2926
2927
2928
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2926

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResults

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

Returns:



2931
2932
2933
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2931

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation

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:



2938
2939
2940
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2938

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



2943
2944
2945
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2943

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1WebDetection

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

Returns:



2948
2949
2950
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2948

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
 
# File 'generated/google/apis/vision_v1p2beta1/classes.rb', line 2955

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