Class: Google::Cloud::Vision::V1p3beta1::AnnotateImageResponse

Inherits:

Object

• Object
• Google::Cloud::Vision::V1p3beta1::AnnotateImageResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb

Overview

Response to an image annotation request.

Instance Attribute Summary

• #context ⇒ ::Google::Cloud::Vision::V1p3beta1::ImageAnnotationContext

  If present, contextual information is needed to understand where this image comes from.

• #crop_hints_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::CropHintsAnnotation

  If present, crop hints have completed successfully.

• #error ⇒ ::Google::Rpc::Status

  If set, represents the error message for the operation.

• #face_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::FaceAnnotation>

  If present, face detection has completed successfully.

• #full_text_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::TextAnnotation

  If present, text (OCR) detection or document (OCR) text detection has completed successfully.

• #image_properties_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::ImageProperties

  If present, image properties were extracted successfully.

• #label_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

  If present, label detection has completed successfully.

• #landmark_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

  If present, landmark detection has completed successfully.

• #localized_object_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::LocalizedObjectAnnotation>

  If present, localized object detection has completed successfully.

• #logo_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

  If present, logo detection has completed successfully.

• #product_search_results ⇒ ::Google::Cloud::Vision::V1p3beta1::ProductSearchResults

  If present, product search has completed successfully.

• #safe_search_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::SafeSearchAnnotation

  If present, safe-search annotation has completed successfully.

• #text_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

  If present, text (OCR) detection has completed successfully.

• #web_detection ⇒ ::Google::Cloud::Vision::V1p3beta1::WebDetection

  If present, web detection has completed successfully.

Instance Attribute Details

#context ⇒ ::Google::Cloud::Vision::V1p3beta1::ImageAnnotationContext

Returns If present, contextual information is needed to understand where this image comes from.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::ImageAnnotationContext) —

  If present, contextual information is needed to understand where this image comes from.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#crop_hints_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::CropHintsAnnotation

Returns If present, crop hints have completed successfully.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::CropHintsAnnotation) —

  If present, crop hints have completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#error ⇒ ::Google::Rpc::Status

Returns If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when error is set.

Returns:

• (::Google::Rpc::Status) —

  If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when error is set.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#face_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::FaceAnnotation>

Returns If present, face detection has completed successfully.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::FaceAnnotation>) —

  If present, face detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#full_text_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::TextAnnotation

Returns If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::TextAnnotation) —

  If present, text (OCR) detection or document (OCR) text detection has completed successfully. This annotation provides the structural hierarchy for the OCR detected text.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#image_properties_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::ImageProperties

Returns If present, image properties were extracted successfully.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::ImageProperties) —

  If present, image properties were extracted successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#label_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

Returns If present, label detection has completed successfully.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>) —

  If present, label detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#landmark_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

Returns If present, landmark detection has completed successfully.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>) —

  If present, landmark detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#localized_object_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::LocalizedObjectAnnotation>

Returns If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::LocalizedObjectAnnotation>) —

  If present, localized object detection has completed successfully. This will be sorted descending by confidence score.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#logo_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

Returns If present, logo detection has completed successfully.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>) —

  If present, logo detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#product_search_results ⇒ ::Google::Cloud::Vision::V1p3beta1::ProductSearchResults

Returns If present, product search has completed successfully.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::ProductSearchResults) —

  If present, product search has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#safe_search_annotation ⇒ ::Google::Cloud::Vision::V1p3beta1::SafeSearchAnnotation

Returns If present, safe-search annotation has completed successfully.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::SafeSearchAnnotation) —

  If present, safe-search annotation has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#text_annotations ⇒ ::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>

Returns If present, text (OCR) detection has completed successfully.

Returns:

• (::Array<::Google::Cloud::Vision::V1p3beta1::EntityAnnotation>) —

  If present, text (OCR) detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#web_detection ⇒ ::Google::Cloud::Vision::V1p3beta1::WebDetection

Returns If present, web detection has completed successfully.

Returns:

• (::Google::Cloud::Vision::V1p3beta1::WebDetection) —

  If present, web detection has completed successfully.

# File 'proto_docs/google/cloud/vision/v1p3beta1/image_annotator.rb', line 680

class AnnotateImageResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end