Class: Google::Apis::VisionV1p1beta1::AnnotateImageResponse

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

Overview

Response to an image annotation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AnnotateImageResponse

Returns a new instance of AnnotateImageResponse.



156
157
158
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 156

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

Instance Attribute Details

#context ⇒ Google::Apis::VisionV1p1beta1::ImageAnnotationContext

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:



77
78
79
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 77

def context
  @context
end

#crop_hints_annotation ⇒ Google::Apis::VisionV1p1beta1::CropHintsAnnotation

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

Returns:



82
83
84
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 82

def crop_hints_annotation
  @crop_hints_annotation
end

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



92
93
94
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 92

def error
  @error
end

#face_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::FaceAnnotation>

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

Returns:



97
98
99
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 97

def face_annotations
  @face_annotations
end

#full_text_annotation ⇒ Google::Apis::VisionV1p1beta1::TextAnnotation

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:



107
108
109
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 107

def full_text_annotation
  @full_text_annotation
end

#image_properties_annotation ⇒ Google::Apis::VisionV1p1beta1::ImageProperties

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

Returns:



112
113
114
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 112

def image_properties_annotation
  @image_properties_annotation
end

#label_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::EntityAnnotation>

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

Returns:



117
118
119
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 117

def label_annotations
  @label_annotations
end

#landmark_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::EntityAnnotation>

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

Returns:



122
123
124
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 122

def landmark_annotations
  @landmark_annotations
end

#localized_object_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::LocalizedObjectAnnotation>

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

Returns:



128
129
130
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 128

def localized_object_annotations
  @localized_object_annotations
end

#logo_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::EntityAnnotation>

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

Returns:



133
134
135
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 133

def logo_annotations
  @logo_annotations
end

#product_search_results ⇒ Google::Apis::VisionV1p1beta1::ProductSearchResults

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

Returns:



138
139
140
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 138

def product_search_results
  @product_search_results
end

#safe_search_annotation ⇒ Google::Apis::VisionV1p1beta1::SafeSearchAnnotation

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:



144
145
146
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 144

def safe_search_annotation
  @safe_search_annotation
end

#text_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::EntityAnnotation>

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

Returns:



149
150
151
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 149

def text_annotations
  @text_annotations
end

#web_detection ⇒ Google::Apis::VisionV1p1beta1::WebDetection

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

Returns:



154
155
156
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 154

def web_detection
  @web_detection
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 161

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