Google Cloud Vision v1 API - Class AnnotateImageResponse (3.7.0) 

public sealed class AnnotateImageResponse : IMessage<AnnotateImageResponse>, IEquatable<AnnotateImageResponse>, IDeepCloneable<AnnotateImageResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Vision v1 API class AnnotateImageResponse.

Response to an image annotation request.

Inheritance

object > AnnotateImageResponse

Namespace

Google.Cloud.Vision.V1

Assembly

Google.Cloud.Vision.V1.dll

Constructors

AnnotateImageResponse()

public AnnotateImageResponse()

AnnotateImageResponse(AnnotateImageResponse)

public AnnotateImageResponse(AnnotateImageResponse other)
Parameter
Name Description
other AnnotateImageResponse

Properties

Context

public ImageAnnotationContext Context { get; set; }

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

Property Value
Type Description
ImageAnnotationContext

CropHintsAnnotation

public CropHintsAnnotation CropHintsAnnotation { get; set; }

If present, crop hints have completed successfully.

Property Value
Type Description
CropHintsAnnotation

Error

public Status Error { get; set; }

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.

Property Value
Type Description
Status

FaceAnnotations

public RepeatedField<FaceAnnotation> FaceAnnotations { get; }

If present, face detection has completed successfully.

Property Value
Type Description
RepeatedFieldFaceAnnotation

FullTextAnnotation

public TextAnnotation FullTextAnnotation { get; set; }

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

Property Value
Type Description
TextAnnotation

ImagePropertiesAnnotation

public ImageProperties ImagePropertiesAnnotation { get; set; }

If present, image properties were extracted successfully.

Property Value
Type Description
ImageProperties

LabelAnnotations

public RepeatedField<EntityAnnotation> LabelAnnotations { get; }

If present, label detection has completed successfully.

Property Value
Type Description
RepeatedFieldEntityAnnotation

LandmarkAnnotations

public RepeatedField<EntityAnnotation> LandmarkAnnotations { get; }

If present, landmark detection has completed successfully.

Property Value
Type Description
RepeatedFieldEntityAnnotation

LocalizedObjectAnnotations

public RepeatedField<LocalizedObjectAnnotation> LocalizedObjectAnnotations { get; }

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

Property Value
Type Description
RepeatedFieldLocalizedObjectAnnotation

LogoAnnotations

public RepeatedField<EntityAnnotation> LogoAnnotations { get; }

If present, logo detection has completed successfully.

Property Value
Type Description
RepeatedFieldEntityAnnotation

ProductSearchResults

public ProductSearchResults ProductSearchResults { get; set; }

If present, product search has completed successfully.

Property Value
Type Description
ProductSearchResults

SafeSearchAnnotation

public SafeSearchAnnotation SafeSearchAnnotation { get; set; }

If present, safe-search annotation has completed successfully.

Property Value
Type Description
SafeSearchAnnotation

TextAnnotations

public RepeatedField<EntityAnnotation> TextAnnotations { get; }

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

Property Value
Type Description
RepeatedFieldEntityAnnotation

WebDetection

public WebDetection WebDetection { get; set; }

If present, web detection has completed successfully.

Property Value
Type Description
WebDetection

Methods

ThrowOnError()

public AnnotateImageResponse ThrowOnError()

If the Error property is non-null, throws an AnnotateImageException. Otherwise, returns this (so that the method can be called in a fluent manner).

Returns
Type Description
AnnotateImageResponse

this if the message has no error.
Exceptions
Type Description
AnnotateImageException

The Error property is non-null.