EntityAnnotation

google.cloud.vision.v1p3beta1. EntityAnnotation

Represents an EntityAnnotation.

Constructor

new EntityAnnotation(propertiesopt)

Constructs a new EntityAnnotation.

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

Properties to set

Implements:
  • IEntityAnnotation

Members

boundingPoly

EntityAnnotation boundingPoly.

confidence

EntityAnnotation confidence.

description

EntityAnnotation description.

locale

EntityAnnotation locale.

locations

EntityAnnotation locations.

mid

EntityAnnotation mid.

properties

EntityAnnotation properties.

score

EntityAnnotation score.

topicality

EntityAnnotation topicality.

Methods

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

Creates a new EntityAnnotation instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.vision.v1p3beta1.EntityAnnotation

EntityAnnotation instance

(static) decode(reader, lengthopt) → {google.cloud.vision.v1p3beta1.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

Returns:
Type Description
google.cloud.vision.v1p3beta1.EntityAnnotation

EntityAnnotation

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.v1p3beta1.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

Returns:
Type Description
google.cloud.vision.v1p3beta1.EntityAnnotation

EntityAnnotation

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.v1p3beta1.IEntityAnnotation

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

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

EntityAnnotation 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.v1p3beta1.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

Returns:
Type Description
google.cloud.vision.v1p3beta1.EntityAnnotation

EntityAnnotation

(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.v1p3beta1.EntityAnnotation

EntityAnnotation

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an EntityAnnotation 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 EntityAnnotation to JSON.

Returns:
Type Description
Object.<string, *>

JSON object