Entity

google.cloud.language.v1beta2. Entity

Represents an Entity.

Constructor

new Entity(propertiesopt)

Constructs a new Entity.

Parameters:
Name Type Attributes Description
properties google.cloud.language.v1beta2.IEntity <optional>

Properties to set

Implements:
  • IEntity

Members

Type

Type enum.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN value

PERSON number

PERSON value

LOCATION number

LOCATION value

ORGANIZATION number

ORGANIZATION value

EVENT number

EVENT value

WORK_OF_ART number

WORK_OF_ART value

CONSUMER_GOOD number

CONSUMER_GOOD value

OTHER number

OTHER value

PHONE_NUMBER number

PHONE_NUMBER value

ADDRESS number

ADDRESS value

DATE number

DATE value

NUMBER number

NUMBER value

PRICE number

PRICE value

mentions

Entity mentions.

metadata

Entity metadata.

name

Entity name.

salience

Entity salience.

sentiment

Entity sentiment.

type

Entity type.

Methods

(static) create(propertiesopt) → {google.cloud.language.v1beta2.Entity}

Creates a new Entity instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.language.v1beta2.IEntity <optional>

Properties to set

Returns:
Type Description
google.cloud.language.v1beta2.Entity

Entity instance

(static) decode(reader, lengthopt) → {google.cloud.language.v1beta2.Entity}

Decodes an Entity 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.language.v1beta2.Entity

Entity

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.language.v1beta2.Entity}

Decodes an Entity 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.language.v1beta2.Entity

Entity

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

Parameters:
Name Type Attributes Description
message google.cloud.language.v1beta2.IEntity

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

Parameters:
Name Type Attributes Description
message google.cloud.language.v1beta2.IEntity

Entity 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.language.v1beta2.Entity}

Creates an Entity 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.language.v1beta2.Entity

Entity

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

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

Parameters:
Name Type Attributes Description
message google.cloud.language.v1beta2.Entity

Entity

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

Returns:
Type Description
Object.<string, *>

JSON object