FaceAnnotation

google.cloud.vision.v1. FaceAnnotation

Represents a FaceAnnotation.

Constructor

new FaceAnnotation(propertiesopt)

Constructs a new FaceAnnotation.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1.IFaceAnnotation <optional>

Properties to set

Implements:
  • IFaceAnnotation

Classes

Landmark

Members

angerLikelihood

FaceAnnotation angerLikelihood.

blurredLikelihood

FaceAnnotation blurredLikelihood.

boundingPoly

FaceAnnotation boundingPoly.

detectionConfidence

FaceAnnotation detectionConfidence.

fdBoundingPoly

FaceAnnotation fdBoundingPoly.

headwearLikelihood

FaceAnnotation headwearLikelihood.

joyLikelihood

FaceAnnotation joyLikelihood.

landmarkingConfidence

FaceAnnotation landmarkingConfidence.

landmarks

FaceAnnotation landmarks.

panAngle

FaceAnnotation panAngle.

rollAngle

FaceAnnotation rollAngle.

sorrowLikelihood

FaceAnnotation sorrowLikelihood.

surpriseLikelihood

FaceAnnotation surpriseLikelihood.

tiltAngle

FaceAnnotation tiltAngle.

underExposedLikelihood

FaceAnnotation underExposedLikelihood.

Methods

(static) create(propertiesopt) → {google.cloud.vision.v1.FaceAnnotation}

Creates a new FaceAnnotation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1.IFaceAnnotation <optional>

Properties to set

Returns:
Type Description
google.cloud.vision.v1.FaceAnnotation

FaceAnnotation instance

(static) decode(reader, lengthopt) → {google.cloud.vision.v1.FaceAnnotation}

Decodes a FaceAnnotation message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.vision.v1.FaceAnnotation

FaceAnnotation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.vision.v1.FaceAnnotation}

Decodes a FaceAnnotation message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.vision.v1.FaceAnnotation

FaceAnnotation

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified FaceAnnotation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.IFaceAnnotation

FaceAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified FaceAnnotation message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.IFaceAnnotation

FaceAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.vision.v1.FaceAnnotation}

Creates a FaceAnnotation message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.vision.v1.FaceAnnotation

FaceAnnotation

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a FaceAnnotation message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.FaceAnnotation

FaceAnnotation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a FaceAnnotation message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this FaceAnnotation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object