class AnnotateImageResponse extends Message

Response to an image annotation request.

Protobuf type Google\Cloud\Vision\V1\AnnotateImageResponse

Methods

__construct()

No description

RepeatedField
getFaceAnnotations()

If present, face detection has completed successfully.

setFaceAnnotations(array|RepeatedField $var)

If present, face detection has completed successfully.

RepeatedField
getLandmarkAnnotations()

If present, landmark detection has completed successfully.

setLandmarkAnnotations(array|RepeatedField $var)

If present, landmark detection has completed successfully.

RepeatedField
getLogoAnnotations()

If present, logo detection has completed successfully.

setLogoAnnotations(array|RepeatedField $var)

If present, logo detection has completed successfully.

RepeatedField
getLabelAnnotations()

If present, label detection has completed successfully.

setLabelAnnotations(array|RepeatedField $var)

If present, label detection has completed successfully.

RepeatedField
getTextAnnotations()

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

setTextAnnotations(array|RepeatedField $var)

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

getFullTextAnnotation()

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

setFullTextAnnotation(TextAnnotation $var)

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

getSafeSearchAnnotation()

If present, safe-search annotation has completed successfully.

setSafeSearchAnnotation(SafeSearchAnnotation $var)

If present, safe-search annotation has completed successfully.

getImagePropertiesAnnotation()

If present, image properties were extracted successfully.

setImagePropertiesAnnotation(ImageProperties $var)

If present, image properties were extracted successfully.

getCropHintsAnnotation()

If present, crop hints have completed successfully.

setCropHintsAnnotation(CropHintsAnnotation $var)

If present, crop hints have completed successfully.

getWebDetection()

If present, web detection has completed successfully.

setWebDetection(WebDetection $var)

If present, web detection has completed successfully.

getError()

If set, represents the error message for the operation.

setError(Status $var)

If set, represents the error message for the operation.

Details

at line 91
__construct()

at line 102
RepeatedField getFaceAnnotations()

If present, face detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;

Return Value

RepeatedField

at line 113
setFaceAnnotations(array|RepeatedField $var)

If present, face detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.FaceAnnotation face_annotations = 1;

Parameters

array|RepeatedField $var

at line 125
RepeatedField getLandmarkAnnotations()

If present, landmark detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;

Return Value

RepeatedField

at line 136
setLandmarkAnnotations(array|RepeatedField $var)

If present, landmark detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation landmark_annotations = 2;

Parameters

array|RepeatedField $var

at line 148
RepeatedField getLogoAnnotations()

If present, logo detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;

Return Value

RepeatedField

at line 159
setLogoAnnotations(array|RepeatedField $var)

If present, logo detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation logo_annotations = 3;

Parameters

array|RepeatedField $var

at line 171
RepeatedField getLabelAnnotations()

If present, label detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;

Return Value

RepeatedField

at line 182
setLabelAnnotations(array|RepeatedField $var)

If present, label detection has completed successfully.

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation label_annotations = 4;

Parameters

array|RepeatedField $var

at line 195
RepeatedField getTextAnnotations()

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

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;

Return Value

RepeatedField

at line 207
setTextAnnotations(array|RepeatedField $var)

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

Generated from protobuf field repeated .google.cloud.vision.v1.EntityAnnotation text_annotations = 5;

Parameters

array|RepeatedField $var

at line 222
TextAnnotation getFullTextAnnotation()

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

This annotation provides the structural hierarchy for the OCR detected text.

Generated from protobuf field .google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;

Return Value

TextAnnotation

at line 236
setFullTextAnnotation(TextAnnotation $var)

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

This annotation provides the structural hierarchy for the OCR detected text.

Generated from protobuf field .google.cloud.vision.v1.TextAnnotation full_text_annotation = 12;

Parameters

TextAnnotation $var

at line 248
SafeSearchAnnotation getSafeSearchAnnotation()

If present, safe-search annotation has completed successfully.

Generated from protobuf field .google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;

Return Value

SafeSearchAnnotation

at line 259
setSafeSearchAnnotation(SafeSearchAnnotation $var)

If present, safe-search annotation has completed successfully.

Generated from protobuf field .google.cloud.vision.v1.SafeSearchAnnotation safe_search_annotation = 6;

Parameters

SafeSearchAnnotation $var

at line 271
ImageProperties getImagePropertiesAnnotation()

If present, image properties were extracted successfully.

Generated from protobuf field .google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;

Return Value

ImageProperties

at line 282
setImagePropertiesAnnotation(ImageProperties $var)

If present, image properties were extracted successfully.

Generated from protobuf field .google.cloud.vision.v1.ImageProperties image_properties_annotation = 8;

Parameters

ImageProperties $var

at line 294
CropHintsAnnotation getCropHintsAnnotation()

If present, crop hints have completed successfully.

Generated from protobuf field .google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;

Return Value

CropHintsAnnotation

at line 305
setCropHintsAnnotation(CropHintsAnnotation $var)

If present, crop hints have completed successfully.

Generated from protobuf field .google.cloud.vision.v1.CropHintsAnnotation crop_hints_annotation = 11;

Parameters

CropHintsAnnotation $var

at line 317
WebDetection getWebDetection()

If present, web detection has completed successfully.

Generated from protobuf field .google.cloud.vision.v1.WebDetection web_detection = 13;

Return Value

WebDetection

at line 328
setWebDetection(WebDetection $var)

If present, web detection has completed successfully.

Generated from protobuf field .google.cloud.vision.v1.WebDetection web_detection = 13;

Parameters

WebDetection $var

at line 342
Status getError()

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.

Generated from protobuf field .google.rpc.Status error = 9;

Return Value

Status

at line 355
setError(Status $var)

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.

Generated from protobuf field .google.rpc.Status error = 9;

Parameters

Status $var