Class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1AnnotateImageResponse
- Inherits:
-
Object
- Object
- Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1AnnotateImageResponse
- 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
-
#context ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ImageAnnotationContext
If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.
-
#crop_hints_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1CropHintsAnnotation
Set of crop hints that are used to generate new crops when serving images.
-
#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. -
#face_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1FaceAnnotation>
If present, face detection has completed successfully.
-
#full_text_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1TextAnnotation
TextAnnotation contains a structured representation of OCR extracted text.
-
#image_properties_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ImageProperties
Stores image properties, such as dominant colors.
-
#label_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, label detection has completed successfully.
-
#landmark_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, landmark detection has completed successfully.
-
#logo_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, logo detection has completed successfully.
-
#safe_search_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation
Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).
-
#text_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, text (OCR) detection has completed successfully.
-
#web_detection ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1WebDetection
Relevant information for the image from the Internet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudVisionV1p2beta1AnnotateImageResponse
constructor
A new instance of GoogleCloudVisionV1p2beta1AnnotateImageResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudVisionV1p2beta1AnnotateImageResponse
Returns a new instance of GoogleCloudVisionV1p2beta1AnnotateImageResponse
2802 2803 2804 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2802 def initialize(**args) update!(**args) end |
Instance Attribute Details
#context ⇒ Google::Apis::VisionV1p1beta1::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
2699 2700 2701 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2699 def context @context end |
#crop_hints_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1CropHintsAnnotation
Set of crop hints that are used to generate new crops when serving images.
Corresponds to the JSON property cropHintsAnnotation
2704 2705 2706 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2704 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. 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 packagegoogle.rpc
that can be used for common error conditions. # Language mapping TheStatus
message is the logical representation of the error model, but it is not necessarily the actual wire format. When theStatus
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 theStatus
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. - 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 propertyerror
2747 2748 2749 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2747 def error @error end |
#face_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1FaceAnnotation>
If present, face detection has completed successfully.
Corresponds to the JSON property faceAnnotations
2752 2753 2754 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2752 def face_annotations @face_annotations end |
#full_text_annotation ⇒ Google::Apis::VisionV1p1beta1::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
2763 2764 2765 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2763 def full_text_annotation @full_text_annotation end |
#image_properties_annotation ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ImageProperties
Stores image properties, such as dominant colors.
Corresponds to the JSON property imagePropertiesAnnotation
2768 2769 2770 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2768 def image_properties_annotation @image_properties_annotation end |
#label_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, label detection has completed successfully.
Corresponds to the JSON property labelAnnotations
2773 2774 2775 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2773 def label_annotations @label_annotations end |
#landmark_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, landmark detection has completed successfully.
Corresponds to the JSON property landmarkAnnotations
2778 2779 2780 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2778 def landmark_annotations @landmark_annotations end |
#logo_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, logo detection has completed successfully.
Corresponds to the JSON property logoAnnotations
2783 2784 2785 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2783 def logo_annotations @logo_annotations end |
#safe_search_annotation ⇒ Google::Apis::VisionV1p1beta1::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
2790 2791 2792 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2790 def safe_search_annotation @safe_search_annotation end |
#text_annotations ⇒ Array<Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation>
If present, text (OCR) detection has completed successfully.
Corresponds to the JSON property textAnnotations
2795 2796 2797 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2795 def text_annotations @text_annotations end |
#web_detection ⇒ Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1WebDetection
Relevant information for the image from the Internet.
Corresponds to the JSON property webDetection
2800 2801 2802 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2800 def web_detection @web_detection end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 |
# File 'generated/google/apis/vision_v1p1beta1/classes.rb', line 2807 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) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) @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 |