EntityAnnotation

google.cloud.vision.v1p4beta1. EntityAnnotation

Represents an EntityAnnotation.

Constructor

new EntityAnnotation(propertiesopt)

Constructs a new EntityAnnotation.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1p4beta1.IEntityAnnotation <optional>

Properties to set

Implements:
  • IEntityAnnotation

Members

boundingPoly :google.cloud.vision.v1p4beta1.IBoundingPoly|null|undefined

EntityAnnotation boundingPoly.

confidence :number

EntityAnnotation confidence.

description :string

EntityAnnotation description.

locale :string

EntityAnnotation locale.

locations :Array.<google.cloud.vision.v1p4beta1.ILocationInfo>

EntityAnnotation locations.

mid :string

EntityAnnotation mid.

properties :Array.<google.cloud.vision.v1p4beta1.IProperty>

EntityAnnotation properties.

score :number

EntityAnnotation score.

topicality :number

EntityAnnotation topicality.

Methods

(static) create(propertiesopt) → {google.cloud.vision.v1p4beta1.EntityAnnotation}

Creates a new EntityAnnotation instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1p4beta1.IEntityAnnotation <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.vision.v1p4beta1.EntityAnnotation}

Decodes an EntityAnnotation 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

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.v1p4beta1.EntityAnnotation}

Decodes an EntityAnnotation message from the specified reader or buffer, length delimited.

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

Reader or buffer to decode from

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 EntityAnnotation message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p4beta1.IEntityAnnotation

EntityAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p4beta1.IEntityAnnotation

EntityAnnotation message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.vision.v1p4beta1.EntityAnnotation}

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

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

Plain object

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

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

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1p4beta1.EntityAnnotation

EntityAnnotation

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies an EntityAnnotation message.

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

Plain object to verify

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

Converts this EntityAnnotation to JSON.