Class: Google::Apis::VisionV1::AnnotateImageResponse

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

Returns a new instance of AnnotateImageResponse.



163
164
165
 
# File 'generated/google/apis/vision_v1/classes.rb', line 163

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

Instance Attribute Details

#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. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property error

Returns:



161
162
163
 
# File 'generated/google/apis/vision_v1/classes.rb', line 161

def error
  @error
end

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

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

Returns:



118
119
120
 
# File 'generated/google/apis/vision_v1/classes.rb', line 118

def face_annotations
  @face_annotations
end

#image_properties_annotation ⇒ Google::Apis::VisionV1::ImageProperties

Stores image properties (e.g. dominant colors). Corresponds to the JSON property imagePropertiesAnnotation

Returns:



103
104
105
 
# File 'generated/google/apis/vision_v1/classes.rb', line 103

def image_properties_annotation
  @image_properties_annotation
end

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

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

Returns:



86
87
88
 
# File 'generated/google/apis/vision_v1/classes.rb', line 86

def label_annotations
  @label_annotations
end

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

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

Returns:



91
92
93
 
# File 'generated/google/apis/vision_v1/classes.rb', line 91

def landmark_annotations
  @landmark_annotations
end

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

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

Returns:



113
114
115
 
# File 'generated/google/apis/vision_v1/classes.rb', line 113

def logo_annotations
  @logo_annotations
end

#safe_search_annotation ⇒ Google::Apis::VisionV1::SafeSearchAnnotation

Set of features pertaining to the image, computed by various computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence). Corresponds to the JSON property safeSearchAnnotation

Returns:



98
99
100
 
# File 'generated/google/apis/vision_v1/classes.rb', line 98

def safe_search_annotation
  @safe_search_annotation
end

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

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

Returns:



108
109
110
 
# File 'generated/google/apis/vision_v1/classes.rb', line 108

def text_annotations
  @text_annotations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



168
169
170
171
172
173
174
175
176
177
 
# File 'generated/google/apis/vision_v1/classes.rb', line 168

def update!(**args)
  @label_annotations = args[:label_annotations] if args.key?(:label_annotations)
  @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations)
  @safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation)
  @image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation)
  @text_annotations = args[:text_annotations] if args.key?(:text_annotations)
  @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations)
  @face_annotations = args[:face_annotations] if args.key?(:face_annotations)
  @error = args[:error] if args.key?(:error)
end