Class protos.google.cloud.documentai.v1beta3.Document.Entity (6.3.0)

Represents an Entity.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.Document.IEntity);

Constructs a new Entity.

Parameter

Name	Description
`properties`	`IEntity` Properties to set

Properties

confidence

public confidence: number;

Entity confidence.

id

public id: string;

Entity id.

mentionId

public mentionId: string;

Entity mentionId.

mentionText

public mentionText: string;

Entity mentionText.

normalizedValue

public normalizedValue?: (google.cloud.documentai.v1beta3.Document.Entity.INormalizedValue|null);

Entity normalizedValue.

pageAnchor

public pageAnchor?: (google.cloud.documentai.v1beta3.Document.IPageAnchor|null);

Entity pageAnchor.

properties

public properties: google.cloud.documentai.v1beta3.Document.IEntity[];

Entity properties.

provenance

public provenance?: (google.cloud.documentai.v1beta3.Document.IProvenance|null);

Entity provenance.

redacted

public redacted: boolean;

Entity redacted.

textAnchor

public textAnchor?: (google.cloud.documentai.v1beta3.Document.ITextAnchor|null);

Entity textAnchor.

type

public type: string;

Entity type.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.Document.IEntity): google.cloud.documentai.v1beta3.Document.Entity;

Creates a new Entity instance using the specified properties.

Parameter

Name	Description
`properties`	`IEntity` Properties to set

Returns

Type	Description
`google.cloud.documentai.v1beta3.Document.Entity`	Entity instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.Document.Entity;

Decodes an Entity message from the specified reader or buffer.

Parameters

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns

Type	Description
`google.cloud.documentai.v1beta3.Document.Entity`	Entity

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.Document.Entity;

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

Parameter

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
`google.cloud.documentai.v1beta3.Document.Entity`	Entity

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.Document.IEntity, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Entity message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IEntity` Entity message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.documentai.v1beta3.Document.IEntity, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IEntity` Entity message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.documentai.v1beta3.Document.Entity;

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

Parameter

Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns

Type	Description
`google.cloud.documentai.v1beta3.Document.Entity`	Entity

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Entity

Parameter

Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
`string`	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Entity to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta3.Document.Entity, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
`message`	`google.cloud.documentai.v1beta3.Document.Entity` Entity
`options`	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Entity message.

Parameter

Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not